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

Получение истории отправленных сообщений

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

Метод отправляет в edna Prisma запрос на получение истории отправленных сообщений. Шлюз возвращает список исходящих сообщений, отсортированных в обратном хронологическом порядке. По умолчанию возвращаются 20 последних отправленных сообщений.

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

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

http://hostname:8555/services/MessageHistoryService,

где hostname — адрес шлюза edna Prisma.

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

Параметры передаются в теле SOAP-конверта внутри тега <soapenv:body>.

ПараметрТип данныхХарактерОписание
clientIdStringОбязательныйУникальный идентификатор клиента
deliveryMethodEnumНеобязательныйКанал отправки:

- sms — SMS-сообщения;

- push — Push-сообщения;

- im — сообщения в мессенджерах;

- ussd — USSD-запросы
offsetIntНеобязательныйКоличество сообщений, которые необходимо пропустить, начиная от наиболее новых. По умолчанию — ноль
maxCountIntНеобязательныйМаксимальное число сообщений в ответе

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

В ответе возвращается список объектов message с атрибутами, приведёнными в таблице ниже.

ПараметрТип данныхХарактерОписание
messageIdStringНеобязательныйВнешний идентификатор сообщения. Выводится, если был указан при отправке сообщения
sentAtDateTimeОбязательныйДата и время отправки сообщения
deliveryMethodEnumОбязательныйКанал отправки:

- sms — SMS-сообщения;

- push — Push-сообщения;

- im — сообщения в мессенджерах;

- ussd — USSD-запросы
deliveryStatusEnumОбязательныйСтатус доставки сообщения (см. таблицу ниже)
sourceStringОбязательныйКод системы — источника (должен быть заведен при настройке шлюза)
messageTypeStringОбязательныйКод типа сообщения (должен быть заведен при настройке шлюза)
textStringОбязательныйТекст сообщения
pushContentStringНеобязательныйПолный текст push-сообщения (только для push-канала)
imContentStringНеобязательныйПолный текст сообщения в мессенджере (только для IM-каналов)

Статусы доставки сообщения​

ЗначениеОписание
gate-initialСообщение находится в очереди на обработку в шлюзе
gate-declinedСообщение отклонено при обработке шлюзом
gate-failedПри обработке сообщения в шлюзе произошла ошибка
gate-cancelledОтправка сообщения отменена в шлюзе пользователем
gate-sentСообщение передано шлюзом
gate-rejectedСообщение отклонено SMS-платформой
gate-acceptedОт SMS-платформы получено подтверждение о получении сообщения
provider-initialСообщение находится в очереди на обработку SMS-платформой
provider-delayedОтправка сообщения отложена до даты, указанной в параметрах доставки
provider-sentСообщение отправлено получателю
provider-deliveredПолучено подтверждение от SMS-платформы о доставке сообщения на устройство получателя
provider-readСообщение было открыто для прочтения на устройстве получателя
provider-undeliveredSMS-платформа сообщила о недоставке сообщения и ее причине
provider-failedОшибка при обработке сообщения SMS-платформой, сообщение не доставлено получателю
provider-cancelledОтправка сообщения отменена на SMS-платформе по запросу пользователя
provider-unknownПлатформа за установленное время не сообщила статус доставки SMS, что свидетельствует о нештатной ситуации

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:his="http://edna.ru/gate/message/history">
<soapenv:Header/>
<soapenv:Body>
<his:GetOutMessageHistoryRequest>
<his:clientId>100</his:clientId>
<his:deliveryMethod>sms</his:deliveryMethod>
<his:offset>0</his:offset>
<his:maxCount>20</his:maxCount>
</his:GetOutMessageHistoryRequest>
</soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:his="http://edna.ru/gate/message/history">
<soapenv:Header/>
<soapenv:Body>
<his:GetOutMessageHistoryResponse>
<his:message>
<his:messageId>1234</his:messageId>
<his:sentAt>2022-01-18T16:51:16.119+03:00</his:sentAt>
<his:deliveryMethod>sms</his:deliveryMethod>
<his:deliveryStatus>gate-initial</his:deliveryStatus>
<his:source>1</his:source>
<his:messageType>1</his:messageType>
<his:text>Test</his:text>
</his:message>
</his:GetOutMessageHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>