Connect an External Open Channel to the Account imopenlines.network.join
Scope:
imopenlinesWho can execute the method: any user
The method imopenlines.network.join connects an external open channel from another Bitrix24 to the current Bitrix24.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
CODE* |
The code of the open channel as a string of 32 characters. You can find the channel code in the detail form of the connected open channel in Bitrix24 Network on the Contact Center page. User Documentation |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"CODE": "ab515f5d85a8b844d484f6ea75a2e494"
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.network.join
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"CODE": "ab515f5d85a8b844d484f6ea75a2e494",
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/imopenlines.network.join
try
{
const response = await $b24.callMethod(
'imopenlines.network.join',
{
CODE: 'ab515f5d85a8b844d484f6ea75a2e494'
}
);
const result = response.getData().result;
console.log(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'imopenlines.network.join',
[
'CODE' => 'ab515f5d85a8b844d484f6ea75a2e494',
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'imopenlines.network.join',
{
CODE: 'ab515f5d85a8b844d484f6ea75a2e494'
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imopenlines.network.join',
[
'CODE' => 'ab515f5d85a8b844d484f6ea75a2e494',
]
);
print_r($result);
Response Handling
HTTP Status: 200
{
"result": 603,
"time": {
"start": 1773735146,
"finish": 1773735146.911103,
"duration": 0.9111030101776123,
"processing": 0,
"date_start": "2026-03-17T11:12:26+02:00",
"date_finish": "2026-03-17T11:12:26+02:00",
"operating_reset_at": 1773735746,
"operating": 0.44127893447875977
}
}
Returned Data
|
Name |
Description |
|
result |
The identifier of the network bot for the connected external open channel. If the channel was previously connected, the method returns the existing identifier |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "LINE_NOT_FOUND",
"error_description": "Line not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
You entered an invalid code |
Invalid code in parameter |
|
|
|
Module IMBOT is not installed |
The imbot module is not installed |
|
|
|
Line not found |
Open channel not found |
|
|
|
Openline is inactive |
The open channel is currently unavailable |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Open Lines in Bitrix24
- Send a Message to a User on Behalf of the Open Channel imopenlines.network.message.add