Метод GetInfo
Примените метод GetInfo для получения информации о ресурсе голосового SMS по его идентификатору.
Точка подключения: Выполните 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 | идентификатор ресурса голосового SMS |
| name | sting | название ресурса голосового SMS |
| digit | uint32 | клавиша, на которую принимающий абонент должен нажать в тональном режиме, чтобы его перевели на оператора |
| redirect_number | string | номер оператора, на которого будет переведён абонент |
| media_id | uint64 | идентификатор аудиофайла, который услышит абонент |
| created_at | string | дата создания ресурса голосового SMS в формате RFC-3339 / ISO-8601 |
Примеры
Входные параметры:
{
"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"
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 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 | Scenario not found | ID приложения запроса не соответствует ID в API-ключе |