Пакет consumeOutMessageResponse является ответом провайдера на пакет consumeOutMessageRequest (отправка пакета сообщений).
Раздел payload пакета содержит код ответа платформы:
- Если код ответа содержит ошибку, то ни одно из исходящих сообщений пакета
consumeOutMessageRequestне принято на отправку. - Если код ответа не содержит ошибку, то раздел payload включает подраздел
outMessageс секциямиoutMessageиз пакетаconsumeOutMessageRequest.
В каждой секции outMessage указан код ответа для каждого исходящего сообщения:
- Если код ответа содержит ошибку, то исходящее сообщение не принято на отправку.
- Если код ответа не содержит ошибку, то секция
outMessageсодержит идентификаторы исходящего сообщения:clientIdиproviderId.
Структура пакета
<consumeOutMessageResponse> <header/> <payload> <code>string</code> <outMessageList> <outMessage clientId="integer" providerId="string"> <code>string</code> </outMessage> </outMessageList> </payload> </consumeoutMessageResponse>
Описание параметров пакета
| Параметр | Тип | Описание |
code | string (required) | Результат обработки пакета consumeOutMessageRequest, передается в виде кода ответа платформы |
clientId | integer (required) | Уникальный идентификатор сообщения на стороне клиента. Глобально уникален на протяжении всего времени взаимодействия между клиентом и провайдером. Значение генерируется клиентом для каждого исходящего сообщения и служит для дальнейшей привязки providerId к исходящему сообщению, а также запроса статусов доставки исходящих сообщений |
providerId | string (required) | Уникальный идентификатор сообщения на стороне платформы. Значение параметра уникально в рамках всего времени взаимодействия между провайдером и клиентом. Параметр указывается, если сообщение с указанным clietnId успешно принято на отправку |
code | string (required) | Код ответа платформы для исходящего сообщения внутри пакета |
Пример пакета
<?xml version="1.0" encoding="utf-8"?> <consumeOutMessageResponse> <header/> <payload> <code>ok</code> <outMessageList> <outMessage clientId="1" providerId="101"> <code>ok</code> </outMessage> <outMessage clientId="2" providerId="102"> <code>error-address-format</code> </outMessage> </outMessageList> </payload> </consumeOutMessageResponse>