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

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

Клиент отслеживает статусы исходящих сообщений по идентификаторам providerId. Если при получении пакета consumeOutMessageResponse происходит ошибка ввода/вывода, то клиент не получает providerId исходящих сообщений. В этом случае он может запросить эти идентификаторы, отправив провайдеру пакет findOutMessageRequest. В ответ провайдер отправляет клиенту пакет findOutMessageResponse.

Пакет findOutMessageRequest​

Раздел payload пакета findOutMessageRequest включает подраздел outMessageList с секциями outMessage. Каждая секция outMessage содержит идентификатор исходящего сообщения clientId.

Структура пакета​

<findOutMessageRequest>
<header><!--параметры аутентификации клиента--></header>
<payload>
<outMessageList>
<outMessage clientId="integer"/>
<outMessage clientId="integer"/>
</outMessageList>
</payload>
</findOutMessageRequest>
Полная XML-схема пакета findOutMessageRequest
<xsd:schema>
<xsd:element name="findOutMessageRequest">
<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="clientId" type="xsd:positiveInteger" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:unique name="clientId">
<xsd:selector xpath="outMessage"/>
<xsd:field xpath="@clientId"/>
</xsd:unique>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>

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

к сведению

Все параметры в таблице входят в объект payload.

ПараметрТипХарактерОписание
.../outMessage/@clientIdIntegerОбязательныйАтрибут outMessage, идентификатор исходящего сообщения на стороне клиента. Глобально уникален на протяжении всего времени взаимодействия между клиентом и провайдером. Значение генерируется для каждого исходящего сообщения и служит для дальнейшей привязки providerId к исходящему сообщению, а также запроса статусов доставки последнего.

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

<findOutMessageRequest>
<header>
<auth>
<login>test</login>
<password>test</password>
</auth>
</header>
<payload>
<outMessageList>
<outMessage clientId="1"/>
<outMessage clientId="2"/>
</outMessageList>
</payload>
</findOutMessageRequest>

Пакет findOutMessageResponse​

Раздел payload пакета findOutMessageResponse содержит код ответа платформы:

  • если код ответа свидетельствует об отсутствии ошибки, то раздел payload включает подраздел outMessageList с секциями outMessage из пакета findOutMessageRequest;

  • если код ответа свидетельствует об ошибке, значит запрос не обработан ни по одному из исходящих сообщений из пакета findOutMessageRequest.

В каждой секции outMessage указан код ответа на запрос по соответствующему исходящему сообщению:

  • если код ответа свидетельствует об отсутствии ошибки, то секция outMessage содержит идентификаторы исходящего сообщения clientId и providerId;

  • если код ответа свидетельствует об ошибке, значит запрос по сообщению был обработан с ошибкой.

Структура пакета​

<findOutMessageResponse>
<header/>
<payload>
<code>string</code>
<outMessageList>
<outMessage clientId="string" providerId="integer">
<code>string</code>
</outMessage>
</outMessageList>
</payload>
</findOutMessageResponse>
Полная XML-схема пакета findOutMessageResponse
<xsd:schema>
<xsd:element name="findOutMessageResponse">
<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-client-id-format"/>
<xsd:enumeration value="error-out-message-client-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-client-id-unknown"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="clientId" type="xsd:positiveInteger" use="required"/>
<xsd:attribute name="providerId" type="xsd:positiveInteger" use="optional"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:unique name="clientId">
<xsd:selector xpath="outMessage"/>
<xsd:field xpath="@clientId"/>
</xsd:unique>
<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.

ПараметрТипХарактерОписание
codeStringОбязательныйКод результата обработки пакета findOutMessageRequest. File IconОтвет на ошибочный пакет
.../outMessage/codeStringОбязательныйКод ответа платформы для исходящего сообщения. File IconКоды ответов платформы при обработке запроса идентификаторов
.../outMessage/@clientIdIntegerОбязательныйИдентификатор исходящего сообщения на стороне клиента. Глобально уникален на протяжении всего времени взаимодействия между клиентом и провайдером. Значение генерируется для каждого исходящего сообщения и служит для дальнейшей привязки providerId к исходящему сообщению, а также запроса статусов доставки последнего.
.../outMessage/@providerIdStringОбязательныйИдентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом. Параметр возвращается, если сообщение с указанным clietnId успешно принято на отправку.

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

<findOutMessageResponse>
<header/>
<payload>
<code>ok</code>
<outMessageList>
<outMessage clientId="1" providerId="101">
<code>ok</code>
</outMessage>
<outMessage clientId="2">
<code>error-out-message-client-id-unknown</code>
</outMessage>
</outMessageList>
</payload>
</findOutMessageResponse>

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

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

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