Запрос статусов доставки сообщений
Для запроса статусов исходящих сообщений клиент отправляет провайдеру пакет provideOutMessageDlvStatusRequest. В ответ провайдер отправляет клиенту пакет provideOutMessageDlvStatusResponse.
Пакет provideOutMessageDlvStatusRequest
Раздел payload пакета provideOutMessageDlvStatusRequest содержит подраздел outMessageList с секциями outMessage, в которых передаются идентификаторы отправленных ранее сообщений providerId. Значение providerId присваивается платформой каждому исходящему сообщению и возвращается в пакете consumeOutMessageResponse. Узнать значение providerId для отправленных ранее сообщений можно также с помощью запроса findOutMessageRequest.
Структура пакета
<provideOutMessageDlvStatusRequest>
<header>
<auth><!--параметры аутентификации клиента--></auth>
</header>
<payload>
<outMessageList>
<outMessage providerId="String"/>
</outMessageList>
</payload>
</provideOutMessageDlvStatusRequest>
Полная XML-схема пакета provideOutMessageDlvStatusRequest
<xsd:schema>
<xsd:element name="provideOutMessageDlvStatusRequest">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="header">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="auth">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="login" type="xsd:string"/>
<xsd:element name="password" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="payload">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="outMessageList" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="outMessage" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:attribute name="providerId" type="xsd:positiveInteger" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:unique name="providerId">
<xsd:selector xpath="outMessage"/>
<xsd:field xpath="@providerId"/>
</xsd:unique>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
Параметры пакета
Все параметры в таблице входят в объект payload.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
outMessageList | Object | Необязательный | Объект, содержащий список сообщений, для которых запрашиваются статусы. |
outMessageList/outMessage | Object | Необязательный | Объект, содержащий идентификатор одного сообщения. |
.../outMessage/@providerId | String | Обязательный | Атрибут outMessage, идентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом. Значение параметра берется из пакета consumeOutMessageResponse. |
Пример пакета
<provideOutMessageDlvStatusRequest>
<header>
<auth>
<login>test</login>
<password>test</password>
</auth>
</header>
<payload>
<outMessageList>
<outMessage providerId="101"/>
<outMessage providerId="102"/>
</outMessageList>
</payload>
</provideOutMessageDlvStatusRequest>
Пакет provideOutMessageDlvStatusResponse
Раздел payload пакета provideOutMessageDlvStatusResponse содержит код ответа платформы и список исходящих сообщений outMessageList:
-
если код ответа свидетельствует об отсутствии ошибки, т о подраздел
outMessageListвключает секцииoutMessage, соответствующие пакетуprovideOutMessageDlvStatusRequest; -
если код ответа свидетельствует об ошибке, значит запрос не обработан ни по одному из сообщений из пакета
provideOutMessageDlvStatusRequest.
В каждой секции outMessage указан код ответа на запрос по соответствующему исходящему сообщению:
-
если код ответа свидетельствует об отсутствии ошибки, то секция
outMessageсодержит объектoutMessageDlvStatusсо статусом доставки сообщенияdlvStatus. Если сообщение состояло из нескольких сегментов, то вoutMessageDlvStatusпередается также объектoutMessageSegmentс информацией о статусах доставки сегментов; -
если код ответа свидетельствует об ошибке, значит запрос статуса доставки был обработан с ошибкой.
Структура пакета
<provideOutMessageDlvStatusResponse>
<header/>
<payload>
<code>String</code>
<outMessageList>
<outMessage providerId="String">
<code>String</code>
<outMessageDlvStatus>
<dlvStatus>String</dlvStatus>
<dlvStatusAt>String</dlvStatusAt>
<outMessageSegment>
<total>Integer</total>
<sent>Integer</sent>
<delivered>Integer</delivered>
<undelivered>Integer</undelivered>
<unknown>Integer</unknown>
</outMessageSegment>
</outMessageDlvStatus>
</outMessage>
</outMessageList>
</payload>
</provideOutMessageDlvStatusResponse>
Полная XML-схема пакета provideOutMessageDlvStatusResponse
<xsd:schema>
<xsd:element name="provideOutMessageDlvStatusResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="header" type="xsd:string"/>
<xsd:element name="payload">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="code">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ok"/>
<xsd:enumeration value="error-syntax"/>
<xsd:enumeration value="error-auth"/>
<xsd:enumeration value="error-permission"/>
<xsd:enumeration value="error-system"/>
<xsd:enumeration value="error-account-locked"/>
<xsd:enumeration value="error-out-message-provider-id-format"/>
<xsd:enumeration value="error-out-message-provider-id-duplicate"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="outMessageList" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="outMessage" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="code">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ok"/>
<xsd:enumeration value="error-system"/>
<xsd:enumeration value="error-out-message-provider-id-unknown"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="outMessageDlvStatus" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="dlvStatus">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="enqueued"/>
<xsd:enumeration value="sent"/>
<xsd:enumeration value="delivered"/>
<xsd:enumeration value="undelivered"/>
<xsd:enumeration value="failed"/>
<xsd:enumeration value="delayed"/>
<xsd:enumeration value="cancelled"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="dlvStatusAt" type="dateTimeType"/>
<xsd:element name="dlvError" type="xsd:string" minOccurs="0"/>
<xsd:element name="outMessageSegment" minOccurs="0" maxOccurs="1">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="total" type="xsd:int"/>
<xsd:element name="sent" type="xsd:int"/>
<xsd:element name="delivered" type="xsd:int"/>
<xsd:element name="undelivered" type="xsd:int"/>
<xsd:element name="unknown" type="xsd:int"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="providerId" type="xsd:positiveInteger" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:unique name="providerId">
<xsd:selector xpath="outMessage"/>
<xsd:field xpath="@providerId"/>
</xsd:unique>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:simpleType name="dateTimeType">
<xsd:restriction base="xsd:string">
<xsd:pattern value="\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>
Параметры пакета
Все параметры в таблице входят в объект payload.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
code | String | Обязательный | Код результата обработки пакета provideOutMessageDlvStatusRequest.
Ответ на ошибочный пакет |
outMessageList | Object | Необязательный | Объект, содержащий список сообщений, для которых возвращаются статусы. |
outMessageList/outMessage | Object | Необязательный | Объект, содержащий данные об одном сообщении. |
.../outMessage/@providerId | String | Обязательный | Идентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом. |
.../outMessage/code | String | Обязательный | Код результата обработки запроса статуса сообщения. Коды ответов платформы при обработке запроса статусов |
.../outMessage/outMessageDlvStatus | Object | Обязательный | Объект, содержащий данные о статусе доставки сообщения. |
.../outMessageDlvStatus/dlvStatus | String | Обязательный | Текущий статус доставки сообщения. Указывается, если запрос на статус доставки сообщения обработан успешно.
Возможные значения: - enqueued — находится в очереди на отправку;
- sent — отправлено;
- delivered |