Для AI-агентов: markdown этой страницы — /docs-content/calls/record.md индекс документации — /llms.txt
Запись разговора
POST /v1/calls/:callId/record
Прикладывает аудиозапись к завершённому звонку внешней телефонии. Файл передаётся в теле запроса в base64 или ссылкой на публичный HTTPS-адрес.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрcallId (path) |
Типstring | Обяз.да | ОписаниеID завершённого звонка — поле data.callId из регистрации звонка. Звонок завершается через POST /v1/calls/:callId/finish |
Поля запроса (body)
Передайте fileContent или recordUrl — одно из двух.
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
ПолеfileContent |
Типstring | Обяз.нет | ОписаниеАудиофайл в base64. Обязателен, если не передан recordUrl. До 2 МиБ после декодирования, пустой файл не принимается |
ПолеrecordUrl |
Типstring | Обяз.нет | ОписаниеПубличный HTTPS-адрес файла записи. Обязателен, если не передан fileContent. Адрес не должен содержать логин, пароль и токены доступа и не должен вести во внутреннюю сеть |
ПолеfileName |
Типstring | Обяз.нет | ОписаниеИмя файла с расширением .mp3 или .wav в нижнем регистре. Обязательно вместе с fileContent. С recordUrl по умолчанию берётся последний сегмент пути адреса |
Примеры
curl — личный ключ
curl -X POST 'https://vibecode.bitrix24.tech/v1/calls/externalCall.00000000000000000000000000000000.1700000000/record' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"fileName":"record.wav","fileContent":"UklGRjQAAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YRAAAAAAAAAAAAAAAAAAAAAAAAAA"}'
curl — OAuth-приложение
curl -X POST 'https://vibecode.bitrix24.tech/v1/calls/externalCall.00000000000000000000000000000000.1700000000/record' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"fileName":"record.wav","fileContent":"UklGRjQAAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YRAAAAAAAAAAAAAAAAAAAAAAAAAA"}'
JavaScript — личный ключ
const callId = 'externalCall.00000000000000000000000000000000.1700000000';
const response = await fetch(`https://vibecode.bitrix24.tech/v1/calls/${callId}/record`, {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
fileName: 'record.wav',
fileContent: 'UklGRjQAAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YRAAAAAAAAAAAAAAAAAAAAAAAAAA',
}),
});
const { data } = await response.json();
console.log(data.fileId);
JavaScript — OAuth-приложение
const callId = 'externalCall.00000000000000000000000000000000.1700000000';
const response = await fetch(`https://vibecode.bitrix24.tech/v1/calls/${callId}/record`, {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
fileName: 'record.wav',
fileContent: 'UklGRjQAAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YRAAAAAAAAAAAAAAAAAAAAAAAAAA',
}),
});
const { data } = await response.json();
console.log(data.fileId);
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue при успехе |
Полеdata |
Типobject | ОписаниеРезультат операции |
Полеdata.fileId |
Типinteger | ОписаниеID файла записи, прикреплённого к звонку |
Пример ответа
{
"success": true,
"data": {
"fileId": 10209
}
}
Пример ответа при ошибке
422 — звонок с таким callId не найден или ещё не завершён:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "Call is not found in the statistic table. Looks like it is not finished yet."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеТело запроса — не JSON-объект |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеПереданы одновременно recordUrl и fileContent, либо recordUrl пустой |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеrecordUrl — не HTTPS-адрес, содержит учётные данные или ведёт во внутреннюю сеть |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеfileContent — не base64 или пустой файл |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеfileName не заканчивается на .mp3 или .wav |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеБитрикс24 отклонил значение параметра |
| HTTP400 | КодMISSING_REQUIRED_FIELDS |
ОписаниеНет recordUrl, а fileContent или fileName не передан |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан заголовок X-Api-Key |
| HTTP401 | КодINVALID_API_KEY |
ОписаниеКлюч не найден или отозван |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ ключа нет токенов портала. Ключ OAuth-приложения требует заголовок Authorization: Bearer |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеУ ключа нет скоупа telephony |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлюч выпущен только для чтения |
| HTTP403 | КодBITRIX_ACCESS_DENIED |
ОписаниеБитрикс24 отказал в доступе. Разбор причин — Авторизация, ключи и права |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеБитрикс24 сообщил, что объект не найден |
| HTTP413 | КодPAYLOAD_TOO_LARGE |
ОписаниеФайл больше 2 МиБ после декодирования или тело запроса больше 3 МиБ |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеЗвонок с таким callId не найден или ещё не завершён |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБитрикс24 не вернул ID файла записи |
| HTTP429 | КодLARGE_BODY_BACKEND_BUSY |
ОписаниеСервер обрабатывает другие запросы с большим телом. Повторите запрос с задержкой |
| HTTP429 | КодRATE_LIMITED |
ОписаниеПревышена частота запросов на стороне Битрикс24 |
| HTTP502 | КодBITRIX_UNAVAILABLE |
ОписаниеБитрикс24 недоступен |
| HTTP503 | КодBITRIX_TIMEOUT |
ОписаниеБитрикс24 не ответил вовремя |
Полный список общих ошибок API — Коды ошибок.