Create

Метод 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 номер для переадресации (9 - 14 символов)

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

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

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

Код Статус Пример сообщения Описание
400 Bad Request failed to parse token неправильно указан токен (API-ключ приложения)
401 Unauthorized error getting JWT Token claims ошибка при парсинге JWT claims (части API-ключа, отвечающие за информацию о пользователе/приложении)
500 Internal Server Error error getting customer status ошибка подключения к аккаунту пользователя
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"
}

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