Get the Status of the Connector imconnector.status
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
imopenlinesWho can execute the method: any user
The method imconnector.status returns the current status of the connector for the specified open line.
The method works only in the context of the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
CONNECTOR* |
The string code of the connector specified in the |
|
LINE |
The identifier of the open line |
If the LINE parameter is not provided, the method automatically uses the value 0. This affects the result of the check:
- For a valid line identifier, the connector may be active and configured.
- With
LINE=0, the method typically returnsCONFIGURED=falseandSTATUS=false, even if the connector is functioning for other lines.
To obtain an accurate status, always specify the identifier of the open line.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CONNECTOR":"myconnector","LINE":"12","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imconnector.status
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ConnectorStatusResult = {
LINE: number
CONNECTOR: string
ERROR: boolean
CONFIGURED: boolean
STATUS: boolean
}
try {
const response = await $b24.actions.v2.call.make<ConnectorStatusResult>({
method: 'imconnector.status',
params: {
CONNECTOR: 'myconnector',
LINE: '12',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Connector status:', result.STATUS, '| Configured:', result.CONFIGURED, '| Error:', result.ERROR)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getConnectorStatus() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imconnector.status',
params: {
CONNECTOR: 'myconnector',
LINE: '12',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Connector status:', result.STATUS, '| Configured:', result.CONFIGURED, '| Error:', result.ERROR)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getConnectorStatus)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imconnector.status(
connector="myconnector",
line="12",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
$result = $b24Service->core->call(
'imconnector.status',
[
'CONNECTOR' => 'myconnector',
'LINE' => '12',
]
);
BX24.callMethod(
'imconnector.status',
{
CONNECTOR: 'myconnector',
LINE: '12',
},
function(result) {
console.log(result.data());
}
);
$result = CRest::call(
'imconnector.status',
[
'CONNECTOR' => 'myconnector',
'LINE' => '12',
]
);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imconnector.status", b24.Params{
"CONNECTOR": "myconnector",
"LINE": "12",
})
if err != nil {
return fmt.Errorf("imconnector.status: %w", err)
}
var item struct {
Line int `json:"LINE"`
Connector string `json:"CONNECTOR"`
Error bool `json:"ERROR"`
Configured bool `json:"CONFIGURED"`
Status bool `json:"STATUS"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Line, item.Connector)
Response Handling
HTTP Status: 200
{
"result": {
"LINE": 12,
"CONNECTOR": "myconnector",
"ERROR": false,
"CONFIGURED": true,
"STATUS": true
},
"time": {
"start": 1738065600.11,
"finish": 1738065600.18,
"duration": 0.07,
"processing": 0.03,
"date_start": "2025-01-28T12:00:00+00:00",
"date_finish": "2025-01-28T12:00:00+00:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Connector status object (detailed description) |
|
time |
Information about the request execution time |
result Object
|
Name |
Description |
|
LINE |
The identifier of the open line |
|
CONNECTOR |
The identifier of the connector |
|
ERROR |
Indicates an error in the connector's status |
|
CONFIGURED |
Indicates whether the connector is fully configured |
|
STATUS |
The final status of the connector's availability |
Error Handling
HTTP Status: 400, 403
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'CONNECTOR' is null or empty"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Current authorization type is denied for this method. Application context required |
The method was called outside the application context of OAuth |
|
|
|
Argument 'CONNECTOR' is null or empty |
The connector identifier |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Register the Connector imconnector.register
- Activate Connector imconnector.activate
- Set Connector Settings imconnector.connector.data.set
- Get the List of Connectors imconnector.list
- Unregister the Connector imconnector.unregister
- Send Messages to Bitrix24 imconnector.send.messages
- Update Sent Messages with imconnector.update.messages
- Delete Sent Messages imconnector.delete.messages
- Update Status "Delivered" imconnector.send.status.delivery
- Set a New Chat Name imconnector.chat.name.set