Get the list of call participants crm.calllist.items.get
Scope:
crmWho can execute the method: a user with read access permission to CRM entities
The method crm.calllist.items.get returns a list of participants, contacts, or companies, along with the call status.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
LIST_ID* |
Identifier of the call list, which can be obtained using the methods crm.calllist.add and crm.calllist.list |
|
FILTER |
Filter by the call status of the item: |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{"LIST_ID":13,"FILTER":{"STATUS":"IN_WORK"}}' \
https://**your_bitrix24**/rest/**user_id**/**webhook**/crm.calllist.items.get
curl -X POST \
-H "Content-Type: application/json" \
-d '{"LIST_ID":13,"FILTER":{"STATUS":"IN_WORK"},"auth":"**put_access_token_here**"}' \
https://**your_bitrix24**/rest/crm.calllist.items.get
try
{
const response = await $b24.callMethod(
"crm.calllist.items.get",
{
LIST_ID: 13,
FILTER: {
STATUS: "IN_WORK"
}
}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.calllist.items.get',
[
'LIST_ID' => 13,
'FILTER' => [
'STATUS' => 'IN_WORK'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting call list items: ' . $e->getMessage();
}
BX24.callMethod(
"crm.calllist.items.get",
{
LIST_ID: 13,
FILTER: {
STATUS: "IN_WORK"
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.calllist.items.get',
[ 'LIST_ID' => 13, 'FILTER' => [ 'STATUS' => 'IN_WORK' ] ]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": [
{
"ID": 9,
"STATUS": "IN_WORK",
"ENTITY_TYPE": 3
},
{
"ID": 17,
"STATUS": "IN_WORK",
"ENTITY_TYPE": 3
},
{
"ID": 19,
"STATUS": "IN_WORK",
"ENTITY_TYPE": 3
}
],
"time": {
"start": 1752475017.529502,
"finish": 1752475017.588903,
"duration": 0.05940103530883789,
"processing": 0.010075092315673828,
"date_start": "2025-07-14T09:36:57+02:00",
"date_finish": "2025-07-14T09:36:57+02:00",
"operating_reset_at": 1752475617,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array of items with call statuses and object types |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "Incorrect list id",
"error_description": "An incorrect list identifier was provided."
}
|
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
|
Code |
Description |
Value |
|
|
|
Incorrect call list identifier |
|
|
|
Incorrect call status |
|
|
|
No access to list items |
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
- Create a New Call List crm.calllist.add
- Get Information About the Call List crm.calllist.get
- Get the list of call lists crm.calllist.list
- Get the list of call statuses crm.calllist.statuslist
- Update Call List Composition crm.calllist.update