Пакет consumeOutMessageRequest используется для отправки исходящих сообщений.
Раздел payload пакета содержит одну или несколько подсекций outMessage, каждая из которых определяет параметры отдельного исходящего сообщения. Обязательным является только один параметр сообщения ‑ address.
Раздел payload содержит подраздел outMessageCommon, который содержит общие параметры для всех сообщений пакета.
Если параметр сообщения не указан в
outMessage, то его значение берется из outMessageCommon. Если параметр не указан в outMessageCommon, то его значение по умолчанию берется из конфигурации платформы провайдера. Исключение составляет только параметр content, который обязательно должен быть указан либо в outMessage, либо в outMessageCommon. Структура пакета
<?xml version="1.0" encoding="UTF-8"?> <consumeOutMessageRequest> <header> <auth> <login>test</login> <password>test</password> </auth> </header> <payload> <outMessageList> <outMessage clientId="24234244"> <address>79950993734</address> <subject>TEST_SMPP</subject> <content>Ваш код авторизации в EDNA 1234</content> <contentType>voice-code</contentType> </outMessage> </outMessageList> </payload> </consumeOutMessageRequest>
Описание параметров пакета
Ниже представлены таблицы с описанием параметров, вложенных в outMessageCommon и outMessage.
Параметры, вложенные в outMessageCommon
| Параметр | Тип | Описание |
subject | string (required) | Подпись в исходящих сообщениях. Важно! Все подписи необходимо предварительно зарегистрировать на платформе |
priority | string (required) | Общий приоритет исходящих сообщений: • low ‑ низкий приоритет• normal ‑ нормальный приоритет• high ‑ высокий приоритет• realtime ‑ высочайший приоритет |
startTime | datetime (required) | Время отложенной отправки исходящих сообщений |
validityPeriodSeconds | integer (required) | Период времени попыток доставки сообщения |
contentType | string (required) | Тип контента исходящих сообщений: • text ‑ текстовое сообщение • voice-code |
content | string (required) | Информационное содержание сообщения. • Если параметр contentType имеет значение text, то содержание является текстом сообщения. • Если параметр contentType имеет значение voice-code, то содержанием текста является следующее сообщение:Ваш код авторизации в *Название бренда* # # # # где # # # # — это 4-значный код, который генерирует клиент. Если параметр contentType в outMessage имеет значение text, то допустима любая непустая строка. Строка может быть произвольной длины. Если строка длиннее, чем допустимый размер одного SMS-сообщения, то она автоматически разобьется на нужное количество SMS-сообщений. |
comment | string (optional) | Общий комментарий к исходящим сообщениям |
Параметры, вложенные в outMessage
| Параметр | Тип | Описание |
clientId | integer (required) | Уникальный идентификатор исходящего сообщения на стороне клиента. Глобально уникален на протяжении всего времени взаимодействия между клиентом и провайдером. Значение генерируется клиентом для каждого исходящего сообщения и служит для дальнейшей привязки providerId к исходящему сообщению, а также запроса статусов доставки исходящих сообщений. |
subject | string (required) | Подпись в исходящих сообщениях. Важно! Все подписи необходимо предварительно зарегистрировать на платформе. |
address | address (required) | Номер мобильного телефона получателя в международном формате (в формате E.164) |
priority | string (required) | Общий приоритет исходящих сообщений: • low ‑ низкий приоритет• normal ‑ нормальный приоритет • high ‑ высокий приоритет • realtime ‑ высочайший приоритет |
startTime | datetime (required) | Время отложенной отправки исходящих сообщений |
validityPeriodSeconds | integer (required) | Период времени попыток доставки сообщения |
contentType | string (required) | Тип контента исходящих сообщений: • text ‑ текстовое сообщение |
content | string (required) | Информационное содержание сообщения. Если параметр contentType имеет значение text, то содержание является текстом сообщения. Если параметр contentType в outMessage имеет значение text, то допустима любая непустая строка. Строка может быть произвольной длины. Если строка длиннее, чем допустимый размер одного SMS-сообщения, то она автоматически разобьется на нужное количество SMS-сообщений. |
comment | string (optional) | Общий комментарий к исходящим сообщениям |
Пример пакета
<consumeOutMessageRequest>
<header>
<auth>
<login>login</login>
<password>********</password>
</auth>
</header>
<payload>
<outMessageCommon>
<subject>mfms</subject>
<priority>high</priority>
<validityPeriodSeconds>600</validityPeriodSeconds>
<contentType>voice-code</contentType>
<content>Ваш код авторизации в EDNA 1234</content>
<comment>код регистрации</comment>
</outMessageCommon>
<outMessageList>
<outMessage clientId="9935977">
<address>79036666666</address>
</outMessage>
<outMessage clientId="9935978">
<address>79037777777</address>
</outMessage>
</outMessageList>
</payload>
</consumeOutMessageRequest>