MakeVoiceMessage

Метод MakeVoiceMessage

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

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

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

Авторизация

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

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

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

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

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

  • service_id — если хотите проиграть принимающим абонентам предзаписанное аудио и уже создали для него ресурс голосового SMS в Личном кабинете или с помощью API-метода Create
  • tts — если хотите синтезировать речь по заданным параметрам в режиме онлайн
Параметр Тип Описание
source string номер, с которого осуществится обзвон
destination string номер принимающего абонента
service_id string идентификатор ресурса голосового сообщения (для предзаписанного аудио)
tts TTS параметры синтеза речи для аудиосообщения абоненту

TTS

Параметр Тип Описание
text string текст синтезируемой речи (от 1 до 1000 символов, кодировка не учитывается)
voice Voice голос для озвучивания текста
lang Lang язык синтезируемой речи
volume int32 нормализация громкости (от -145 до 0, где -145 — наименьшее усиление, 0 — наибольшее усиление громкости; по умолчанию -19)
speed float скорость синтезируемой речи (от 0.1 до 3.0, где 0.1 — самая медленная, 3.0 — самая быстрая; по умолчанию 1.0)
emotion Emotion эмоция для озвучивания текста
SynthesisSettings

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

Параметр Тип Голос (Voice) Пол Эмоция (Emotion) Язык (Lang)
1 enum Алёна (по умолчанию) Ж 1 — нейтральная (по умолчанию), 2 — добрая 1 — русский
2 enum Ермил М 1 — нейтральная (по умолчанию), 2 — радостная 1 — русский
3 enum Джейн Ж 1 — нейтральная (по умолчанию), 2 — радостная, 3 — раздраженная 1 — русский
4 enum Омаж Ж 1 — нейтральная (по умолчанию), 3 — раздраженная 1 — русский
5 enum Захар М 1 — нейтральная (по умолчанию), 2 — радостная 1 — русский
8 enum Даша Ж 1 — нейтральная (по умолчанию), 2 — радостная, 4 — дружелюбная 1 — русский
9 enum Юлия Ж 1 — нейтральная (по умолчанию), 5 — строгая 1 — русский
10 enum Лера Ж 1 — нейтральная (по умолчанию), 4 — дружелюбная 1 — русский
11 enum Марина Ж 1 — нейтральная (по умолчанию), 4 — дружелюбная, 6 — шёпот 1 — русский
12 enum Александр М 1 — нейтральная (по умолчанию), 2 — радостная 1 — русский
13 enum Кирилл М 1 — нейтральная (по умолчанию), 2 — радостная, 5 — строгая 1 — русский
14 enum Антон М 1 — нейтральная (по умолчанию), 2 — радостная 1 — русский
15 enum Маша Ж 2 — радостная (по умолчанию), 4 — дружелюбная, 5 — строгая 1 — русский

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

Параметр Тип Описание
call_id string уникальный идентификатор отправленного голосового сообщения

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

Код Статус Пример сообщения Описание
400 Bad Request the client can only call to his own confirmed number попытка отправки голосового SMS на не подтвержденный номер во время пробного периода аккаунта
400 Bad Request Validation error. Please enter valid parameter values. не правильно указаны параметры запроса
401 Unauthorized malformed token не указан / не правильно указан 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"
}

Содержание статьи