Получение отчета
Обновлено: 1 октября 2025
Метод вызывается для получения отчета. Если отчет еще не построен, то сервер вернет ошибку 425, тогда запрос сл едует повторить позднее.
Если отчет построен, то сервер вернет отчет в JSON-формате.
URL-адрес подключения
Для получения отчета выполняется GET-запрос на URL-адрес:
http://gate.example.com:port/messages/report,
где gate.example.com — адрес edna Prisma.
Параметры запроса
В запросе передается только идентификатор запроса id, который был возвращен в методе построения отчета.
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
id | Number | Обязательный | Идентификатор запроса, полученный при построении отчета |
Параметры ответа
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
details | String | Обязательный | Статус обработки запроса: OK или NOT_FOUND |
records | Array of objects | Обязательный | Массив записей отчета. Каждая запись содержит поля, указанные ниже |
Поля записи отчета
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
id | Number | Обязательный | Идентификатор сообщения |
sentAt | String | Обязательный | Дата и время отправки сообщения в формате dd-MM-yyyy HH:mm:ss |
subject | String | Обязательный | Подпись сообщения |
cnrCode | String | Обязательный | Код канала |
address | String | Обязательный | Номер абонента |
operator | String | Обязательный | Оператор связи |
country | String | Обязательный | Страна |
dlvStatus | String | Обязательный | Статус дос тавки сообщения |
dlvError | String | Необязательный | Описание ошибки доставки (если есть) |
dlvStatusAt | String | Обязательный | Дата и время изменения статуса доставки в формате dd-MM-yyyy HH:mm:ss |
broadcastName | String | Обязательный | Название рассылки |
broadcastSentAt | String | Обязательный | Дата и время начала рассылки |
broadcastEndAt | String | Обязательный | Дата и время окончания рассылки |
priority | String | Обязательный | Приоритет сообщения |
cnrType | String | Обязательный | Тип интеграции (коннектор для подключения к сервисам edna) |
text | String | Обязательный | Текст сообщения |
totalCount | String | Обязательный | Количество сегментов в SMS-сообщении |
tmpIType | String | Обязательный | Тип сообщения |
Пример запроса
GET http://gate.example.com:port/messages/report?id=1522
Authorization: Basic <credentials>
Пример ответа
{
"details": "OK",
"records": [
{
"id": 12345,
"sentAt": "11-11-2025 23:02:11",
"subject": "Test",
"cnrCode": "channel-hpx-callbacks",
"address": "7917111111",
"operator": "russia-mts",
"country": "Россия",
"dlvStatus": "delivered",
"dlvError": null,
"dlvStatusAt": "11-11-2025 23:02:18",
"broadcastName": null,
"broadcastSentAt": null,
"broadcastEndAt": null,
"priority": "High",
"cnrType": "connector-hpx",
"text": "Какой то текст",
"totalCount": 1,
"tmpIType": null
},
{
"id": 12346,
"sentAt": "11-11-2025 23:02:33",
"subject": "Test",
"cnrCode": "channel-hpx-callbacks",
"address": "7988111111",
"operator": "russia-mts",
"country": "Россия",
"dlvStatus": "delivered",
"dlvError": null,
"dlvStatusAt": "11-11-2025 23:02:46",
"broadcastName": null,
"broadcastSentAt": null,
"broadcastEndAt": null,
"priority": "High",
"cnrType": "connector-hpx",
"text": "Никому не говорите код 5913",
"totalCount": 1,
"tmpIType": "serv"
}
]
}
Обработка ошибок
Если отчет еще не построен, сервер вернет HTTP-статус 425 (Too Early). В этом случае запрос следует повторить позднее.
Если в запросе указан несуществующий идентификатор отчета, шлюз вернет сообщение об ошибке:
{
"details": "NOT_FOUND",
"records": []
}