Используйте пакет consumeOutMessageRequest для отправки исходящих сообщений.
Раздел payload пакета содержит одну или несколько подсекций outMessage, каждая из которых определяет параметры отдельного исходящего сообщения. Обязательным является только один параметр сообщения ‑ address.
Раздел payload содержит подраздел outMessageCommon, который содержит общие параметры для всех сообщений пакета.
Если параметр сообщения не указан в
outMessage, то его значение берется из outMessageCommon. Если параметр не указан в outMessageCommon, то его значение по умолчанию берется из конфигурации платформы провайдера. Исключение составляет только параметр content, который обязательно должен быть указан либо в outMessage, либо в outMessageCommon. Структура пакета
<consumeOutMessageRequest> <header> <!--параметры аутентификации клиента--> </header> <payload> <outMessageCommon> <!--общие параметры сообщений рассылки--> </outMessageCommon> <outMessageList> <outMessage> <!--адрес получателя и индивидуальные параметры сообщения--> </outMessage> <!--повторение блока 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 ‑ текстовое сообщение • flash-call |
content | string (required) | Информационное содержание сообщения. Содержание зависит от значения параметра contentType:• Если параметр contentType имеет значение text, то содержание является текстом сообщения. • Если параметр contentType имеет значение flash-call, то содержанием текста является код подтверждения, по которому осуществляется подбор номера для совершения звонка. Если параметр 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) | Общий комментарий к исходящим сообщениям |
Пример пакета
curl -X POST 'https://gate40.mfms.ru:13436/ХХХХ/connector1/service/' \ -H "Content-Type: application/xml" \ -H "Accept: application/xml" \ -d "<consumeOutMessageRequest> <header> <auth> <login>ХХХХ</login> <password>ХХХ</password> </auth> </header> <payload> <outMessageCommon> <subject>ХХХХ</subject> <priority>high</priority> <validityPeriodSeconds>600</validityPeriodSeconds> <contentType>flash-call</contentType> <content>1234</content> </outMessageCommon> <outMessageList> <outMessage clientId=\"123456789\"> <address>79250000000</address> </outMessage> </outMessageList> </payload> </consumeOutMessageRequest>"