Voice API

Голосовое SMS — услуга, позволяющая запустить автоматизированный обзвон абонентов с предзаписанной аудиозаписью. Такая рассылка поможет рассказать клиентам об акции, напомнить про мероприятие или сообщить о статусе заказа без помощи менеджера.

Перед отправкой рассылки с помощью метода Create создайте ресурс голосового SMS — настроенный шаблон, к которому можно привязать аудиофайл, предварительно загруженный в аудиобиблиотеку приложения, и установить логику перевода на оператора, если абоненту нужна консультация. В результате вы получите идентификатор этого ресурса — используйте его для звонка на номера ваших абонентов в рамках метода MakeVoiceMessage.

Voice API — программный интерфейс, позволяющий управлять ресурсами голосовых SMS и отправлять голосовые рассылки абонентам. используйте следующие методы:

• Create — создаёт ресурс голосового SMS в приложении;

• GetList — получает список всех голосовых SMS приложения;

• GetInfo — получает информацию о ресурсе голосового SMS;

• Delete — удаляет ресурс голосового SMS приложения;

• MakeVoiceMessage — отправляет голосовое SMS абоненту;

• GetInfo — получает информацию об отправленном голосовом SMS.

Решения, где используется Voice API

Попробовать бесплатно

Метод Create

Голосовое SMS — услуга, позволяющая запустить автоматизированный обзвон абонентов с предзаписанной аудиозаписью. Такая рассылка поможет рассказать клиентам об акции, напомнить про мероприятие или сообщить о статусе заказа без помощи менеджера. Перед отправкой рассылки создайте ресурс голосового SMS — настроенный шаблон, к которому можно привязать аудиофайл, предварительно загруженный в аудиобиблиотеку приложения, и установить логику перевода на оператора, если абоненту нужна консультация. В результате вы получите идентификатор этого ресурса — используйте его для звонка на номера ваших абонентов с помощью метода MakeVoiceMessage

Примените метод Create для создания ресурса голосового SMS. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/voice-message/v1/Create

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

RedirectInfo

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

Выходные параметры

Возможные ошибки

Примеры

Входные параметры:

{
    "name": "Тестовая голосовая SMS",
    "media_id": "1967",
     "redirect_info": {
        "digit":5,
        "redirect_number": "79295800000"
    }
}

Выходные параметры:

{
    "id": "cal55094238-bc5f-4b2d-8a95-5a20d7cbb5bc"
}

Метод GetList

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

Точка подключения:

POST: https://api.exolve.ru/voice-message/v1/GetList

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Пустой JSON

Выходные параметры

VoiceMessageList

Возможные ошибки

Примеры

Входные параметры:

{}

Выходные параметры:

{
    "voice_message_list": [
        {
            "id": "14b8d7b3-5468-418f-8592-b1d2127ad36b",
            "name": "test",
            "created_at": "2022-12-15T10:23:54.912Z"
        },
        {
            "id": "40d781c9-a559-4175-82be-96d5fd4b1ca7",
            "name": "test1",
            "created_at": "2022-12-15T10:29:53.157Z"
        }
    ]
}

Метод GetInfo

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

Точка подключения:

POST: https://api.exolve.ru/voice-message/v1/GetInfo

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Возможные ошибки

Примеры

Входные параметры:

{ 
    "id": "14b8d7b3-5468-418f-8592-b1d2127ad36b"
}

Выходные параметры:

{
            "id": "14b8d7b3-5468-418f-8592-b1d2127ad36b",
            "name": "test",
            "digit": 5,
            "redirect_number": "79269999999",
            "media_id": 1979,
            "created_at": "2022-12-22T11:19:36.567Z"
}

Метод Delete

Примените этот метод для удаления голосового сообщения (SMS). Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/voice-message/v1/Delete

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Возможные ошибки

Выходные параметры

Пустой JSON

Примеры

Входные параметры:

{ 
    "id": "14b8d7b3-5468-418f-8592-b1d2127ad36b"
}

Выходные параметры:

{}

Метод MakeVoiceMessage

Примените метод MakeVoiceMessage для запуска автоматизированного обзвона с предзаписанным аудиосообщением или синтезированной в режиме онлайн речью (TTS — text-to-speech)

Точка подключения: Выполните POST запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/call/v1/MakeVoiceMessage

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

ВАЖНО! Можно указать только один из параметров:

• service_id — если хотите проиграть принимающим абонентам предзаписанное аудио и уже создали для него ресурс голосового SMS в Личном кабинете или с помощью API-метода Create
• tts — если хотите синтезировать речь по заданным параметрам в режиме онлайн

TTS

SynthesisSettings

ВАЖНО! Каждый голос поддерживает определённые параметры языка и эмоции. При формировании API-запроса важно, чтобы выбранный голос был доступен с указанным языком и эмоцией

Выходные параметры

Возможные ошибки

Примеры

Входные параметры

Звонок с предзаписанным аудиофайлом

{
  "source": "74959999999",
  "destination": "79999999999",
  "service_id": "app24226e5c-ce2b-4aa9-aac8-317f8dd42714"
}

Звонок с синтезированием речи в режиме онлайн

{  
  "source": "74959999999",
  "destination": "79999999999",
  "tts": {
          "text": "МТС Exolve — конструктор омниканальных диалогов для бизнеса",
          "voice": 1,
          "lang": 1,
          "volume": -19,
          "speed": 1.1,
          "emotion": 2
        }
}

Выходные параметры:

{
    "call_id": "cal55094238-bc5f-4b2d-8a95-5a20d7cbb5bc"
}

Метод GetInfo

Примените этот метод для получения статистики об отправленном голосовом сообщении (SMS). Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/call/v1/GetInfo

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Status

Возможные ошибки

Примеры

Входные параметры:

{
    "call_id": "caldf32f642-6313-4dae-94db-98502ad3249c"
}

Выходные параметры:

{
    "call_id": "caldf32f642-6313-4dae-94db-98502ad3249c",
    "created": "Wed, 29 Mar 2023 10:32:45 +0000",
    "updated": "Wed, 29 Mar 2023 10:33:07 +0000",
    "started": "Wed, 29 Mar 2023 10:32:58 +0000",
    "ended": "Wed, 29 Mar 2023 10:33:07 +0000",
    "duration": 9,
    "timeout": 60,
    "status": "completed",
    "direction": "outbound",
    "source": "79990557296",
    "destination": "79995556789"
}