Перейти к основному содержимому

Получение отчета

Обновлено: 1 октября 2025

Метод вызывается для получения отчета. Если отчет еще не построен, то сервер вернет ошибку 425, тогда запрос следует повторить позднее.

Если отчет построен, то сервер вернет отчет в JSON-формате.

URL-адрес подключения​

Для получения отчета выполняется GET-запрос на URL-адрес:

http://gate.example.com:port/messages/report,

где gate.example.com — адрес edna Prisma.

Параметры запроса​

В запросе передается только идентификатор запроса id, который был возвращен в методе построения отчета.

ПараметрТип данныхХарактерОписание
idNumberОбязательныйИдентификатор запроса, полученный при построении отчета

Параметры ответа​

ПараметрТип данныхХарактерОписание
detailsStringОбязательныйСтатус обработки запроса: OK или NOT_FOUND
recordsArray of objectsОбязательныйМассив записей отчета. Каждая запись содержит поля, указанные ниже

Поля записи отчета​

ПараметрТип данныхХарактерОписание
idNumberОбязательныйИдентификатор сообщения
sentAtStringОбязательныйДата и время отправки сообщения в формате dd-MM-yyyy HH:mm:ss
subjectStringОбязательныйПодпись сообщения
cnrCodeStringОбязательныйКод канала
addressStringОбязательныйНомер абонента
operatorStringОбязательныйОператор связи
countryStringОбязательныйСтрана
dlvStatusStringОбязательныйСтатус доставки сообщения
dlvErrorStringНеобязательныйОписание ошибки доставки (если есть)
dlvStatusAtStringОбязательныйДата и время изменения статуса доставки в формате dd-MM-yyyy HH:mm:ss
broadcastNameStringОбязательныйНазвание рассылки
broadcastSentAtStringОбязательныйДата и время начала рассылки
broadcastEndAtStringОбязательныйДата и время окончания рассылки
priorityStringОбязательныйПриоритет сообщения
cnrTypeStringОбязательныйТип интеграции (коннектор для подключения к сервисам edna)
textStringОбязательныйТекст сообщения
totalCountStringОбязательныйКоличество сегментов в SMS-сообщении
tmpITypeStringОбязательныйТип сообщения

Пример запроса​

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": []
}