#Запустить автозвонок с синтезом речи

POST /v1/calls/auto-call

Набирает toNumber и после принятия звонка воспроизводит синтезированный текст (textToPronounce). Оператор не задействован. Применяется для автоматических уведомлений, напоминаний и роботизированных обзвонов.

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

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

#Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/calls/auto-call \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fromLine": "YOUR_LINE_ID",
    "toNumber": "+79161234567",
    "textToPronounce": "Здравствуйте! Ваш заказ готов к выдаче."
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/calls/auto-call \
  -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",
    "textToPronounce": "Здравствуйте! Ваш заказ готов к выдаче."
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calls/auto-call', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fromLine: 'YOUR_LINE_ID',
    toNumber: '+79161234567',
    textToPronounce: 'Здравствуйте! Ваш заказ готов к выдаче.',
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calls/auto-call', {
  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',
    textToPronounce: 'Здравствуйте! Ваш заказ готов к выдаче.',
  }),
})

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

#Поля ответа

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

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

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

JSON 
{
  "success": true,
  "data": {
    "RESULT": true,
    "CALL_ID": "infocall.a3f2c1e4b8d06f7a9e2c5d1b4f8a3e06.1777974900"
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: fromLine (string — ID from GET /v1/voximplant-lines), toNumber (string), textToPronounce (string)"
  }
}

#Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не передан fromLine, toNumber или textToPronounce
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 — Ошибки.

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

Голос по умолчанию. Если voice не указан, Битрикс24 использует голос, соответствующий языку портала. Для русскоязычных порталов — ruinternalfemale. Полный список доступных голосов — `GET /v1/calls/voices`.

Превышение месячного лимита. При исчерпании квоты автозвонков Битрикс24 возвращает BITRIX_ERROR с сообщением "Infocall limit for this month is exceeded". Квота обновляется в начале следующего расчётного периода.

Базовая линия не поддерживается. Попытка использовать базовую линию портала вместо выделенной возвращает BITRIX_ERROR: "Making infocall using LINK_BASE_NUMBER is not allowed".

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

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