Получение статуса доставки Email-сообщений
Обновлено: 1 октября 2025
Метод EmailStatusRequest отправляет запрос в edna Prisma для получения статуса обработки Email-сообщений с указанными идентификаторами.
URL-адрес подключения
Для получения статуса Email выполняется POST-запрос на URL-адрес:
http://hostname:8778/services/email,
где hostname — адрес шлюза edna Prisma.
Параметры запроса
Параметры передаются в теле SOAP-конверта внутри тега <soapenv:body>.
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
sourceCode | String | Обязательный | Код системы — источника сообщения (должен быть предварительно заведен в шлюзе) |
messageIds | Обязательный | Список идентификаторов отправленных сообщений | |
id | String | Обязательный | Идентификатор отправленного сообщения |
Параметры ответа
При успешном выполнении запроса возвращается список statusList, который содержит значения статусов status для каждого Email-сообщения. В случае ошибки возвращается значение параметра errorCode.
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
errorCode | String | Необязательный | В случае ошибки в параметрах запроса на отправку сообщения (метод EmailSendRequest) возвращается значение error-bad-parameters |
errorDetail | String | Необязательный | Детальное описание ошибки в случае неудачного выполнения запроса, например Source http is not JMS type |
statusList | Необязательный | Список объектов status | |
status | Необязательный | Данные о статусе обработки конкретного сообщения (см. ниже) | |
id | String | Необязательный | Идентификатор отправленного сообщения в информационной системе заказчика |
providerId | Long | Необязательный | Идентификатор сообщения на платформе провайдера |
status | String | Необязательный | Статус обработки сообщения. Статусы отслеживаются только до состояния «Обработано» (шлюзом). В шлюз не поступают данные для отслеживания доставки Email-сообщений после отправки их на платформу провайдера |
statusNote | String | Необязательный | Примечание к статусу обработки |
Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ema="http://edna.ru/gate/client/email">
<soapenv:Header/>
<soapenv:Body>
<ema:EmailStatusRequest>
<ema:sourceCode>WS</ema:sourceCode>
<ema:messageIds>
<ema:id>id-27</ema:id>
<ema:id>id-28</ema:id>
</ema:messageIds>
</ema:EmailStatusRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа
Пример успешного ответа
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ema="http://edna.ru/gate/client/email">
<soapenv:Header/>
<soapenv:Body>
<ema:EmailStatusResponse>
<ema:statusList>
<ema:status>
<ema:id>id-27</ema:id>
<ema:providerId>12345</ema:providerId>
<ema:status>processed</ema:status>
<ema:statusNote>Message processed successfully</ema:statusNote>
</ema:status>
<ema:status>
<ema:id>id-28</ema:id>
<ema:providerId>12346</ema:providerId>
<ema:status>processed</ema:status>
<ema:statusNote>Message processed successfully</ema:statusNote>
</ema:status>
</ema:statusList>
</ema:EmailStatusResponse>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа с ошибкой
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ema="http://edna.ru/gate/client/email">
<soapenv:Header/>
<soapenv:Body>
<ema:EmailStatusResponse>
<ema:errorCode>error-bad-parameters</ema:errorCode>
<ema:errorDetail>Source http is not JMS type</ema:errorDetail>
</ema:EmailStatusResponse>
</soapenv:Body>
</soapenv:Envelope>