Get Operators with Load imopenlines.v2.Operator.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
imopenlinesWho can execute the method: a user with access to Open Channels reports
The method imopenlines.v2.Operator.list retrieves operators with their current status and load.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
configId |
Open channel ID. You can obtain the ID using imopenlines.config.list.get |
|
configIdList |
List of open channel IDs. You can obtain the IDs using imopenlines.config.list.get. If both Maximum: 1000 items |
|
userId |
Operator ID. You can obtain the ID using user.get or user.search |
|
userIdList |
List of operator IDs. You can obtain the IDs using user.get or user.search. If both Maximum: 1000 items |
|
status |
Operator status. Possible values:
|
|
hasFreeSlots |
Filter by available free slots. Possible values:
|
|
offset |
Pagination offset. Default: |
|
limit |
Page size. Possible values: from Default: |
Status and active session count data may be updated at different times. For a real-time load widget, request the method no more than once every 30 seconds.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"configId": 3,
"status": "online",
"limit": 50
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.v2.Operator.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"configId": 3,
"status": "online",
"limit": 50,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/imopenlines.v2.Operator.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type OperatorListResult = {
operators: Array<{
userId: number
configId: number
status: string
activeSessions: number
maxChat: number
freeSlots: number
lastActivityDate: string | null
}>
hasNextPage: boolean
}
try {
const response = await $b24.actions.v2.call.make<OperatorListResult>({
method: 'imopenlines.v2.Operator.list',
params: {
configId: 3,
status: 'online',
limit: 50,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
console.info(response.getData()!.result.operators)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getOpenlinesOperators() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imopenlines.v2.Operator.list',
params: {
configId: 3,
status: 'online',
limit: 50,
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
console.info(response.getData().result.operators)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getOpenlinesOperators)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.call(
"imopenlines.v2.Operator.list",
{
"configId": 3,
"status": "online",
"limit": 50,
},
).response
print(bitrix_response.result)
except BitrixAPIError as error:
print(f"error: {error.error}", f"error_description: {error.error_description}", sep="\n")
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
try {
$response = $b24Service
->core
->call(
'imopenlines.v2.Operator.list',
[
'configId' => 3,
'status' => 'online',
'limit' => 50,
]
);
print_r($response->getResponseData()->getResult());
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'imopenlines.v2.Operator.list',
{
configId: 3,
status: 'online',
limit: 50,
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imopenlines.v2.Operator.list',
[
'configId' => 3,
'status' => 'online',
'limit' => 50,
]
);
print_r($result);
res, err := client.Core().Call(ctx, "imopenlines.v2.Operator.list", b24.Params{
"configId": 3,
"status": "online",
"limit": 50,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("imopenlines.v2.Operator.list: %w", err)
}
fmt.Println(string(res.Result))
Response Handling
HTTP Status: 200
{
"result": {
"operators": [
{
"userId": 42,
"configId": 3,
"status": "online",
"activeSessions": 2,
"maxChat": 5,
"freeSlots": 3,
"lastActivityDate": "2026-06-15T15:01:00+02:00"
}
],
"hasNextPage": false
},
"time": {
"start": 1782810000,
"finish": 1782810000.2,
"duration": 0.2,
"processing": 0,
"date_start": "2026-06-30T10:00:00+02:00",
"date_finish": "2026-06-30T10:00:00+02:00",
"operating_reset_at": 1782810600,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root response object |
|
result.operators |
List of operators. See all fields of the |
|
result.hasNextPage |
Indicates whether there is a next page |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "INVALID_FILTER",
"error_description": "Invalid status filter value"
}
|
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 |
|
|
|
Statistics reports are not available on the current tariff plan |
The plan does not allow using Open Channels reports |
|
|
|
Invalid status filter value |
An unknown |
|
|
|
Offset is too large |
|
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |