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

Получение информации об отправленных сообщениях

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

Метод getOutMessage возвращает информацию об отправленных сообщениях.

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

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

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

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

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

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

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

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

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

- error-message-id-unknown — не найдено сообщение с указанным идентификатором
messageIdStringОбязательныйИдентификатор сообщения
outMessageНеобязательныйКомплексный параметр с информацией о сообщении
messageIdStringОбязательныйИдентификатор сообщения
timestampDateTimeОбязательныйДата и время отправки сообщения
outMessageTypeIdStringОбязательныйТип сообщения
subjectStringОбязательныйПодпись сообщения
addressStringОбязательныйАдрес получателя
priorityStringОбязательныйПриоритет сообщения
startTimeDateTimeОбязательныйВремя начала отправки
stopTimeDateTimeОбязательныйВремя завершения отправки
dlvIntervalНеобязательныйИнтервал доставки
dlvStartStringНеобязательныйВремя начала интервала доставки
dlvStopStringНеобязательныйВремя окончания интервала доставки
timezoneStringОбязательныйВременная зона
commentStringОбязательныйКомментарий
textStringОбязательныйТекст сообщения
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:getOutMessageRequest>
<out:auth>
<out:login>username</out:login>
<out:password>password</out:password>
</out:auth>
<out:getOutMessageArg>
<out:messageId>msg-12345</out:messageId>
</out:getOutMessageArg>
</out:getOutMessageRequest>
</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:getOutMessageResponse>
<out:responseCode>ok</out:responseCode>
<out:getOutMessageResult>
<out:getOutMessageCode>ok</out:getOutMessageCode>
<out:messageId>msg-12345</out:messageId>
<out:outMessage>
<out:messageId>msg-12345</out:messageId>
<out:timestamp>2022-04-25T18:30:00</out:timestamp>
<out:outMessageTypeId>type1</out:outMessageTypeId>
<out:subject>BANK</out:subject>
<out:address>79161112222</out:address>
<out:priority>high</out:priority>
<out:startTime>2022-04-25T18:30:00</out:startTime>
<out:stopTime>2022-04-25T20:30:00</out:stopTime>
<out:dlvInterval>
<out:dlvStart>09</out:dlvStart>
<out:dlvStop>18</out:dlvStop>
</out:dlvInterval>
<out:timezone>Europe/Moscow</out:timezone>
<out:comment>Test message</out:comment>
<out:text>Your code is 1234</out:text>
<out:outMessageDlvStatus>
<out:dlvStatus>provider-delivered</out:dlvStatus>
<out:dlvStatusAt>2022-04-25T18:35:00</out:dlvStatusAt>
<out:dlvError></out:dlvError>
</out:outMessageDlvStatus>
</out:outMessage>
</out:getOutMessageResult>
</out:getOutMessageResponse>
</soapenv:Body>
</soapenv:Envelope>