метод REST scope: call

call.followup.list

Получить список Follow-up звонков

Кто может выполнять: любой пользователь

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод call.followup.list возвращает список Follow-up звонков за указанный период.

Параметры

filter object обязательный

Условия выборки (подробное описание)

select array необязательный

Список полей и вложенных путей, которые нужно вернуть в элементах списка.

Если параметр не передан или передан пустой массив, метод возвращает только базовые метаданные: callId, callType, initiatorId, startDate, endDate, durationSeconds.

В select можно передать корневые поля Follow-up, AI-блоки или доступные вложенные пути через точку. Полный список полей и доступных вложенных путей смотрите в статье Поля Follow-up звонков.

Поля transcription, overview и insights считаются тяжелыми. Если они есть в select, сервер ограничит pagination.limit значением 20

order object необязательный

Параметры сортировки (подробное описание).

По умолчанию: { "startDate": "desc" }

pagination object необязательный

Параметры курсорной постраничной навигации (подробное описание)

mentionFormat string необязательный

Формат упоминаний пользователей в текстовых AI-полях.

Возможные значения:

  • bb — BBCode-формат
  • html — HTML-формат
  • none — текст без разметки упоминаний

По умолчанию: bb

Параметр filter

startDate object обязательный

Период начала звонка (подробное описание)

participantId integer необязательный

Идентификатор участника звонка.

Администратор может получить Follow-up по любому пользователю. Для обычного пользователя фильтр принудительно ограничивается его идентификатором

Параметр order

startDate string необязательный

Направление сортировки по дате начала звонка.

Возможные значения:

  • asc — по возрастанию
  • desc — по убыванию

По умолчанию: desc

Параметр pagination

limit integer необязательный

Размер страницы.

По умолчанию: 50. Максимум: 200 для легкой выборки и 20 для выборки с тяжелыми AI-полями. Если передать значение больше максимума, сервер применит максимальное значение

afterCursor object необязательный

Курсор следующей страницы. Передавайте значение afterCursor целиком из предыдущего ответа в том же формате, в котором оно пришло (подробное описание)

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"startDate":{"from":"2026-01-01T00:00:00Z","to":"2026-01-31T23:59:59Z"}},"select":["callId","startDate","participants","overview.topic","overview.actionItems"],"order":{"startDate":"desc"},"pagination":{"limit":20},"mentionFormat":"html"}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/call.followup.list

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "callId": 12345,
                "startDate": "2026-01-15T10:00:00+00:00",
                "participants": [
                    { "userId": 7, "name": "Иван Петров", "avatar": "https://...", "talkedSeconds": 600 },
                    { "userId": 42, "name": "Мария Иванова", "talkedSeconds": 1200 }
                ],
                "overview": {
                    "topic": "Планирование спринта",
                    "actionItems": [
                        { "actionItem": "Выкатить MVP к пятнице", "quote": "..." }
                    ]
                }
            }
        ],
        "hasMore": true,
        "afterCursor": { "startDate": "2026-01-12T14:30:00.000000+00:00", "id": 12330 }
    },
    "time": {
        "start": 1784017027,
        "finish": 1784017027.356922,
        "duration": 0.356921911239624,
        "processing": 0,
        "date_start": "2026-07-14T11:17:07+03:00",
        "date_finish": "2026-07-14T11:17:07+03:00",
        "operating_reset_at": 1784017627,
        "operating": 0
    }
}

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

result object

Объект с данными ответа

items array

Массив объектов Follow-up. Состав полей зависит от select.

Если подходящих Follow-up нет, вернется пустой массив []

hasMore boolean

Признак наличия следующей страницы

afterCursor object

Курсор для получения следующей страницы.

Если следующей страницы нет, возвращается null

time time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "invalid_date_range",
        "message": "Некорректный диапазон дат: both from and to are required"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Недостаточно прав доступа: отсутствует необходимый scope Проверьте, что у приложения или вебхука есть scope call

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.