Подтверждение получения входящих сообщений
Для подтверждения получения входящих сообщений клиент отправляет пакет confirmInMessageRequest. В ответ провайдер отправляет клиенту пакет confirmInMessageResponse
Пакет confirmInMessageRequest
Раздел payload пакета confirmInMessageRequest содержит подраздел inMessageInbox c уникальным кодом ящика входящих сообщений. Секция inMessageList содержит одну или несколько подсекций inMessage, в каждой из которых указывается обязательный атрибут providerId — идентификатор входящего сообщения, полученный в пакете provideInMessageResponse.
Структура пакета
<confirmInMessageRequest>
<header><!--параметры аутентификации клиента--></header>
<payload>
<inMessageInbox code="default">
<inMessageList>
<inMessage providerId="string"/>
</inMessageList>
</inMessageInbox>
</payload>
</confirmInMessageRequest>
Полная XML-схема пакета confirmInMessageRequest
<xsd:schema>
<xsd:element name="confirmInMessageRequest">
<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="inMessageInbox">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="inMessageList">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="inMessage" 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="inMessage"/>
<xsd:field xpath="@providerId"/>
</xsd:unique>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="code" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
Параметры пакета
Все параметры в таблице входят в объект payload.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
inMessageInbox/@code | String | Обязательный | Атрибут inMessageInbox, уникальный код ящика входящих сообщений, который сообщается клиенту на этапе подключения к платформе. |
inMessageInbox/inMessageList | Object | Необязательный | Объект, содержащий список сообщений. |
.../inMessageList/inMessage | Object | Необязательный | Объект, содержащий идентификатор сообщения. |
.../inMessage/@providerId | String | Обязательный | Идентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом. |
Пример пакета
<confirmInMessageRequest>
<header>
<auth>
<login>test</login>
<password>test</password>
</auth>
</header>
<payload>
<inMessageInbox code="default">
<inMessageList>
<inMessage providerId="101"/>
<inMessage providerId="102"/>
<inMessage providerId="103"/>
</inMessageList>
</inMessageInbox>
</payload>
</confirmInMessageRequest>
Пакет confirmInMessageResponse
Раздел payload пакета confirmInMessageResponse содержит код ответа платформы:
-
если код ответа свидетельствует об отсутствии ошибки, то возвращается подраздел
inMessageInbox,структура которого соответствует данным пакетаconfirmInMessageRequest; -
если код ответа свидетельствует об ошибке, значит запрос не был обработан.
inMessageInbox содержит код ответа на запрос по ящику входящих сообщений:
-
если код ответа свидетельствует об отсутствии ошибки, то секция
inMessageListсодержит список сообщений; -
если код ответа свидетельствует об ошибке, значит запрос по указанному ящику не был обработан.
Каждая подсекция inMessage содержит код ответа на запрос по соответствующему входящему сообщению:
-
если код ответа свидетельствует об отсутствии ошибки, то сообщение помечено как полученное;
-
если код ответа свидетельствует об ошибке, значит запрос по входящему сообщению не был обработан.
С труктура пакет
<confirmInMessageResponse>
<header/>
<payload>
<code>ok</code>
<inMessageInbox code="inbox0">
<code>ok</code>
<inMessageList>
<inMessage providerId="string">
<code>string</code>
</inMessage>
</inMessageList>
</inMessageInbox>
</payload>
</confirmInMessageResponse>
Полная XML-схема пакета confirmInMessageResponse
<xsd:schema>
<xsd:element name="confirmInMessageResponse">
<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-in-message-inbox-code-not-specified"/>
<xsd:enumeration value="error-in-message-inbox-code-format"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="inMessageInbox" minOccurs="0">
<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-in-message-inbox-code-unknown"/>
<xsd:enumeration value="error-in-message-id-not-specified"/>
<xsd:enumeration value="error-in-message-id-format"/>
<xsd:enumeration value="error-in-message-id-duplicate"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="inMessageList">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="inMessage" 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-in-message-id-unknown"/>
</xsd:restriction>
</xsd:simpleType>
</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="inMessage"/>
<xsd:field xpath="@providerId"/>
</xsd:unique>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="code" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
Параметры пакета
Все параметры в таблице входят в объект payload.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
code | String | Обязательный | Код результата обработки пакета confirmInMessageRequest.
Ответ на ошибочный пакет |
inMessageInbox/@code | String | Обязательный | Уникальный код ящика входящих сообщений, который сообщается клиенту на этапе подключения к платформе. |
inMessageInbox/code | String | Обязательный | Код ответа для ящика входящих сообщений. Коды ответов платформы при запросе сообщений |
inMessageInbox/inMessageList | Object | Необязательный | Объект, содержащий список сообщений. |
.../inMessageList/inMessage | Object | Необязательный | Объект, содержащий данные одного сообщения. Вложенные параметры указываются только в случае успешной обработки запроса. |
.../inMessage/@providerId | String | Обязательный | Идентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом. |
.../inMessage/code | String | Обязательный | Код ответа для входящего сообщения с указанным providerId.
Коды ответов платформы при подтверждении получения сообщений |
Пример пакета
<confirmInMessageResponse>
<header/>
<payload>
<code>ok</code>
<inMessageInbox code="inbox0">
<code>ok</code>
<inMessageList>
<inMessage providerId="101">
<code>ok</code>
</inMessage>
</inMessageList>
</inMessageInbox>
</payload>
</confirmInMessageResponse>
Коды ответов платформы при подтверждении получения сообщений
Код ответа платформы для ящика входящих сообщений возвращается в параметре code в подразделе inMessage.
| Код | Описание |
|---|---|
ok | Запрос обработан успешно. |
error-system | Системная ошибка. |
error-in-message-id-unknown | Входящее сообщение с указанным providerId не найдено в ящике входящих сообщений. |