MakeVoiceMessage

Метод MakeVoiceMessage

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


Совет: увеличьте конверсию в дозвон и срок службы номеров с помощью услуги «Карусель». Платформа МТС Exolve будет автоматически менять номер при каждом исходящем звонке — по порядку или случайным образом. Для этого создайте карусель и передайте её авторизационный номер в параметре “source” метода MakeVoiceMessage. Подробнее — в этой инструкции.


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

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

Авторизация

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

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

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

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


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

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

ПараметрТипОписание
sourcestringномер, с которого осуществится обзвон, или авторизационный номер карусели
destinationstringномер принимающего абонента
service_idstringидентификатор ресурса голосового SMS (для предзаписанного аудио)
ttsTTSпараметры синтеза речи для аудиоинформирования абонента

TTS

ПараметрТипОписание
textstringтекст синтезируемой речи (от 1 до 1000 символов, кодировка не учитывается)
voiceVoiceголос для озвучивания текста
langLangязык синтезируемой речи
volumeint32нормализация громкости (от -145 до 0, где -145 — наименьшее усиление, 0 — наибольшее усиление громкости; по умолчанию -19)
speedfloatскорость синтезируемой речи (от 0.1 до 3.0, где 0.1 — самая медленная, 3.0 — самая быстрая; по умолчанию 1.0)
emotionEmotionэмоция для озвучивания текста

SynthesisSettings


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


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

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

ПараметрТипОписание
call_idstringидентификатор отправленного голосового SMS (звонка)

Примеры

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

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

{
  "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
        }
}

Звонок с автоматической ротацией номеров (каруселью)

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

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

{
    "call_id": "7374422070618357761"
}

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

КодСтатусПример сообщенияОписание
400Bad Requestthe client can only call to his own confirmed numberпопытка отправки голосового SMS на не подтвержденный номер во время тестового периода аккаунта
400Bad RequestValidation error. Please enter valid parameter values.неправильно указаны параметры запроса
401Unauthorizedmalformed tokenне указан / неправильно указан API-ключ приложения