Получить список 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* |
Условия выборки (подробное описание) |
|
select |
Список полей и вложенных путей, которые нужно вернуть в элементах списка. Если параметр не передан или передан пустой массив, метод возвращает только базовые метаданные: В Поля |
|
order |
Параметры сортировки (подробное описание). По умолчанию: |
|
pagination |
Параметры курсорной постраничной навигации (подробное описание) |
|
mentionFormat |
Формат упоминаний пользователей в текстовых AI-полях. Возможные значения:
По умолчанию: |
Параметр filter
|
Название |
Описание |
|
startDate* |
Период начала звонка (подробное описание) |
|
participantId |
Идентификатор участника звонка. Администратор может получить Follow-up по любому пользователю. Для обычного пользователя фильтр принудительно ограничивается его идентификатором |
Параметр filter.startDate
|
Название |
Описание |
|
from* |
Начало периода в формате ISO 8601. Например: |
|
to* |
Конец периода в формате ISO 8601. Значение должно быть больше или равно |
Параметр order
|
Название |
Описание |
|
startDate |
Направление сортировки по дате начала звонка. Возможные значения:
По умолчанию: |
Параметр pagination
|
Название |
Описание |
|
limit |
Размер страницы. По умолчанию: |
|
afterCursor |
Курсор следующей страницы. Передавайте значение |
Параметр pagination.afterCursor
Чтобы получить все страницы:
- Отправьте первый запрос без
pagination.afterCursor - Если в ответе
hasMoreравенtrue, скопируйте объектafterCursorиз ответа вpagination.afterCursorследующего запроса - Повторяйте запросы, пока
hasMoreне станет равенfalse
|
Название |
Описание |
|
startDate* |
Дата начала последнего элемента предыдущей страницы |
|
id* |
Идентификатор последнего элемента предыдущей страницы |
Примеры кода
Как использовать примеры в документации
Вызов нового 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 |
Объект с данными ответа |
|
items |
Массив объектов Follow-up. Состав полей зависит от Если подходящих Follow-up нет, вернется пустой массив |
|
hasMore |
Признак наличия следующей страницы |
|
afterCursor |
Курсор для получения следующей страницы. Если следующей страницы нет, возвращается |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "invalid_date_range",
"message": "Некорректный диапазон дат: both from and to are required"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Недостаточно прав доступа: отсутствует необходимый scope |
Проверьте, что у приложения или вебхука есть scope |
Ошибки фильтра
Код ошибки: invalid_date_range
|
Поле |
Описание ошибки |
Как исправить |
|
|
Некорректный диапазон дат |
Передайте |
Ошибки в параметре select
Код ошибки: invalid_select_field
|
Поле |
Описание ошибки |
Как исправить |
|
|
Недопустимое поле в |
Передайте поле из списка доступных значений |
Ошибки сортировки
Код ошибки: invalid_order
|
Поле |
Описание ошибки |
Как исправить |
|
|
Некорректный параметр |
Передайте |
Ошибки постраничной навигации
Код ошибки: invalid_pagination
|
Поле |
Описание ошибки |
Как исправить |
|
|
Некорректный параметр |
Передайте положительный целочисленный |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Передан неверный тип идентификатора участника |
Передайте |
|
|
Передано значение не из списка допустимых форматов |
Передайте |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |