Отправка Email-сообщений
Метод EmailSendRequest отправляет запрос в edna Prisma для формирования исход ящих Email-сообщений.
URL-адрес подключения
Для отправки Email выполняется POST-запрос на URL-адрес:
http://hostname:8778/services/email,
где hostname — адрес шлюза edna Prisma.
Параметры запроса
Параметры передаются в теле SOAP-конверта внутри тега <soapenv:body>.
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
sourceCode | String | Обязательный | Код системы — источника сообщения (должен быть предварительно заведен в edna Prisma) |
typeCode | String | Обязательный | Код типа сообщения (должен быть предварительно заведен в edna Prisma) |
priority | String | Необязательный | Приоритет сообщения, влияющий на скорость отправки: - realtime — отправка в режиме реального времени; - high — высокий пр иоритет; - normal — средний (обычный) приоритет; - low — низкий приоритет |
subject | String | Обязательный | Тема письма |
senderName | String | Необязательный | Имя отправителя, которое отображается при получении сообщения |
senderAddress | String | Обязательный | Email-адрес отправителя |
startTime | DateTime | Необязательный | Дата и время начала отправки в формате 2022-10-17T03:25:09+0300 (дата и время разделяются буквой T, а также указывается часовой пояс) |
stopTime | DateTime | Необязательный | Дата и время завершения отправки (даже, если доставить сообщение не удалось) в формате 2022-10-18T03:25:09+0300 (дата и время разделяются буквой T, а также указывается часовой пояс) |
subscriberList | Обязательный | Список получателей сообщения. Должен содержать один или более тегов subscriber с атрибутами получателей сообщения | |
subscriber | Обязательный | Структура с данными о получателе сообщения (см. ниже) | |
messageId | String | Обязательный | Идентификатор сообщения в ИС б анка |
emailAddress | String | Обязательный | Email-адрес получателя |
params | Необязательный | Список параметров подстановки для данного получателя. Такие подстановки могут использоваться при формировании персонализированного содержимого письма | |
param | Необязательный | Параметр подстановки. Содержит поля key (ключ) и value (значение) | |
messageContent | Обязательный | Содержимое сообщения | |
templateId | String | Необязательный | Идентификатор шаблона |
content | String | Обязательный | Содержимое письма (текст или HTML) |
contentType | String | Обязательный | Тип содержимого: text/plain или text/html |
Пример запроса без вложения
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ema="http://edna.ru/gate/client/email">
<soapenv:Header/>
<soapenv:Body>
<ema:EmailSendRequest>
<ema:sourceCode>WS</ema:sourceCode>
<ema:typeCode>type333</ema:typeCode>
<ema:priority>normal</ema:priority>
<ema:subject>Вы выиграли суперприз!</ema:subject>
<ema:senderName>ДГ</ema:senderName>
<ema:senderAddress>bill@msoft.com</ema:senderAddress>
<ema:startTime>2022-03-22T14:52:09.050</ema:startTime>
<ema:subscriberList>
<ema:subscriber>
<ema:messageId>id-27</ema:messageId>
<ema:emailAddress>td@ms.ru</ema:emailAddress>
<ema:params>
<ema:param>
<ema:key>name</ema:key>
<ema:value>Alex</ema:value>
</ema:param>
<ema:param>
<ema:key>surname</ema:key>
<ema:value>Ivanov</ema:value>
</ema:param>
</ema:params>
</ema:subscriber>
<ema:subscriber>
<ema:messageId>id-28</ema:messageId>
<ema:emailAddress>td@mf.ru</ema:emailAddress>
<ema:params>
<ema:param>
<ema:key>name</ema:key>
<ema:value>Nick</ema:value>
</ema:param>
<ema:param>
<ema:key>surname</ema:key>
<ema:value>Petrov</ema:value>
</ema:param>
</ema:params>
</ema:subscriber>
</ema:subscriberList>
<ema:messageContent>
<ema:templateId>10</ema:templateId>
<ema:content><![CDATA[<html><body>Dear {name} {surname}, your account was blocked</body></html>]]></ema:content>
<ema:contentType>text/html</ema:contentType>
</ema:messageContent>
</ema:EmailSendRequest>
</soapenv:Body>
</soapenv:Envelope>
Запрос, если email содержит вложение
Тело запроса должно содержать сообщение с MIME-типом multipart/related.
RFC 2387 — The MIME Multipart/Related Content-type
Такое сообщение содержит текстовую часть — SOAP-конверт, структура которой аналогична описанной выше для сообщения без вложений, и вложения в бинарном формате (JPEG, PNG, PDF и т.д.).
SOAP Messages with Attachments — W3C
Тело запроса содержит две части: текст сообщения в формате SOAP, вложение в бинарном виде (обозначено как ‰PNG). Для каждой части указаны значения параметров Content-Type, Content-ID и Content-Transfer-Encoding.
Content-Type: multipart/related; type="text/xml"; start="<rootpart@soapui.org>";
boundary="----=_Part_2_6383489.1521213716037"
MIME-Version: 1.0
------=_Part_2_6383489.1521213716037
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID: <rootpart@soapui.org>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ema="http://edna.ru/gate/client/email">
<soapenv:Header/>
<soapenv:Body>
<ema:EmailSendRequest>
<sourceCode>WS</sourceCode>
<typeCode>type333</typeCode>
<priority>normal</priority>
<subject>Вы выиграли суперприз!</subject>
<senderName>ДГ</senderName>
<senderAddress>bill@msoft.com</senderAddress>
<startTime>2022-03-22T14:52:09.050</startTime>
<subscriberList>
<subscriber>
<messageId>id-27</messageId>
<emailAddress>td@ms.ru</emailAddress>
<params>
<param>
<key>name</key>
<value>Alex</value>
</param>
<param>
<key>surname</key>
<value>Ivanov</value>
</param>
</params>
</subscriber>
<subscriber>
<messageId>id-28</messageId>
<emailAddress>td@mf.ru</emailAddress>
<params>
<param>
<key>name</key>
<value>Nick</value>
</param>
<param>
<key>surname</key>
<value>Petrov</value>
</param>
</params>
</subscriber>
</subscriberList>
<messageContent>
<templateId>10</templateId>
<content><![CDATA[<html><body>Dear {name} {surname}, your account was
blocked</html></body>]]></content>
<contentType>text/html</contentType>
</messageContent>
</ema:EmailSendRequest>
</soapenv:Body>
</soapenv:Envelope>
------=_Part_2_6383489.1521213716037
Content-Type: image/x-png; name=sshot-316.png
Content-Transfer-Encoding: binary
Content-ID: <sshot-316.png>
Content-Disposition: attachment; name="sshot-316.png"; filename="sshot-316.png"
‰PNG
Пример ответа
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ema="http://edna.ru/gate/client/email">
<soapenv:Header/>
<soapenv:Body>
<ema:EmailSendResponse>
<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:EmailSendResponse>
</soapenv:Body>
</soapenv:Envelope>
Параметры ответа
В ответ на запрос возвращается список statusList, который содержит значения статусов status для каждого переданного в запросе Email-сообщения.
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
id | String | Необязательный | Идентификатор отправленного сообщения в информационной системе заказчика |
providerId | Long | Необязательный | Идентификатор сообщения на платформе провайдера |
status | String | Необязательный | Статус обработки сообщения. Статусы отслеживаются только до состояния «Обработано» (шлюзом). В шлюз не поступают данные для отслеживания доставки Email-сообщений после отправки их на платформу провайдера |
statusNote | String | Необязательный | Примечание к статусу обработки |