Завершить звонок и зафиксировать его в статистике telephony.externalCall.finish
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
telephonyКто может выполнять метод: любой пользователь
Метод telephony.externalCall.finish завершает внешний звонок, сохраняет его в статистике и в CRM-деле.
Метод работает только в контексте приложения
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
CALL_ID* |
Идентификатор звонка из метода telephony.externalCall.register |
|
USER_ID* |
Идентификатор пользователя, который завершает звонок. Пользователь также назначается ответственным за CRM-объекты, которые были автоматически созданы в рамках звонка. Для ранее существовавших CRM-объектов ответственный не изменяется. Идентификатор можно получить методом user.get |
|
USER_PHONE_INNER* |
Внутренний номер пользователя. Внутренний номер можно получить методом user.get Необходимо указать хотя бы один из параметров: |
|
DURATION |
Длительность звонка в секундах. По умолчанию — |
|
COST |
Стоимость звонка. По умолчанию — |
|
COST_CURRENCY |
Валюта стоимости звонка. Список валют можно получить методом crm.currency.list. По умолчанию — пустая строка |
|
STATUS_CODE |
Код результата звонка. Возможные значения:
По умолчанию:
|
|
FAILED_REASON |
Текст причины несостоявшегося звонка. По умолчанию — пустая строка |
|
RECORD_URL |
URL записи звонка. Параметр устарел и оставлен для обратной совместимости. Рекомендуется использовать telephony.externalCall.attachRecord |
|
VOTE |
Оценка звонка. Возможные значения:
Если оценка отсутствует — |
|
ADD_TO_CHAT |
Добавлять сообщение о звонке в чат сотрудника. Возможные значения:
По умолчанию — |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CALL_ID":"externalCall.716f1cb73def9700a23842adf9c4c568.1773130779","USER_ID":1269,"DURATION":95,"STATUS_CODE":"200","VOTE":5,"ADD_TO_CHAT":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/telephony.externalCall.finish
try
{
const response = await $b24.callMethod(
'telephony.externalCall.finish',
{
CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
USER_ID: 1269,
DURATION: 95,
STATUS_CODE: '200',
VOTE: 5,
ADD_TO_CHAT: 0
}
);
const result = response.getData().result;
console.log('Call finished:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'telephony.externalCall.finish',
[
'CALL_ID' => 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
'USER_ID' => 1269,
'DURATION' => 95,
'STATUS_CODE' => '200',
'VOTE' => 5,
'ADD_TO_CHAT' => 0
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error finishing call: ' . $e->getMessage();
}
BX24.callMethod(
"telephony.externalCall.finish",
{
CALL_ID: 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
USER_ID: 1269,
DURATION: 95,
STATUS_CODE: '200',
VOTE: 5,
ADD_TO_CHAT: 0
},
function(result)
{
if (result.error())
{
console.error(result.error(), result.error_description());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'telephony.externalCall.finish',
[
'CALL_ID' => 'externalCall.716f1cb73def9700a23842adf9c4c568.1773130779',
'USER_ID' => 1269,
'DURATION' => 95,
'STATUS_CODE' => '200',
'VOTE' => 5,
'ADD_TO_CHAT' => 0
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"CALL_ID": "externalCall.716f1cb73def9700a23842adf9c4c568.1773130779",
"EXTERNAL_CALL_ID": null,
"PORTAL_USER_ID": 1269,
"PHONE_NUMBER": "79062195047",
"PORTAL_NUMBER": "3",
"INCOMING": "2",
"CALL_DURATION": 95,
"CALL_START_DATE": {},
"CALL_STATUS": 1,
"CALL_VOTE": 5,
"COST": 0,
"COST_CURRENCY": "",
"CALL_FAILED_CODE": "200",
"CALL_FAILED_REASON": "",
"REST_APP_ID": "3",
"REST_APP_NAME": "Документация по REST API",
"CRM_ACTIVITY_ID": 7943,
"COMMENT": null,
"CRM_ENTITY_TYPE": "CONTACT",
"CRM_ENTITY_ID": 797,
"ID": 7
},
"time": {
"start": 1773132478,
"finish": 1773132480.301376,
"duration": 2.3013761043548584,
"processing": 2,
"date_start": "2026-03-10T11:47:58+03:00",
"date_finish": "2026-03-10T11:48:00+03:00",
"operating_reset_at": 1773133078,
"operating": 1.4118058681488037
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Данные сохраненной записи звонка |
|
ID |
Идентификатор записи в статистике |
|
CALL_ID |
Идентификатор звонка |
|
EXTERNAL_CALL_ID |
Внешний идентификатор звонка на стороне интеграции |
|
PORTAL_USER_ID |
Идентификатор пользователя Битрикс24, от имени которого завершен звонок |
|
PHONE_NUMBER |
Номер абонента |
|
PORTAL_NUMBER |
Номер линии, через который проходил звонок |
|
INCOMING |
Тип звонка. Возможные значения:
|
|
CALL_DURATION |
Длительность звонка в секундах |
|
CALL_START_DATE |
Дата и время начала звонка |
|
CALL_STATUS |
Статус завершения. Возможные значения:
|
|
CALL_VOTE |
Оценка звонка |
|
COST |
Стоимость звонка |
|
COST_CURRENCY |
Валюта стоимости |
|
CALL_FAILED_CODE |
Код завершения звонка. Возможные значения:
|
|
CALL_FAILED_REASON |
Текстовая причина завершения звонка |
|
REST_APP_ID |
Идентификатор приложения |
|
REST_APP_NAME |
Название приложения |
|
CRM_ACTIVITY_ID |
Идентификатор CRM-дела звонка |
|
COMMENT |
Комментарий к звонку |
|
CRM_ENTITY_TYPE |
Тип объекта CRM, связанного со звонком |
|
CRM_ENTITY_ID |
Идентификатор объекта CRM, связанного со звонком |
|
ERRORS |
Дополнительные ошибки обработки (если возникли) |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "INVALID_ARGUMENT",
"error_description": "CALL_ID must be a string"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Current authorization type is denied for this method |
Метод вызван вне контекста приложения |
|
|
CALL_ID must be a string |
Параметр |
|
|
USER_ID or USER_PHONE_INNER should be set |
Не переданы |
|
|
Call is not found (call should be registered prior to finishing |
Звонок не найден, перед завершением его нужно зарегистрировать методом |
|
|
User is not found or is not active |
Пользователь не найден или неактивен |
|
|
Unexpected database error |
Ошибка сохранения статистики |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Зарегистрировать звонок в Битрикс24 telephony.externalCall.register
- Прикрепить запись к завершенному звонку telephony.externalCall.attachRecord
- Показать карточку звонка пользователю telephony.externalCall.show
- Скрыть карточку звонка у пользователя telephony.externalCall.hide