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

Получение статуса доставки сообщений

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

Метод getOutMessageDlvStatus возвращает статус доставки сообщения.

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

Помимо стандартных параметров login и password (данные должны быть аналогичны тем, что использовались для отправки сообщения методом consumeOutMessage), необходимо указать идентификатор отправленного сообщения messageId.

Параметр messageId (тип данных — string) передается внутри структуры getOutMessageDlvStatusArg. Если требуется получить статус доставки нескольких сообщений, в теле запроса указывается несколько тегов getOutMessageDlvStatusArg, внутри каждого из которых следует указать идентификатор отдельного сообщения.

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

В ответ на запрос возвращается SOAP-конверт со статусом доставки сообщения.

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

- ok — запрос выполнен;

- error-system-blocked — внешняя система недоступна
getOutMessageDlvStatusResultОбязательныйКомплексный параметр, содержащий данные о статусе доставки
getOutMessageDlvStatusCodeStringОбязательныйКод обработки запроса:

- ok — сообщение найдено;

- error-system — внутренняя ошибка при обработке сообщения;

- error-message-id-unknown — не найдено сообщение с указанным идентификатором
messageIdStringОбязательныйИдентификатор сообщения
outMessageDlvStatusНеобязательныйКомплексный параметр с дополнительной информацией о доставке сообщения
dlvStatusStringОбязательныйСтатус доставки сообщения:

- gate-initial — сообщение на обработке шлюзом;

- gate-declined — доставка отклонена шлюзом, т.к. сработал фильтр;

- gate-failed — ошибка обработки на стороне шлюза;

- gate-cancelled — доставка отменена на стороне шлюза;

- gate-sent — сообщение отправлено шлюзом на платформу провайдера;

- gate-rejected — доставка отклонена шлюзом;

- gate-accepted — сообщение принято на обработку шлюзом;

- provider-initial — сообщение обрабатывается платформой провайдера;

- provider-delayed — доставка отложена платформой провайдера;

- provider-sent — сообщение отправлено абоненту;

- provider-delivered — сообщение доставлено абоненту;

- provider-read — сообщение доставлено и прочитано абонентом;

- provider-undelivered — сообщение не доставлено абоненту;

- provider-failed — ошибка обработки на стороне провайдера;

- provider-cancelled — доставка отменена платформой провайдера;

- provider-unknown — неизвестная ошибка на стороне провайдера
dlvStatusAtDateTimeОбязательныйДата и время доставки сообщения
dlvErrorStringНеобязательныйСообщение об ошибке

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:out="http://www.edna.ru/ednagate/out-message-service">
<soapenv:Header/>
<soapenv:Body>
<out:getOutMessageDlvStatusRequest>
<out:auth>
<out:login>username</out:login>
<out:password>password</out:password>
</out:auth>
<out:getOutMessageDlvStatusArg>
<out:messageId>msg-12345</out:messageId>
</out:getOutMessageDlvStatusArg>
</out:getOutMessageDlvStatusRequest>
</soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:out="http://www.edna.ru/ednagate/out-message-service">
<soapenv:Header/>
<soapenv:Body>
<out:getOutMessageDlvStatusResponse>
<out:responseCode>ok</out:responseCode>
<out:getOutMessageDlvStatusResult>
<out:getOutMessageDlvStatusCode>ok</out:getOutMessageDlvStatusCode>
<out:messageId>msg-12345</out:messageId>
<out:outMessageDlvStatus>
<out:dlvStatus>provider-delivered</out:dlvStatus>
<out:dlvStatusAt>2022-04-25T18:35:00</out:dlvStatusAt>
<out:dlvError></out:dlvError>
</out:outMessageDlvStatus>
</out:getOutMessageDlvStatusResult>
</out:getOutMessageDlvStatusResponse>
</soapenv:Body>
</soapenv:Envelope>