Получить Follow-up звонка call.followup.get

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

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

Scope: call

Кто может выполнять метод: пользователь с доступом к звонку

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

Метод call.followup.get возвращает Follow-up одного звонка по идентификатору.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

callId*
integer

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

Идентификатор можно получить методом call.followup.list

select
array

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

Если параметр не передан, метод возвращает все поля из раздела Корневой объект. Отсутствующие данные имеют значение null.

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

Если передан список полей, метод возвращает только перечисленные поля и всегда добавляет callId. Полный список полей смотрите в статье Поля Follow-up звонков

mentionFormat
string

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

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

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

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

Примеры кода

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"callId":12345,"mentionFormat":"html"}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/call.followup.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"callId":12345,"mentionFormat":"html","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/call.followup.get

// 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 FollowUpGetResult = {
  item: {
    callId: number
    callType?: number
    chatId?: number | null
    initiatorId?: number
    startDate?: string
    endDate?: string
    durationSeconds?: number
    uuid?: string
    language?: string
    version?: number
    participants?: unknown[]
    outcomes?: string[]
    createdAt?: string
    tracks?: unknown[]
    transcription?: unknown
    overview?: unknown
    summary?: unknown
    insights?: unknown
    evaluation?: unknown
  }
}

try {
  const response = await $b24.actions.v3.call.make<FollowUpGetResult>({
    method: 'call.followup.get',
    params: {
      callId: 12345,
      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.item)
  }
} 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 getFollowUp() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

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

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

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

try {
    $response = $b24Service
        ->core
        ->call(
            'call.followup.get',
            [
                'callId' => 12345,
                '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.get',
    {
        callId: 12345,
        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.get',
    [
        'callId' => 12345,
        'mentionFormat' => 'html',
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "call.followup.get", b24.Params{
	"callId":        12345,
	"mentionFormat": "html",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("call.followup.get: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "callId": 12345,
            "callType": 1,
            "chatId": 2048,
            "initiatorId": 7,
            "startDate": "2026-01-15T10:00:00+00:00",
            "endDate": "2026-01-15T10:42:00+00:00",
            "durationSeconds": 2520,
            "uuid": "bb085e5d-5160-4a63-9ac4-152248046c39",
            "language": "ru",
            "version": 3,
            "participants": [ /* ParticipantDto */ ],
            "outcomes": ["transcription", "overview", "summary", "insights", "evaluation"],
            "createdAt": "2026-01-15T11:05:00+00:00",
            "tracks": [ /* TrackDto */ ],
            "transcription": { "language": "ru", "segments": [ /* TranscriptionSegmentDto */ ] },
            "overview": { "topic": "Планирование спринта", "actionItems": [ /* ... */ ] },
            "summary": { "segments": [ /* SummarySegmentDto */ ] },
            "insights": { "speakerEvaluationAvailable": true, "speakerAnalysis": [ /* ... */ ] },
            "evaluation": { "efficiencyValue": 75, "criteria": { /* ... */ } }
        }
    },
    "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

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

item
object

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

time
time

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

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

HTTP-статус: 403

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

Название
тип

Описание

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

Код ошибки: access_denied

Поле

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

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

callId

Нет доступа к данным Follow-up

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

Ошибки нахождения данных

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле

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

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

callId

Звонок не найден

Передайте существующий идентификатор звонка. Для пользователя без прав на звонок метод вернет ошибку доступа

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

Код ошибки: invalid_select_field

Поле

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

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

select

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

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

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

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

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

callId

Не передан обязательный параметр или передан неверный тип

Передайте callId как целое число

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

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

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

Предыдущая
Получить список Follow-up
Следующая
Получить список полей Follow-up