Получить список Follow-up звонков Битрикс24 Синк syncconnector.followup.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
syncconnectorКто может выполнять метод: любой пользователь
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод syncconnector.followup.list возвращает список Follow-up звонков Битрикс24 Синк за период.
Обычный пользователь получает Follow-up звонков, в которых он говорил или в чате которых состоит. Администратор получает Follow-up всех сотрудников, а с параметром filter.participantId — одного сотрудника.
Метод возвращает только Follow-up звонков Синка. Чтобы получить их вместе с Follow-up звонков Битрикс24, используйте call.followup.list: параметры и поля ответа у него те же.
callId в ответе — идентификатор не звонка, а страницы подробного разбора: ее открывает ссылка «Подробный разбор» в чате. У звонка Синка может быть несколько таких страниц, по одной на каждую часть. Части одного звонка объединяет поле uuid: добавьте его в select, чтобы их собрать. В call.followup.list тот же Follow-up приходит с callId, равным 10000000000 плюс идентификатор страницы.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter* |
Условия выборки (подробное описание) |
|
select |
Список полей и вложенных путей, которые нужно вернуть в элементах списка. Если параметр не передан или передан пустой массив, метод возвращает поля Поле из AI-поля — |
|
order |
Параметры сортировки (подробное описание). По умолчанию: |
|
pagination |
Параметры курсорной постраничной навигации (подробное описание) |
|
mentionFormat |
Формат упоминаний пользователей в текстовых AI-полях. Возможные значения:
По умолчанию: |
Параметр filter
|
Название |
Описание |
|
startDate* |
Период начала звонка (подробное описание) |
|
participantId |
Идентификатор сотрудника. Администратору метод вернет Follow-up этого сотрудника, а без параметра — всех сотрудников. Для остальных пользователей параметр не меняет результат. Передайте значение числом, иначе метод вернет ошибку валидации |
|
chatId |
Идентификатор чата. Метод вернет Follow-up только звонков из этого чата. Передайте значение числом: строка |
Параметр filter.startDate
|
Название |
Описание |
|
from* |
Начало периода в формате ISO 8601 с временем и часовым поясом, например |
|
to* |
Конец периода в том же формате. Значение должно быть больше или равно |
Параметр order
|
Название |
Описание |
|
startDate |
Направление сортировки по дате начала. Возможные значения:
По умолчанию: |
Параметр pagination
|
Название |
Описание |
|
limit |
Наибольшее число Follow-up в одном ответе. По умолчанию: |
|
afterCursor |
Курсор следующей страницы. Передайте объект |
Другие ключи в pagination метод не принимает: page и offset вернут ошибку invalid_pagination.
Параметр pagination.afterCursor
Чтобы получить все страницы:
- Отправьте первый запрос без
pagination.afterCursor - Если в ответе
hasMoreравенtrue, скопируйте объектafterCursorиз ответа вpagination.afterCursorследующего запроса - Повторяйте запросы, пока
hasMoreне станет равенfalse, даже если ответ пришел пустым или в нем меньше элементов, чемlimit
|
Название |
Описание |
|
startDate* |
Дата начала последнего элемента предыдущей страницы |
|
id* |
Идентификатор последнего элемента предыдущей страницы |
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/syncconnector.followup.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"startDate":{"from":"2026-11-01T00:00:00Z","to":"2026-11-30T23: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**/syncconnector.followup.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"startDate":{"from":"2026-11-01T00:00:00Z","to":"2026-11-30T23: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/syncconnector.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 SyncFollowUpListResult = {
items: Array<{
callId: number
startDate?: string
participants?: unknown[]
overview?: { topic?: string, actionItems?: unknown[] } | null
}>
hasMore: boolean
afterCursor: { startDate: string, id: number } | null
}
try {
const response = await $b24.actions.v3.call.make<SyncFollowUpListResult>({
method: 'syncconnector.followup.list',
params: {
filter: {
startDate: {
from: '2026-11-01T00:00:00Z',
to: '2026-11-30T23: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.hasMore, 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 getSyncFollowUpList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'syncconnector.followup.list',
params: {
filter: {
startDate: {
from: '2026-11-01T00:00:00Z',
to: '2026-11-30T23: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', getSyncFollowUpList)
</script>
В b24pysdk нет готовых методов syncconnector.followup.*, поэтому метод вызывается через call_method — добавьте его в api_v3_methods, как в примере.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "syncconnector.followup.list"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
bitrix_token = client.get_token()
try:
response = bitrix_token.call_method(
api_method=method,
params={
"filter": {
"startDate": {
"from": "2026-11-01T00:00:00Z",
"to": "2026-11-30T23:59:59Z",
},
},
"select": [
"callId",
"startDate",
"participants",
"overview.topic",
"overview.actionItems",
],
"order": {
"startDate": "desc",
},
"pagination": {
"limit": 20,
},
"mentionFormat": "html",
},
prefer_version=3,
)
result = response["result"]
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'syncconnector.followup.list',
[
'filter' => [
'startDate' => [
'from' => '2026-11-01T00:00:00Z',
'to' => '2026-11-30T23:59:59Z',
],
],
'select' => ['callId', 'startDate', 'participants', 'overview.topic', 'overview.actionItems'],
'order' => ['startDate' => 'desc'],
'pagination' => ['limit' => 20],
'mentionFormat' => 'html',
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'syncconnector.followup.list',
{
filter: {
startDate: {
from: '2026-11-01T00:00:00Z',
to: '2026-11-30T23:59:59Z'
}
},
select: ['callId', 'startDate', 'participants', 'overview.topic', 'overview.actionItems'],
order: { startDate: 'desc' },
pagination: { limit: 20 },
mentionFormat: 'html'
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'syncconnector.followup.list',
[
'filter' => [
'startDate' => [
'from' => '2026-11-01T00:00:00Z',
'to' => '2026-11-30T23: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, "syncconnector.followup.list", b24.Params{
"filter": b24.Params{
"startDate": b24.Params{
"from": "2026-11-01T00:00:00Z",
"to": "2026-11-30T23: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("syncconnector.followup.list: %w", err)
}
var page struct {
Items []json.RawMessage `json:"items"`
HasMore bool `json:"hasMore"`
AfterCursor *struct {
StartDate string `json:"startDate"`
ID int `json:"id"`
} `json:"afterCursor"`
}
if err := json.Unmarshal(res.Result, &page); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(len(page.Items), page.HasMore)
Обработка ответа
HTTP-статус: 200
{
"result": {
"items": [
{
"callId": 128,
"startDate": "2026-11-12T09:00:00+00:00",
"participants": [
{ "userId": 7, "talkedSeconds": 600, "name": "Иван Петров", "avatar": "https://...", "workPosition": "Руководитель проекта" },
{ "userId": 42, "talkedSeconds": 1200, "name": "Мария Иванова", "avatar": null, "workPosition": null }
],
"overview": {
"topic": "Планирование спринта",
"actionItems": [
{ "actionItem": "Выкатить MVP к пятнице", "quote": "..." }
]
}
}
],
"hasMore": true,
"afterCursor": { "startDate": "2026-11-12T09:00:00.000000+00:00", "id": 128 }
},
"time": {
"start": 1794476996,
"finish": 1794476996.873855,
"duration": 0.8738551139831543,
"processing": 0,
"date_start": "2026-11-12T12:49:56+03:00",
"date_finish": "2026-11-12T12:49:56+03:00",
"operating_reset_at": 1794477540,
"operating": 0
}
}
Если Follow-up за период нет, метод вернет {"items":[],"hasMore":false,"afterCursor":null}.
Возвращаемые данные
|
Название |
Описание |
|
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
|
Поле |
Описание ошибки |
Как исправить |
|
|
Некорректный диапазон дат: both from and to are required |
Передайте |
|
|
Некорректный диапазон дат: from must be <= to |
Значение |
Ошибки в параметре select
Код ошибки: invalid_select_field
|
Поле |
Описание ошибки |
Как исправить |
|
|
Недопустимое поле в select: |
Передайте поле из списка доступных значений |
Ошибки сортировки
Код ошибки: invalid_order
|
Поле |
Описание ошибки |
Как исправить |
|
|
Некорректный параметр order |
Передайте |
Ошибки постраничной навигации
Код ошибки: invalid_pagination
|
Поле |
Описание ошибки |
Как исправить |
|
|
Некорректный параметр pagination |
Передайте только |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
В поле |
Передайте |
|
|
В поле |
Передайте |
|
|
Значение поля не содержится в списке допустимых значений |
Передайте |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить Follow-up звонка Битрикс24 Синк syncconnector.followup.get
- Получить список полей Follow-up звонков Битрикс24 Синк syncconnector.followup.field.list
- Получить описание поля Follow-up звонков Битрикс24 Синк syncconnector.followup.field.get
- Поля Follow-up звонков
- Follow-up звонков в REST 3.0: обзор методов