Create

Метод Create

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

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
name string название голосового сообщения (SMS)
media_id uint64 идентификатор аудиофайла, загруженного в аудиобиблиотеку этого приложение — его услышит принимающий абонент после поднятия трубки
redirect_info RedirectInfo настройка переадресации вызова

RedirectInfo

Параметр Тип Описание
digit uint32 клавиша, на которую принимающему абоненту нужно нажать, чтобы соединиться с оператором: от 0 до 9 (по умолчанию: 0)
redirect_number string номер для переадресации в формате 79999999999 (9—14 цифр)

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

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

Параметр Тип Описание
id string идентификатор ресурса голосового SMS

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

Код Статус Пример сообщения Описание
400 Bad Request failed to parse token неправильно указан токен (API-ключ приложения)
401 Unauthorized error getting JWT Token claims ошибка при парсинге JWT claims (части API-ключа, отвечающие за информацию о пользователе/приложении)
403 Forbidden error":“Customer is not in correct status” ошибка возникает, если не удается создать услугу голосового SMS из-за статуса аккаунта пользователя (не активирован/заблокирован)
404 Not Found error getting media resource не найден аудиофайл, id которого используется для создания услуги голосового SMS

Примеры

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

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

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

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

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