Получение входящих сообщений методом обратного вызова
Для передачи входящих сообщений методом обратного вызова служит пакет consumeInMessageRequest.
Пакет consumeInMessageRequest
Пакет направляется от провайдера к клиенту по указанному заранее адресу. В заголовке пакета передается секция auth с логином и паролем для авторизации запроса на стороне клиента.
Структура пакета
<consumeInMessageRequest>
<header>
<auth><!--параметры аутентификации на стороне клиента--></auth>
</header>
<payload>
<inMessageList>
<inMessage providerId="134604">
<subject>TEST_LOOP</subject>
<address>79950993734</address>
<receivedAt>2021-04-07 00:24:23</receivedAt>
<contentType>text</contentType>
<content>test 700</content>
</inMessage>
</inMessageList>
</payload>
</consumeInMessageRequest>
Параметры пакета
к сведению
Все параметры в таблице входят в объект payload.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
inMessageList | Object | Обязательный | Объект, содержащий список сообщений. |
inMessageList/inMessage | Object | Обязательный | Объект, содержащий данные одного сообщения. |
.../inMessage/@providerId | String | Обязательный | Идентификатор сообщения на стороне платформы. Значение уникально на протяжении всего времени взаимодействия между провайдером и клиентом. |
.../inMessage/subject | String | Обязательный | Подпись сообщения, выданная клиенту на этапе регистрации канала на платформе. |
.../inMessage/address | Address | Обязательный | Номер мобильного телефона получателя в формате E.164. |
.../inMessage/receivedAt | Datetime | Обязательный | Дата и время получения входящего сообщения провайдером. |
.../inMessage/contentType | String | Обязательный | Тип содержимого сообщения. Допустимое значение: text — текстовое сообщение. |
.../inMessage/content | String | Обязательный | Информационное содержание сообщения. |
Пример пакета
<consumeInMessageRequest>
<header>
<auth>
<login>test</login>
<password>test</password>
</auth>
</header>
<payload>
<inMessageList>
<inMessage providerId="134604">
<subject>TEST_LOOP</subject>
<address>79950993734</address>
<receivedAt>2021-04-07 00:24:23</receivedAt>
<contentType>text</contentType>
<content>test 700</content>
</inMessage>
</inMessageList>
</payload>
</consumeInMessageRequest>
Пакет consumeInMessageResponse
В ответ на callback-запрос отправляется пакет consumeInMessageResponse.
warning
В ответе на запрос consumeInMessageRequest должен быть передан код 200 с телом пакета consumeInMessageResponse.
подсказка
Для назначения URL обратного вызова отправьте запрос в службу поддержки.
Структура пакета
<consumeInMessageResponse>
<header/>
<payload>
<code>String</code>
</payload>
</consumeInMessageResponse>
Параметры пакета
к сведению
Все параметры в таблице входят в объект payload.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
code | String | Обязательный | Код результата обработки пакета consumeInMessageRequest.
Ответ на ошибочный пакет |
Пример пакета
<consumeInMessageResponse>
<header/>
<payload>
<code>ok</code>
</payload>
</consumeInMessageResponse>