Получение статусов сообщений методом обратного вызова
Для передачи статуса сообщения методом обратного вызова служит пакет consumeMessageDlvStatusRequest.
Пакет consumeMessageDlvStatusRequest
Пакет направляется от провайдера к клиенту по указанному заранее адресу. В заголовке пакета передается секция auth с логином и паролем для авторизации запроса на стороне клиента.
Структура пакета
<consumeMessageDlvStatusRequest>
<header>
<auth><!--параметры аутентификации на стороне клиента--></auth>
</header>
<payload>
<outMessageList>
<outMessage providerId="String">
<outMessageDlvStatus>
<dlvStatus>String</dlvStatus>
<dlvStatusAt>String</dlvStatusAt>
</outMessageDlvStatus>
</outMessage>
</outMessageList>
</payload>
</consumeMessageDlvStatusRequest>
Параметры пакета
к сведению
Все параметры в таблице входят в объект payload.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
outMessageList | Object | Необязательный | Объект, содержащий список сообщений, для которых возвращаются статусы. |
outMessageList/outMessage | Object | Необязательный | Объект, содержащий данные об одном сообщении. |
.../outMessage/@providerId | String | Обязательный | Идентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом. |
.../outMessage/outMessageDlvStatus | Object | Обязательный | Объект, содержащий данные о статусе доставки сообщения. |
.../outMessageDlvStatus/dlvStatus | String | Обязательный | Текущий статус доставки сообщения.
Возможные значения: - enqueued — находится в очереди на отправку;
- sent — отправлено;
- delivered — доставлено;
- undelivered — отправлено, но не доставлено;
- failed — не было отправлено из-за сбоя;
- cancelled— отправка отменена. |
.../outMessageDlvStatus/dlvStatusAt | Datetime | Обязательный | Дата и время получения статуса сообщения. |
Пример пакета
<consumeMessageDlvStatusRequest>
<header>
<auth>
<login>test</login>
<password>test</password>
</auth>
</header>
<payload>
<outMessageList>
<outMessage providerId="178008">
<outMessageDlvStatus>
<dlvStatus>delivered</dlvStatus>
<dlvStatusAt>2021-04-07 00:24:22</dlvStatusAt>
</outMessageDlvStatus>
</outMessage>
<outMessage providerId="178010">
<outMessageDlvStatus>
<dlvStatus>delivered</dlvStatus>
<dlvStatusAt>2021-04-07 00:24:22</dlvStatusAt>
</outMessageDlvStatus>
</outMessage>
</outMessageList>
</payload>
</consumeMessageDlvStatusRequest>
Пакет consumeMessageDlvStatusResponse
В ответ на callback-запрос отправляется пакет consumeMessageDlvStatusResponse.
warning
В ответе на запрос consumeMessageDlvStatusRequest должен быть передан код 200 с телом пакета consumeMessageDlvStatusResponse.
подсказка
Для назначения URL обратного вызова отправьте запрос в службу поддержки.
Структура пакета
<consumeMessageDlvStatusResponse>
<header/>
<payload>
<code>String</code>
</payload>
</consumeMessageDlvStatusResponse>
Параметры пакета
к сведению
Все параметры в таблице входят в объект payload.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
code | String | Обязательный | Код результата обработки пакета consumeMessageDlvStatusRequest.
Ответ на ошибочный пакет |
Пример пакета
<consumeMessageDlvStatusResponse>
<header/>
<payload>
<code>ok</code>
</payload>
</consumeMessageDlvStatusResponse>