Для AI-агентов: markdown этой страницы — /docs-content/calls/sync-followup/get.md индекс документации — /llms.txt

Фоллоуап встречи Синка

GET /v1/calls/sync-followups/:followupId

Метод в процессе раскатки — выходит в обновлении syncconnector 26.100.0; rest >= 26.1300.0. Если метода ещё нет на вашем портале Битрикс24, API вернёт 422 METHOD_NOT_YET_AVAILABLE с error.release. На порталах с доступным методом вызов работает в обычном режиме.

Возвращает AI-фоллоуап одной встречи Синка.

Параметры

Параметр Тип Обяз. Описание
ПараметрfollowupId (path) Типinteger Обяз.да ОписаниеНомер фоллоуапа, положительное целое. Это поле callId элемента списка фоллоуапов Синка
Параметрselect (query) Типstring[] Обяз.нет ОписаниеКакие поля вернуть. Передаётся повторяющимся параметром или списком через запятую. Словарь значений общий со списком — раздел «Поле select» страницы Список фоллоуапов Синка
ПараметрmentionFormat (query) Типstring Обяз.нет ОписаниеФормат @-упоминаний в текстовых полях: bb, html или none. По умолчанию — bb. Как выглядит каждый формат — раздел «Формат упоминаний» страницы Список фоллоуапов Синка

Другие query-параметры отклоняются с 400 INVALID_PARAMS.

Поле select

Значение select Что в ответе
Значение selectНе указан Что в ответеПолный фоллоуап: метаданные и все AI-блоки
Значение select?select= или ?select=[] Что в ответеТолько базовые поля: callId, callType, initiatorId, startDate, endDate, durationSeconds
Значение selectСписок полей Что в ответеТолько перечисленные поля и всегда callId

Этим получение отличается от списка: там запрос без select возвращает только базовые поля.

Примеры

Запрос без select — возвращается весь фоллоуап. mentionFormat=none убирает разметку упоминаний, поэтому текст готов к передаче в нейросеть или к сохранению в задачу. Чтобы забрать только часть блоков, добавьте select — например ?select=overview.actionItems&select=evaluation.efficiencyValue.

curl — личный ключ

Terminal
curl "https://vibecode.bitrix24.tech/v1/calls/sync-followups/1204?mentionFormat=none" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal
curl "https://vibecode.bitrix24.tech/v1/calls/sync-followups/1204?mentionFormat=none" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript
const params = new URLSearchParams({ mentionFormat: 'none' })

const res = await fetch(`https://vibecode.bitrix24.tech/v1/calls/sync-followups/1204?${params}`, {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const body = await res.json()

if (!body.success) {
  // Ошибку разбираем явно: иначе на 403 или 422 код упадёт на обращении к data
  throw new Error(`${body.error.code}: ${body.error.message}`)
}

const meeting = body.data.item

console.log(meeting.outcomes, `${meeting.durationSeconds} сек`)
console.log(meeting.overview?.topic ?? 'обзор не сформирован')

// agreements, actionItems и meetings приходят null, если на встрече их нет
for (const item of meeting.overview?.actionItems ?? []) {
  console.log('задача:', item.actionItem, '— цитата:', item.quote)
}

for (const speaker of meeting.insights?.speakerAnalysis ?? []) {
  console.log(`участник ${speaker.userId}: ${speaker.talkPercentage}% времени, оценка ${speaker.efficiencyValue}`)
}

// Набор критериев зависит от типа встречи: обходим карту по ключам
for (const [code, criterion] of Object.entries(meeting.evaluation?.criteria ?? {})) {
  console.log(code, criterion.value ? 'выполнен' : 'не выполнен', '—', criterion.thoughts)
}

JavaScript — OAuth-приложение

javascript
const params = new URLSearchParams({ mentionFormat: 'none' })

const res = await fetch(`https://vibecode.bitrix24.tech/v1/calls/sync-followups/1204?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const body = await res.json()

if (!body.success) {
  // Ошибку разбираем явно: иначе на 403 или 422 код упадёт на обращении к data
  throw new Error(`${body.error.code}: ${body.error.message}`)
}

console.log(body.data.item)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.item Типobject ОписаниеФоллоуап встречи. Поля — в таблице ниже

Поля объекта item:

Поле Тип Описание
Полеitem.callId Типnumber ОписаниеНомер фоллоуапа
Полеitem.callType Типnumber ОписаниеВид встречи
Полеitem.initiatorId Типnumber | null ОписаниеИнициатор встречи. Карточка сотрудника — GET /v1/users/:id
Полеitem.startDate Типstring ОписаниеНачало встречи, ISO 8601
Полеitem.endDate Типstring ОписаниеОкончание встречи, ISO 8601
Полеitem.durationSeconds Типnumber ОписаниеДлительность встречи в секундах
Полеitem.uuid Типstring ОписаниеИдентификатор встречи, 26 символов
Полеitem.chatId Типnumber ОписаниеЧат встречи. Передаётся в filter.chatId списка
Полеitem.language Типstring ОписаниеКод языка транскрипции
Полеitem.version Типnumber ОписаниеВерсия схемы AI-данных
Полеitem.participants Типobject[] ОписаниеУчастники встречи
Полеitem.outcomes Типstring[] ОписаниеГотовые AI-блоки: transcription, overview, summary, insights, evaluation
Полеitem.createdAt Типstring ОписаниеВремя формирования фоллоуапа, ISO 8601
Полеitem.tracks Типobject[] ОписаниеЗаписи встречи
Полеitem.transcription Типobject | null ОписаниеТранскрипция разговора. Готовые блоки перечислены в outcomes
Полеitem.overview Типobject | null ОписаниеОбзор встречи. Готовые блоки перечислены в outcomes
Полеitem.summary Типobject | null ОписаниеКраткое изложение по фрагментам. Готовые блоки перечислены в outcomes
Полеitem.insights Типobject | null ОписаниеАналитические выводы и разбор участников. Готовые блоки перечислены в outcomes
Полеitem.evaluation Типobject | null ОписаниеОценка эффективности встречи. Готовые блоки перечислены в outcomes

Участники — `participants[]`

Поле Тип Описание
ПолеuserId Типnumber ОписаниеИдентификатор сотрудника. Карточка — GET /v1/users/:id
Полеname Типstring ОписаниеИмя сотрудника
Полеavatar Типstring ОписаниеСсылка на аватар
ПолеworkPosition Типstring ОписаниеДолжность
ПолеtalkedSeconds Типnumber ОписаниеСколько секунд участник говорил

Записи встречи — `tracks[]`

Поле Тип Описание
ПолеtrackId Типnumber ОписаниеИдентификатор записи
ПолеcallId Типnumber ОписаниеНомер фоллоуапа, к которому относится запись
Полеtype Типstring ОписаниеВид дорожки, например record
ПолеfileId Типnumber ОписаниеИдентификатор файла записи
ПолеdiskFileId Типnumber ОписаниеИдентификатор файла на Диске. Не совпадает с fileId
Полеduration Типnumber ОписаниеДлительность записи в секундах
ПолеfileName Типstring ОписаниеИмя файла
ПолеfileSize Типnumber ОписаниеРазмер файла в байтах
ПолеmimeType Типstring ОписаниеMIME-тип файла, например audio/mp4
ПолеrelUrl Типstring ОписаниеПуть для скачивания относительно адреса портала
Полеurl Типstring ОписаниеПолная ссылка для скачивания: адрес портала и relUrl. Наличие ссылки не гарантирует, что запись можно скачать
ПолеdateCreate Типstring ОписаниеКогда запись создана, ISO 8601

Транскрипция — `transcription`

Поле Тип Описание
Полеlanguage Типstring ОписаниеКод языка расшифровки
Полеsegments[] Типobject[] ОписаниеРеплики в хронологическом порядке
Полеsegments[].userId Типnumber ОписаниеКто говорит
Полеsegments[].userName Типstring ОписаниеИмя говорящего
Полеsegments[].start Типstring ОписаниеНачало реплики от начала встречи, ММ:СС. Значение минут может превышать 59
Полеsegments[].end Типstring ОписаниеКонец реплики от начала встречи, ММ:СС
Полеsegments[].text Типstring ОписаниеТекст реплики

Обзор встречи — `overview`

Поле Тип Описание
Полеtopic Типstring ОписаниеТема встречи
ПолеdetailedTakeaways Типstring ОписаниеРазвёрнутые выводы
ПолеmeetingType Типobject ОписаниеТип встречи: typeTag — код, например status_meeting, title — название, explanation — обоснование
Полеagenda Типobject ОписаниеПовестка: explanation — формулировка, quote — цитата из разговора
Полеagreements[] Типobject[] | null ОписаниеДоговорённости: agreement — формулировка, quote — цитата. null, если договорённостей нет
ПолеactionItems[] Типobject[] | null ОписаниеЗадачи. null, если задач нет
ПолеactionItems[].actionItem Типstring ОписаниеФормулировка задачи. Упоминания сотрудников оформлены по mentionFormat
ПолеactionItems[].actionItemMentionLess Типstring ОписаниеТа же формулировка без разметки упоминаний: имена сотрудников остаются обычным текстом
ПолеactionItems[].quote Типstring ОписаниеЦитата из разговора
Полеmeetings[] Типobject[] | null ОписаниеНазначенные встречи: meeting — формулировка с упоминаниями по mentionFormat, meetingMentionLess — та же формулировка без разметки упоминаний, quote — цитата. null, если встреч не назначено

Краткое изложение — `summary`

Поле Тип Описание
Полеsegments[] Типobject[] ОписаниеФрагменты разговора
Полеsegments[].start Типstring ОписаниеНачало фрагмента, ММ:СС
Полеsegments[].end Типstring ОписаниеКонец фрагмента, ММ:СС
Полеsegments[].title Типstring ОписаниеЗаголовок фрагмента
Полеsegments[].summary Типstring ОписаниеИзложение фрагмента

Аналитические выводы — `insights`

Поле Тип Описание
ПолеspeakerEvaluationAvailable Типboolean ОписаниеДоступен ли разбор участников
ПолеspeakerAnalysis[] Типobject[] ОписаниеРазбор участников, по убыванию talkPercentage
ПолеspeakerAnalysis[].userId Типnumber ОписаниеИдентификатор сотрудника. Карточка — GET /v1/users/:id
ПолеspeakerAnalysis[].detailedInsight Типstring ОписаниеВывод по участнику
ПолеspeakerAnalysis[].efficiencyValue Типnumber ОписаниеОценка эффективности участника, от 0 до 100
ПолеspeakerAnalysis[].evaluationCriteria Типobject ОписаниеКарта критериев оценки участника. Ключ — код критерия, например politeness или staysOnTopic
ПолеspeakerAnalysis[].evaluationCriteria.<код>.value Типboolean ОписаниеВыполнен ли критерий
ПолеspeakerAnalysis[].evaluationCriteria.<код>.title Типstring ОписаниеНазвание критерия
ПолеspeakerAnalysis[].evaluationCriteria.<код>.criteria Типstring ОписаниеФормулировка критерия
ПолеspeakerAnalysis[].talkPercentage Типnumber ОписаниеДоля времени, которую участник говорил, в процентах
ПолеspeakerAnalysis[].duration Типnumber ОписаниеСколько секунд участник говорил
ПолеspeakerAnalysis[].durationFormat Типstring ОписаниеТо же время текстом, например 18 мин
ПолеmeetingStrengths, meetingWeaknesses, speechStyleInfluence, engagementLevel, areasOfResponsibility, finalRecommendations Типnull ОписаниеПоля присутствуют в блоке и приходят со значением null

Оценка эффективности — `evaluation`

Поле Тип Описание
ПолеefficiencyValue Типnumber ОписаниеОбщая эффективность встречи, от 0 до 100
Полеcalendar Типnull ОписаниеПоле присутствует в блоке и приходит со значением null
Полеcriteria Типobject ОписаниеКарта критериев. Ключ — код критерия, например communicationClear. Набор кодов зависит от типа встречи
Полеcriteria.<код>.value Типboolean ОписаниеВыполнен ли критерий
Полеcriteria.<код>.title Типstring ОписаниеНазвание критерия
Полеcriteria.<код>.criteria Типstring ОписаниеФормулировка критерия
Полеcriteria.<код>.thoughts Типstring ОписаниеОбоснование оценки

Пример ответа

Ответ на запрос из примеров выше. Упоминания идут чистым текстом, потому что запрошен mentionFormat=none, поэтому actionItem и actionItemMentionLess совпадают. С bb или html в actionItem имя исполнителя обёрнуто в разметку упоминания.

JSON
{
  "success": true,
  "data": {
    "item": {
      "callId": 1204,
      "callType": 1,
      "chatId": 3150,
      "initiatorId": null,
      "startDate": "2026-03-12T10:00:00+00:00",
      "endDate": "2026-03-12T10:30:40+00:00",
      "durationSeconds": 1840,
      "uuid": "01jc9m4x7k2p8q3r5s6t7v8w9y",
      "language": "ru",
      "version": 3,
      "participants": [
        { "userId": 7, "talkedSeconds": 1100, "name": "Иван Петров", "avatar": "https://example.bitrix24.ru/upload/avatar.png", "workPosition": "Руководитель проекта" },
        { "userId": 42, "talkedSeconds": 740, "name": "Мария Иванова", "avatar": "https://example.bitrix24.ru/upload/avatar-2.png", "workPosition": "Аналитик" }
      ],
      "outcomes": ["transcription", "overview", "summary", "insights", "evaluation"],
      "createdAt": "2026-03-12T10:52:10+00:00",
      "tracks": [
        {
          "trackId": 310,
          "type": "record",
          "fileId": 52011,
          "diskFileId": 18470,
          "duration": 1835,
          "fileName": "Запись звонка от 2026-03-12.m4a",
          "fileSize": 7340032,
          "mimeType": "audio/mp4",
          "callId": 1204,
          "relUrl": "/bitrix/services/main/ajax.php?action=FILE_ACTION&fileId=52011",
          "url": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=FILE_ACTION&fileId=52011",
          "dateCreate": "2026-03-12T10:31:15+00:00"
        }
      ],
      "transcription": {
        "language": "ru",
        "segments": [
          { "userId": 7, "userName": "Иван Петров", "start": "00:05", "end": "00:18", "text": "Пройдёмся по статусам задач." },
          { "userId": 42, "userName": "Мария Иванова", "start": "00:19", "end": "00:41", "text": "Две задачи выполнены, одна в работе, дедлайн у неё в пятницу." }
        ]
      },
      "overview": {
        "topic": "Статус задач команды",
        "detailedTakeaways": "Команда сверила статусы задач: две выполнены, одна в работе. Дедлайн оставшейся задачи — пятница.",
        "meetingType": {
          "explanation": "Участники сверяли статусы задач и сроки.",
          "typeTag": "status_meeting",
          "title": "Встреча по статусу задач"
        },
        "agenda": {
          "explanation": "Статусы задач и дедлайны на неделю.",
          "quote": "Пройдёмся по статусам задач."
        },
        "agreements": [
          { "agreement": "Задачу в работе закрываем до пятницы", "quote": "Давайте закроем её до пятницы." }
        ],
        "actionItems": [
          {
            "actionItem": "Иван Петров закроет задачу по отчёту до пятницы",
            "actionItemMentionLess": "Иван Петров закроет задачу по отчёту до пятницы",
            "quote": "Задачу по отчёту закрою до пятницы."
          }
        ],
        "meetings": null
      },
      "summary": {
        "segments": [
          { "start": "00:00", "end": "12:30", "title": "Статусы задач", "summary": "Сверили статусы: две задачи выполнены, одна в работе." },
          { "start": "12:31", "end": "30:40", "title": "Дедлайны", "summary": "Подтвердили дедлайн задачи в работе и назначили ответственного." }
        ]
      },
      "insights": {
        "speakerEvaluationAvailable": true,
        "speakerAnalysis": [
          {
            "detailedInsight": "Участник вёл встречу, сверил статусы задач и зафиксировал дедлайны.",
            "evaluationCriteria": {
              "politeness": { "value": true, "criteria": "Вежливость", "title": "Вежливое общение" },
              "positiveAttitude": { "value": true, "criteria": "Позитивный настрой", "title": "Позитивный настрой участника" },
              "staysOnTopic": { "value": true, "criteria": "Следование теме", "title": "Следует теме" },
              "communicationClarity": { "value": true, "criteria": "Ясность коммуникации", "title": "Ясно излагает" },
              "individualContribution": { "value": true, "criteria": "Индивидуальный вклад", "title": "Вклад в обсуждение" },
              "timeManagementConciseness": { "value": false, "criteria": "Краткость и тайм-менеджмент", "title": "Краткость" }
            },
            "userId": 7,
            "efficiencyValue": 88,
            "talkPercentage": 60,
            "duration": 1100,
            "durationFormat": "18 мин"
          }
        ],
        "meetingStrengths": null,
        "meetingWeaknesses": null,
        "speechStyleInfluence": null,
        "engagementLevel": null,
        "areasOfResponsibility": null,
        "finalRecommendations": null
      },
      "evaluation": {
        "efficiencyValue": 92,
        "calendar": null,
        "criteria": {
          "meetingSummarized": {
            "value": true,
            "criteria": "Подведение итогов",
            "thoughts": "В конце встречи ведущий перечислил задачи, их статусы и дедлайны.",
            "title": "Итоги подведены"
          },
          "communicationClear": {
            "value": true,
            "criteria": "Ясность коммуникации",
            "thoughts": "Участники формулировали задачи с конкретными сроками.",
            "title": "Ясная коммуникация"
          }
        }
      }
    }
  }
}

Пример ответа при ошибке

403 — фоллоуапа с таким номером нет или он принадлежит другому пользователю:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Нет доступа к данным Follow-up"
  }
}

Текст error.message приходит от Битрикс24, его язык зависит от языка портала. Ветвитесь по error.code, а не по тексту сообщения.

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеfollowupId в пути — не положительное целое число
HTTP400 КодINVALID_PARAMS ОписаниеНеизвестное поле в select, mentionFormat вне bb, html, none или другой query-параметр
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеКлюч в заголовке X-Api-Key не найден
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет токенов портала. Ключ OAuth-приложения требует заголовок Authorization: Bearer
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа syncconnector
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеФоллоуапа с таким номером нет, он принадлежит другому пользователю или Битрикс24 отказал в доступе к данным Синка. Разбор причин по типу ключа — Ошибки
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеНа портале нет нужного обновления. error.release равен syncconnector 26.100.0; rest >= 26.1300.0
HTTP422 КодBITRIX_ERROR ОписаниеДругой отказ Битрикс24. Причина — в error.message

Полный список общих ошибок API — Ошибки.

Известные особенности

Доступны только встречи владельца ключа. Метод возвращает фоллоуап встречи пользователя, от имени которого идёт запрос: владельца личного ключа или пользователя сессии OAuth-приложения. Администратор портала тоже получает только свои встречи. Приложение на личном ключе показывает всем своим пользователям встречи владельца ключа.

Номер фоллоуапа не совпадает с номером звонка. followupId не принимает идентификатор обычного звонка и не сопоставляется с callId Follow-up по одному звонку.

Смотрите также