Получить список обзвонов crm.calllist.list

Scope: crm

Кто может выполнять метод: пользователь с правами на чтение элементов CRM

Метод crm.calllist.list возвращает список дел обзвонов.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

SELECT
array

Массив полей для выборки. По умолчанию возвращаются все поля.
Список полей для выборки:

  • ID,
  • DATE_CREATE,
  • CREATED_BY_ID,
  • WEBFORM_ID,
  • ENTITY_TYPE_ID

FILTER
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
  • field_n — название поля, по которому будет отфильтрована выборка обзвонов
  • value_n — значение фильтра

Список полей для фильтрации:

  • ID,
  • CREATED_BY_ID,
  • WEBFORM_ID,
  • ENTITY_TYPE_ID.

Полю может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • >= — больше либо равно,
  • > — больше,
  • <= — меньше либо равно,
  • < — меньше,
  • @ — IN, в качестве значения передается массив,
  • !@— NOT IN, в качестве значения передается массив,
  • = — равно, точное совпадение, используется по умолчанию,
  • != - не равно,
  • ! — не равно

ORDER
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
  • field_n — название поля, по которому будет произведена сортировка обзвонов
  • value_n — значение типа string, равное:
    • ASC — сортировка по возрастанию
    • DESC — сортировка по убыванию

Примеры кода

Как использовать примеры в документации

curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{"SELECT":["ID","CREATED_BY_ID"],"FILTER":{"ENTITY_TYPE_ID":3},"ORDER":{"ID":"DESC"}}' https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.calllist.list
        
curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{"SELECT":["ID","CREATED_BY_ID"],"FILTER":{"ENTITY_TYPE_ID":3},"ORDER":{"ID":"DESC"},"auth":"**put_access_token_here**"}' https://**put_your_bitrix24_address**/rest/crm.calllist.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.calllist.list',
            {
              SELECT: ["ID", "CREATED_BY_ID"],
              FILTER: { "ENTITY_TYPE_ID": 3 },
              ORDER: { "ID": "DESC" }
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('crm.calllist.list', { SELECT: ["ID", "CREATED_BY_ID"], FILTER: { "ENTITY_TYPE_ID": 3 }, ORDER: { "ID": "DESC" } }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.calllist.list', { SELECT: ["ID", "CREATED_BY_ID"], FILTER: { "ENTITY_TYPE_ID": 3 }, ORDER: { "ID": "DESC" } }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.calllist.list',
                    [
                        'SELECT' => ['ID', 'CREATED_BY_ID'],
                        'FILTER' => ['ENTITY_TYPE_ID' => 3],
                        'ORDER'  => ['ID' => 'DESC'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching call list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.calllist.list",
            {
                SELECT: ["ID", "CREATED_BY_ID"],
                FILTER: { "ENTITY_TYPE_ID": 3 },
                ORDER: { "ID": "DESC" }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.calllist.list',
            [
                'SELECT' => ['ID', 'CREATED_BY_ID'],
                'FILTER' => ['ENTITY_TYPE_ID' => 3],
                'ORDER' => ['ID' => 'DESC']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "13",
                    "CREATED_BY_ID": "29"
                },
                {
                    "ID": "9",
                    "CREATED_BY_ID": "1"
                },
                {
                    "ID": "3",
                    "CREATED_BY_ID": "131"
                },
                {
                    "ID": "1",
                    "CREATED_BY_ID": "131"
                }
            ],
            "time": {
                "start": 1752475786.965766,
                "finish": 1752475787.035008,
                "duration": 0.06924200057983398,
                "processing": 0.016666889190673828,
                "date_start": "2025-07-14T09:49:46+03:00",
                "date_finish": "2025-07-14T09:49:47+03:00",
                "operating_reset_at": 1752476387,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
array

Корневой элемент ответа. Содержит массив из объектов, содержащих информацию об обзвонах.

Структура полей зависит от параметра select

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "Invalid parameters.",
            "error_description": "Переданы некорректные параметры."
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

400

Invalid parameters

Переданы некорректные параметры

100

Unknown field definition "TITLE"

Неизвестный параметр «Название параметра»

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить участников списка обзвона
Следующая
Получить список статусов обзвона