Деловая связь без лишних сложностей
Приложения для телефона и компьютераРазработчикамIllyVoIP StatusСправочный центр

Voice API

Ваша логика.
Ваш звонок.
Ваше управление.

Добавьте голосовую связь в приложение. Создавайте и принимайте вызовы, воспроизводите аудио, собирайте ответы и управляйте дальнейшими действиями через API IllyVoIP.

Изучить APIПосмотреть запрос

Составляющие
голосового сценария.

Используйте отдельные действия для управления текущим звонком или выполняйте упорядоченную цепочку одним запросом.

Создание и ответ

Начинайте исходящие вызовы или отвечайте на входящие, направленные в Voice API Control.

Открыть документацию

Речь и ответы

Воспроизводите аудио, озвучивайте текст и получайте голосовой ответ или ввод с клавиатуры.

Открыть документацию

Управление разговором

Переводите звонок, ставьте на удержание и возобновляйте его, отправляйте DTMF или завершайте вызов по логике приложения.

Открыть документацию

Цепочка действий на практике

Говорите.
Слушайте.
Продолжайте сценарий.

Этот запрос произносит приветствие и получает голосовой ответ в существующем звонке. Как использовать результат, решает ваше приложение.

Аутентификация
X-Api-Key
Формат запроса
application/json
Обязателен для этого метода
Idempotency-Key

Замените заполнители учётными данными серверного приложения и действительной сессией управления звонком. Повторно используйте ключ идемпотентности только для идентичного запроса.

Документация цепочек действий
Тело запроса · JSON
POST/api/v1/voice/call-control/execute
{
  "call_control_id": "YOUR_CALL_CONTROL_ID",
  "actions": [
    {
      "type": "speak",
      "text": "Welcome to our support line."
    },
    {
      "type": "gather",
      "input": "speech",
      "prompt_text": "How can we help?",
      "speech_language": "en-US",
      "timeout_ms": 8000,
      "save_as": "request"
    }
  ]
}

Входящие звонки

Ваш номер.
Ответ вашего приложения.

Направьте номер IllyVoIP в Voice API Control. Подпишитесь на событие входящего вызова, ответьте на доступный для управления звонок и используйте полученный call-control ID для следующих действий.

Руководство по входящим звонкам
Телефонный номерМаршрутизация в Voice API Control
Событие входящего вызоваcall_ringing
Ваше приложениеОтвет → управление звонком

Вебхуки

Пусть события звонков
запускают ваши процессы.

Получайте события жизненного цикла вызова на адрес своего приложения. Обновляйте записи, отслеживайте ход звонка или запускайте следующий шаг в своей системе.

Изучить вебхуки
call_initiatedcall_ringingcall_answeredcall_completed

Проверяйте подписи, своевременно подтверждайте получение и исключайте дубликаты по ID события. При повторных попытках доставки событие может прийти снова.

Выберите,
как построить решение.

Используйте управление звонками для логики приложения и подключайте другие нужные инструменты.

Webphone SDK

Добавьте звонки из браузера в свой интерфейс через документированный SDK с краткосрочными токенами аутентификации.

Документация SDK

Перед первой
интеграцией.

Спросить команду
Voice API — это SIP-транк?+

Нет. SIP соединяет телефонную систему или платформу. Voice API предоставляет операции управления вызовом, которые запрашивает приложение: озвучивание текста, сбор ответов, перевод звонка и другие.

Поддерживаются входящие и исходящие?+

Да. В документации описаны создание исходящих и ответ на входящие. Для входящих направьте номер в Voice API Control и следуйте сценарию события call_ringing и ответа.

Можно получать голос и ввод с клавиатуры?+

Да. Метод gather поддерживает речь и DTMF. По документации выберите поддерживаемый тип ввода, язык и время ожидания для сценария.

Можно работать с речью вне звонка?+

Да. В справочнике есть отдельные методы speech-to-text и text-to-speech для преобразования аудио в текст и обратно. Во время звонка используйте операции Voice API gather и speak.

Как оплачиваются речевые функции?+

Текущие тарифы распознавания и синтеза речи опубликованы в кабинете. Voice API применяет их к gather и speak. Проверьте действующие тарифы и соответствующую стоимость голосовой связи.

Где хранить API-ключ?+

Храните API-ключи аккаунта на стороне серверного приложения. Для звонков из браузера используется документированный процесс Webphone SDK с краткосрочными токенами, а не открытый API-ключ аккаунта.

Можно изучить API до подключения приложения?+

В кабинете есть справочник методов, примеры запросов и ответов, спецификация OpenAPI и API Playground. Запросы Playground могут выполнять реальные операции — проверяйте выбранный запрос перед запуском.

Создайте сценарий звонка,
нужный вашему приложению.

Начните со справочника методов и актуальных примеров запросов.

Открыть документацию Voice APIСвязаться с командой