метод REST scope: call

call.followup.get

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

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

Описание

Метод относится к 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

Примеры запроса

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

Ответ

HTTP-статус: 200

Возвращаемые данные

result object

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

item object

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

time time

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

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

HTTP-статус: 403

{
    "error": {
        "code": "access_denied",
        "message": "Нет доступа к данным Follow-up"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Недостаточно прав доступа: отсутствует необходимый scope Проверьте, что у приложения или вебхука есть scope call

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.