Получение истории отправленных сообщений
Обновлено: 1 октября 2025
Метод отправляет в edna Prisma запрос на получение истории отправленных сообщений. Шлюз возвращает список исходящих сообщений, отсортированных в обратном хронологическом порядке. По умолчанию возвращаются 20 последних отправленных сообщений.
URL-адрес подключения
Для получения истории сообщений выполняется POST-запрос на URL-адрес:
http://hostname:8555/services/MessageHistoryService,
где hostname — адрес шлюза edna Prisma.
Параметры запроса
Параметры передаются в теле SOAP-конверта внутри тега <soapenv:body>.
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
clientId | String | Обязательный | Уникальный идентификатор клиента |
deliveryMethod | Enum | Необязательный | Канал отправки: - sms — SMS-сообщения; - push — Push-сообщения; - im — сообщения в мессенджерах; - ussd — USSD-запросы |
offset | Int | Необязательный | Количество сообщений, которые необходимо пропустить, начиная от наиболее новых. По умолчанию — ноль |
maxCount | Int | Необязательный | Максимальное число сообщений в ответе |
Параметры ответа
В ответе возвращается список объектов message с атрибутами, приведёнными в таблице ниже.
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
messageId | String | Необязательный | Внешний идентификатор сообщения. Выводится, если был указан при отправке сообщения |
sentAt | DateTime | Обязательный | Дата и время отправки сообщения |
deliveryMethod | Enum | Обязательный | Канал отправки: - sms — SMS-сообщения; - push — Push-сообщения; - im — сообщения в мессенджерах; - ussd — USSD-запросы |
deliveryStatus | Enum | Обязательный | Статус доставки сообщения (см. таблицу ниже) |
source | String | Обязательный | Код системы — источника (должен быть заведен при настройке шлюза) |
messageType | String | Обязательный | Код типа сообщения (должен быть заведен при настройке шлюза) |
text | String | Обязательный | Текст сообщения |
pushContent | String | Необязательный | Полный текст push-сообщения (только для push-канала) |
imContent | String | Необязательный | Полный текст сообщения в мессенджере (только для 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-undelivered | SMS-платформа сообщила о недоставке сообщения и ее причине |
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>