GetInfo (голосовое SMS)

Метод GetInfo

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

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

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

Авторизация

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

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

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

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

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

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

Параметр Тип Описание
id string уникальный идентификатор услуги голосового сообщения
name sting название услуги голосового сообщения
digit uint32 цифра, на которую надо нажать, чтобы прошла переадресация
redirect_number string номер для переадресации (9 - 14 символов)
media_id uint64 уникальный идентификатор аудиофайла, который услышат клиенты, когда поднимут трубку
created_at string дата создания услуги голосового сообщения в формате RFC-3339 / ISO-8601

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

Код Статус Пример сообщения Описание
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 Scenario not found ID приложения запроса не соответствует ID в API-ключе

Примеры

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

{ 
    "id": "14b8d7b3-5468-418f-8592-b1d2127ad36b"
}

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

{
            "id": "14b8d7b3-5468-418f-8592-b1d2127ad36b",
            "name": "test",
            "digit": 5,
            "redirect_number": "79269999999",
            "media_id": 1979,
            "created_at": "2022-12-22T11:19:36.567Z"
}

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