Исходящие звонки

Инициация исходящих звонков через инфраструктуру Voximplant: обратный звонок с соединением оператора и клиента, автоматические информационные звонки с синтезом речи или с воспроизведением аудиофайла.

Bitrix24 API: voximplant.callback.start, voximplant.infocall.* Скоуп: telephony

Инициировать обратный звонок

POST /v1/calls/callback

Инициирует обратный звонок: Битрикс24 сначала звонит на линию оператора (fromLine), после принятия звонка соединяет с клиентом (toNumber). Применяется для исходящих звонков из CRM без ручного набора номера.

Поля запроса (body)

Параметр Тип Обяз. По умолч. Описание
fromLine string да — ID линии оператора. Список линий — `GET /v1/voximplant-lines`
toNumber string да — Номер телефона клиента в международном формате

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/calls/callback \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fromLine": "YOUR_LINE_ID",
    "toNumber": "+79161234567"
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/calls/callback \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fromLine": "YOUR_LINE_ID",
    "toNumber": "+79161234567"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calls/callback', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fromLine: 'YOUR_LINE_ID',
    toNumber: '+79161234567',
  }),
})

const { success, data } = await res.json()
const callId = data.callId

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calls/callback', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fromLine: 'YOUR_LINE_ID',
    toNumber: '+79161234567',
  }),
})

const { success, data } = await res.json()
const callId = data.callId

Поля ответа

Поле Тип Описание
result boolean true при успешном инициировании звонка
callId string Идентификатор инициированного звонка с префиксом callback.

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

HTTP 200 — звонок инициирован:

JSON 
{
  "success": true,
  "data": {
    "result": true,
    "callId": "callback.e7804636435209e12c9cef1ec1bcead1.1777974876"
  }
}

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

400 — не переданы обязательные параметры:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: fromLine (string), toNumber (string)"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не передан fromLine или toNumber
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный API-ключ
401 TOKEN_MISSING Ключ не имеет настроенных токенов Битрикс24
401 KEY_INACTIVE API-ключ неактивен или отозван
403 SCOPE_DENIED Ключу не хватает скоупа telephony
422 BITRIX_ERROR Битрикс24 вернул ошибку (сообщение в error.message)
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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

Порядок соединения. Битрикс24 сначала звонит на линию оператора. Звонок клиенту совершается только после того, как оператор принял звонок. Если оператор не отвечает — клиент не будет потревожен.

Префикс callId. Идентификаторы обратных звонков начинаются с callback. — в отличие от зарегистрированных звонков (externalCall.) и информационных (infocall.).

Запись в статистике. После завершения звонок появляется в статистике с CALL_TYPE: "4".

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

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