Этот метод позволяет вашему серверу прочитать ответное сообщение пользователя в чате. Например, после отправки пользователю HSM-сообщения с чат-кнопками, при нажатии одной из кнопок возвращается параметр payload (код кнопки, указанный при создании шаблона HSM-сообщения).
Вы можете также протестировать получение сообщений на тестовый номер телефона с помощью API edna для канала WhatsApp, не регистрируя собственный канал. Для этого перейдите на вкладку Тестирование в разделе Интеграция.
URL-адрес подключения
Адрес должен начинаться с HTTPS (протокол HTTPS, порт 443).
Для чтения ответных сообщений пользователей в чатах укажите API Endpoint вашей системы в личном кабинете при регистрации, который будет обрабатывать входящие POST-запросы от API edna.
Примеры
Пример полученного текстового сообщения.
{ "id": 101, "subject": "test_subject_WA", "subjectId": 345, "subscriber": { "id": 202, "identifier": "79000000000" }, "userInfo": { "userName": "alex", "firstName": null, "lastName": null, "avatarUrl": null }, "messageContent": { "type": "TEXT", "attachment": null, "location": null, "caption": null, "text": "Спасибо за помощь", "payload": null, "story": null, "items": null }, "receivedAt": "2022-04-29T15:30:08Z", "replyOutMessageId": 5043874, "replyOutMessageExternalRequestId": "2c2dd5f1-5ad8-449d-9c38-b6bdf288f1e5", "replyInMessageId": null }
Пример сообщения-реакции, полученного в ответ на сообщение с интерактивным меню.
{ "id": 102, "subject": "test_subject_WA", "subjectId": 345, "subscriber": { "id": 202, "identifier": "79000000000" }, "userInfo": { "userName": "alex", "firstName": null, "lastName": null, "avatarUrl": null }, "messageContent": { "type": "LIST_PICKER", "attachment": null, "location": null, "caption": null, "text": null, "payload": null, "story": null, "items": [ { "identifier": "01", "title": "item 1", "subtitle": null } ] }, "receivedAt": "2022-04-29T15:27:40Z", "replyOutMessageId": null, "replyOutMessageExternalRequestId": null, "replyInMessageId": 537701 }
Параметры запроса
Параметр | Тип данных | Описание |
id | long | Идентификатор запроса. |
subject | string | Название подписи. |
subjectId | long | Идентификатор подписи. Можно узнать через метод получения списка каналов. |
subscriber | object | Информация об отправителе сообщения. |
subscriber.id | long | Идентификатор. |
subscriber.identifier | string | Номер телефона. |
userInfo | object | Информация о пользователе. |
userInfo.userName | string | Имя. |
userInfo.firstName | string | Фамилия. |
userInfo.lastName | string | Отчество. |
userInfo.avatarUrl | string | Аватар. |
messageContent | object | Информация о сообщении. |
messageContent.text | string (optional) | Текст сообщения. |
messageContent.type | string | Определяет тип сообщения. Может быть текст, кнопка, изображение, документ, аудио или видео. |
messageContent.caption | string (optional) | Название. |
messageContent.payload | string (optional) | Код кнопки. Указывается при создании HSM-шаблона. |
messageContent.items | object | Набор параметров, которые возвращаются в ответном сообщении от клиента, когда он реагирует на сообщение с интерактивным меню. Если сообщение клиента обычное (например, текст) и не является реакцией на сообщение с интерактивным меню, параметр возвращается следующим образом: messageContent.items = null . |
messageContent.items.title | string (required) | Название элемента исходного интерактивного меню. |
messageContent.items.subtitle | string (optional) | Подзаголовок элемента исходного интерактивного меню. |
messageContent.items.identifier | integer (optional) | Сквозной для всего сообщения ID элемента, вернется в ответном сообщении пользователя. |
messageContent.location | object (optional) | Адрес локации. |
messageContent.attachment | object (optional) | null или данные документа. |
messageContent.attachment.url | string (optional) | URL прикрепленного изображения, документа или видео. |
messageContent.attachmentname | string (optional) | Название прикрепленного изображения, документа или видео. |
messageContent.attachmentsize | string (optional) | Размер. |
messageContent.contact | object (optional) | Карточка контакта, состоящая из полей: имя, фамилия, мобильный телефон. |
contact.firstName | string (optional) | Имя в карточке контакта. |
contact.lastName | string (optional) | Фамилия в карточке контакта. |
contact.phoneNumber | string (optional) | Мобильный телефон в карточке контакта. |
receivedAt | string | Дата и время получения. |
replyInMessageId | long | Внутренний идентификатор цитируемого сообщения пользователя. Пользователь цитирует своё сообщение, отправленное компании. |
replyOutMessageId | long | Внутренний идентификатор цитируемого сообщения компании. Пользователь цитирует сообщение, полученное от компании. |
replyOutMessageExternalRequestId | long | Внешний идентификатор цитируемого сообщения компании, который она указывает при отправке исходящего сообщения по API. В том случае, если пользователь процитировал сообщение, полученное от компании. |
Вы можете дополнить набор элементов, которые возвращаются в результате запроса. Для этого используйте необходимые элементы из списка.