Получение входящих сообщений
Для получения входящих сообщений клиент отправляет запрос provideInMessageRequest. В ответ провайдер отправляет клиенту пакет provideInMessageResponse.
Пакет provideInMessageRequest
При подключении клиента к платформе провайдер выделяет ему ящик для входящих сообщений. Раздел payload пакета provideInMessageRequest содержит подраздел inMessageInbox с кодом этого ящика.
После получения пакета provideInMessageResponse клиент должен отправить п акет confirmInMessageRequest для подтверждения получения входящих сообщений. В противном случае, при следующей отправке пакета provideInMessageRequest клиент получит те же сообщения.
Структура пакета
<provideInMessageRequest>
<header><!--параметры аутентификации клиента--></header>
<payload>
<inMessageInbox code="string"/>
</payload>
</provideInMessageRequest>
Полная XML-схема пакета provideInMessageRequest
<xsd:schema>
<xsd:element name="provideInMessageRequest">
<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" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<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, уникальный код ящика входящих сообщений, который сообщается клиенту на этапе подключения к платформе. |
Пример пакета
<provideInMessageRequest>
<header>
<auth>
<login>test</login>
<password>test</password>
</auth>
</header>
<payload>
<inMessageInbox code="default"/>
</payload>
</provideInMessageRequest>
Пакет provideInMessageResponse
Раздел payload пакета provideInMessageResponse содержит код ответа платформы:
-
если код ответа свидетельствует об отсутствии ошибки, то возвращается подраздел
inMessageInboxс данными о входящих сообщениях; -
если код ответа свидетельствует об ошибке, значит запрос не был обработан.
inMessageInbox содержит код ответа на запрос по ящику входящих сообщений:
-
если код ответа свидетельствует об отсутствии ошибки, то секция
inMessageListсодержит список непрочитанных сообщений; -
если код ответа свидетельствует об ошибке, значит запрос на получения входящих сообщений по указанному ящику не был обработан.
Структура пакета
<provideInMessageResponse>
<header/>
<payload>
<code>ok</code>
<inMessageInbox code="string">
<code>string</code>
<inMessageList>
<inMessage providerId="string">
<receivedAt>datetime</receivedAt>
<subject>string</subject>
<address>address</address>
<contentType>string</contentType>
<content type="text">balance</content>
</inMessage>
</inMessageList>
</inMessageInbox>
</payload>
</provideInMessageResponse>
Полная XML-схема пакета provideInMessageResponse
<xsd:schema>
<xsd:element name="provideInMessageResponse">
<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" 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-inbox-code-unknown"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="inMessageList" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="inMessage" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:all>
<xsd:element name="receivedAt" type="dateTimeType"/>
<xsd:element name="subject" type="xsd:string"/>
<xsd:element name="address">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:pattern value="\d{11,15}"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="contentType" type="contentTypeType"/>
<xsd:element name="content" type="xsd:string"/>
</xsd:all>
<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:simpleType name="contentTypeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="text"/>
</xsd:restriction>
</xsd:simpleType>
<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 | Обязательный | Код результата обработки пакета provideInMessageRequest.
Ответ на ошибочный пакет. |
inMessageInbox/@code | String | Обязательный | Уникальный код ящика входящих сообщений, который сообщается клиенту на этапе подключения к платформе. |
inMessageInbox/code | String | Обязательный | Код ответа для ящика входящих сообщений. Коды ответов платформы при запросе сообщений |
inMessageInbox/inMessageList | Object | Необязательный | Объект, содержащий список сообщений. |
.../inMessageList/inMessage | Object | Необязательный | Объект, содержащий данные одного сообщения. Вложенные параметры указываются только в случае успешной обработки запроса. |
.../inMessage/@providerId | String | Обязательный | Идентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом. |
.../inMessage/receivedAt | Datetime | Обязательный | Дата и время получения входящего сообщения провайдером. |
.../inMessage/subject | String | Обязательный | Подпись сообщения, выданная клиенту на этапе регистрации канала на платформе. |
.../inMessage/address | Address | Обязательный | Номер мобильного телефона получателя в формате E.164. |
.../inMessage/contentType | String | Обязательный | Тип содержимого сообщения. Допустимое значение: text — текстовое сообщение. |
.../inMessage/content | String | Обязательный | Информационное содержание сообщения. |
Пример пакета
<provideInMessageResponse>
<header/>
<payload>
<code>ok</code>
<inMessageInbox code="default">
<code>ok</code>
<inMessageList>
<inMessage providerId="101">
<receivedAt>2007-11-29 00:00:00</receivedAt>
<subject>79031112233</subject>
<address>79035555555</address>
<contentType>text</contentType>
<content type="text">balance</content>
</inMessage>
<inMessage providerId="102">
<receivedAt>2007-11-29 00:00:00</receivedAt>
<subject>79031112233</subject>
<address>79035555555</address>
<contentType>text</contentType>
<content>balance</content>
</inMessage>
</inMessageList>
</inMessageInbox>
</payload>
</provideInMessageResponse>