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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: call

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

Метод относится к 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 по любому пользователю. Для обычного пользователя фильтр принудительно ограничивается его идентификатором

Параметр filter.startDate

Название
тип

Описание

from*
string

Начало периода в формате ISO 8601. Например: 2026-01-01T00:00:00Z

to*
string

Конец периода в формате ISO 8601. Значение должно быть больше или равно from

Параметр order

Название
тип

Описание

startDate
string

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

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

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

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

Параметр pagination

Название
тип

Описание

limit
integer

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

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

afterCursor
object

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

Параметр pagination.afterCursor

Чтобы получить все страницы:

  1. Отправьте первый запрос без pagination.afterCursor
  2. Если в ответе hasMore равен true, скопируйте объект afterCursor из ответа в pagination.afterCursor следующего запроса
  3. Повторяйте запросы, пока hasMore не станет равен false

Название
тип

Описание

startDate*
string

Дата начала последнего элемента предыдущей страницы

id*
integer

Идентификатор последнего элемента предыдущей страницы

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/call.followup.list

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
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","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/call.followup.list
// 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 FollowUpListResult = {
  items: Array<{
    callId: number
    startDate: string
    participants?: unknown[]
    overview?: { topic?: string, actionItems?: unknown[] }
  }>
  hasMore: boolean
  afterCursor: { startDate: string, id: number } | null
}

try {
  const response = await $b24.actions.v3.call.make<FollowUpListResult>({
    method: 'call.followup.list',
    params: {
      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',
    },
    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(result.items, result.afterCursor)
  }
} 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 getFollowUpList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'call.followup.list',
        params: {
          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',
        },
        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('Follow-ups found:', result.items.length, result.items)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getFollowUpList)
</script>

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'call.followup.list',
            [
                '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',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

BX24.callMethod(
    'call.followup.list',
    {
        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'
    },
    function(result) {
        console.info(result.data());
        console.log(result);
    }
);

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

require_once('crest.php');

$result = CRest::call(
    'call.followup.list',
    [
        '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',
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "call.followup.list", b24.Params{
	"filter": b24.Params{
		"startDate": b24.Params{
			"from": "2026-01-01T00:00:00Z",
			"to":   "2026-01-31T23:59:59Z",
		},
	},
	"select": []string{"callId", "startDate", "participants", "overview.topic", "overview.actionItems"},
	"order": b24.Params{
		"startDate": "desc",
	},
	"pagination": b24.Params{
		"limit": 20,
	},
	"mentionFormat": "html",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("call.followup.list: %w", err)
}

var item struct {
	HasMore bool `json:"hasMore"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.HasMore)

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

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"
    }
}

Название
тип

Описание

error.code
string

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

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

Ошибки доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION

Поле

Описание ошибки

Как исправить

-

Недостаточно прав доступа: отсутствует необходимый scope

Проверьте, что у приложения или вебхука есть scope call

Ошибки фильтра

Код ошибки: invalid_date_range

Поле

Описание ошибки

Как исправить

filter.startDate

Некорректный диапазон дат

Передайте from и to в формате ISO 8601. Значение from должно быть меньше или равно to

Ошибки в параметре select

Код ошибки: invalid_select_field

Поле

Описание ошибки

Как исправить

select

Недопустимое поле в select

Передайте поле из списка доступных значений select

Ошибки сортировки

Код ошибки: invalid_order

Поле

Описание ошибки

Как исправить

order

Некорректный параметр order

Передайте { "startDate": "asc" } или { "startDate": "desc" }

Ошибки постраничной навигации

Код ошибки: invalid_pagination

Поле

Описание ошибки

Как исправить

pagination

Некорректный параметр pagination

Передайте положительный целочисленный limit и курсор из предыдущего ответа

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

filter.participantId

Передан неверный тип идентификатора участника

Передайте filter.participantId как целое число

mentionFormat

Передано значение не из списка допустимых форматов

Передайте bb, html или none

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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