Voice API

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

Методы Voice API для управления ресурсами голосовых SMS:

• Create — создаёт ресурс голосового SMS;
• Delete — удаляет ресурс голосового SMS;
• Update — изменяет настройки ресурса голосового SMS;
• GetList — получает список всех голосовых SMS приложения;
• GetInfo — получает информацию о ресурсе голосового SMS;
• MakeVoiceMessage — отправляет голосовое SMS абоненту;
• GetInfo — получает информацию об отправленном голосовом SMS.

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

Голосовые SMS

Обратный звонок

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

Метод Create

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

Примените метод Create для создания ресурса голосового SMS.

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

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

Авторизация

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

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

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

RedirectInfo

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

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

Примеры

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

{
    "name": "Сезонная распродажа 30%",
    "media_id": "1967",
     "redirect_info": {
        "digit": 5,
        "redirect_number": "79295800000"
    }
}

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

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

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

Метод GetList

Примените метод GetList для получения списка ресурсов голосовых SMS по заданным параметрам.

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

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

Авторизация

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

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

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

VoiceMessages

Примеры

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

{
    "limit": "10",
    "offset": "0"
}

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

{
    "voice_messages": [
        {
            "id": "8ef688fb-915f-4f31-9ab7-9560b8a39280",
            "name": "Голосовое сообщение 1",
            "created_at": "2026-06-28T19:01:58.452Z"
        },
        {
            "id": "9a726975-4aa3-4a48-9b05-31a0c4967eca",
            "name": "Голосовое сообщение 2",
            "created_at": "2026-06-28T19:30:55.107Z"
        }
    ],
    "total": "2"
}

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

Метод GetInfo

Примените метод GetInfo для получения информации о ресурсе голосового SMS по его идентификатору.

Точка подключения: Выполните 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": "2024-12-22T11:19:36.567Z"
}

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

Метод Delete

Примените метод 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).

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

Точка подключения: Выполните 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
        }
}

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

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

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

{
    "call_id": "7374422070618357761"
}

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

Метод GetInfo

Примените метод GetInfo для получения статистики об отправленном голосовом SMS (звонке).

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

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

Авторизация

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

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

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

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

Status

Примеры

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

{
    "call_id": "7374422070618357761"
}

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

{
    "call_id": "7374422070618357761",
    "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"
}

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