Skip to content

Make call

Создать звонок для трансфера или консультации

Метод make.call
Версия API v4.0
Описание Создать звонок для трансфера или консультации
Вернуться к списку методов

Метод доступен для использования только после вызова "hold.call", см. раздел "Диаграмма состояний звонка"

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
call_session_id number да Уникальный идентификатор сессии звонка, который может быть получен в ответном сообщении при вызове методов start.informer_call, start.vnumber_call, start.scenario_call, start.employee_call, с помощью сервера уведомлений или DATA API.
to string да

Номер абонента на который совершаем звонок. Формат номера должен соответствовать международному стандарту E.164

Может быть внутренний номер, внешний номер, номер сотрудника, sip-номер
Сообщение для проигрывания абоненту, который задан в параметре to
to_message object нет

Определяет параметры сообщения, которое необходимо проиграть абоненту заданному в параметре to_message.

Абонент, который стоит на удержании, будет ожидать ответа, пока не будет прослушано сообщение до конца
type string да media, tts

Определяет тип сообщения. media - файл или tts - текст для услуги синтеза речи Text-to-Speech.
value string да

Если поле type имеет значение media, то в качестве значения принимается идентификатор файла для проигрывания. Файл для проигрывания может быть системным или пользовательским. Идентификатор файла для проигрывания можно получить с помощью DATA API - Получение списка пользовательских файлов, Получение списка системных файлов

Если поле type имеет значение tts, то в качестве значения принимается текст для синтезирования его в голосовое сообщение.

Длина TTS сообщения регулируется тарифным планом и установленным лимитом.

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

{
  "jsonrpc": "2.0",
  "method": "make.call",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
    "call_session_id": 2354891,
    "to": "79260000000"
  }
}

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

{
  "jsonrpc": "2.0",
  "id": "req1",
  "result": {
    "data": {
      "success": "true"
    }
  }
}

Список возвращаемых ошибок

Текст ошибки Код ошибки Мнемоника ошибки Описание
This method can not be called in this state -32004 invalid_state Метод может быть вызван только после метода hold.call
The character encoding must be UTF-8 -32602 character_encoding_not_allowed
The phone number does not exist or inactive -32602 no_active_phone_number У сотрудника могут отсутствовать активные номера

См. также раздел "Список ошибок общих для всех методов"