Перейти к основному содержимому

Запрос статусов доставки сообщений

Для запроса статусов исходящих сообщений клиент отправляет провайдеру пакет 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.

ПараметрТипХарактерОписание
outMessageListObjectНеобязательныйОбъект, содержащий список сообщений, для которых запрашиваются статусы.
outMessageList/outMessageObjectНеобязательныйОбъект, содержащий идентификатор одного сообщения.
.../outMessage/@providerIdStringОбязательныйАтрибут 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.

ПараметрТипХарактерОписание
codeStringОбязательныйКод результата обработки пакета provideOutMessageDlvStatusRequest. File IconОтвет на ошибочный пакет
outMessageListObjectНеобязательныйОбъект, содержащий список сообщений, для которых возвращаются статусы.
outMessageList/outMessageObjectНеобязательныйОбъект, содержащий данные об одном сообщении.
.../outMessage/@providerIdStringОбязательныйИдентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом.
.../outMessage/codeStringОбязательныйКод результата обработки запроса статуса сообщения. File IconКоды ответов платформы при обработке запроса статусов
.../outMessage/outMessageDlvStatusObjectОбязательныйОбъект, содержащий данные о статусе доставки сообщения.
.../outMessageDlvStatus/dlvStatusStringОбязательныйТекущий статус доставки сообщения. Указывается, если запрос на статус доставки сообщения обработан успешно.
Возможные значения:
- enqueued — находится в очереди на отправку;
- sent — отправлено;
- delivered — доставлено;
- undelivered — отправлено, но не доставлено;
- failed — не было отправлено из-за сбоя;
- cancelled— отправка отменена.
warning
Если сообщение состоит из нескольких сегментов и хотя бы один из них не был доставлен, то и статус всего сообщения будет иметь значение undelivered.
.../outMessageDlvStatus/dlvStatusAtDatetimeОбязательныйДата и время получения статуса сообщения.
.../outMessageDlvStatus/vdlvErrorStringНеобязательныйУказывается в ответе, если параметр dlvStatus имеет значение undelivered или cancelled.
Возможные значения:
- user-blocked — абонент заблокирован;
- filtered— сообщение не соответствует ни одному зарегистрированному шаблону.
.../outMessageDlvStatus/​outMessageSegmentObjectНеобязательныйОбъект, содержащий данные о доставке сегментов сообщения. Сообщение разделяется на сегменты, если его длина превышает максимально допустимое значение для SMS. Каждый из сегментов обрабатывается как отдельное сообщение. Если исходящее сообщение не требовало разделения, то такого объекта в ответе не будет.
.../outMessageSegment/totalIntegerОбязательныйОбщее количество сегментов, на которое было разбито исходное сообщение.
.../outMessageSegment/sentIntegerОбязательныйКоличество сегментов, успешно отправленных платформой.
.../outMessageSegment/deliveredIntegerОбязательныйКоличество сегментов, доставленных адресату.
.../outMessageSegment/undeliveredIntegerОбязательныйКоличество сегментов, недоставленных адресату.
.../outMessageSegment/unknownIntegerОбязательныйКоличество сегментов, статус доставки которых неизвестен.

Пример пакета​

<provideOutMessageDlvStatusResponse>
<header/>
<payload>
<code>ok</code>
<outMessageList>
<outMessage providerId="101">
<code>ok</code>
<outMessageDlvStatus>
<dlvStatus>undelivered</dlvStatus>
<dlvStatusAt>2007-10-29 00:00:00</dlvStatusAt>
<dlvError>unknown-subsciber</dlvError>
</outMessageDlvStatus>
</outMessage>
<outMessage providerId="102">
<code>ok</code>
<outMessageDlvStatus>
<dlvStatus>sent</dlvStatus>
<dlvStatusAt>2007-10-29 23:59:59</dlvStatusAt>
</outMessageDlvStatus>
</outMessage>
<outMessage providerId="103">
<code>error-out-message-provider-id-unknown</code>
</outMessage>
</outMessageList>
</payload>
</provideOutMessageDlvStatusResponse>

Коды ответов платформы при обработке запроса статусов​

Код ответа для каждого сообщения указывается в параметре code в объекте outMessage.

КодОписание
okЗапрос выполнен успешно.
error-systemСистемная ошибка.
error-out-message-provider-id-unknownНеизвестный идентификатор providerId.