Данный метод позволит вашему серверу прочитать ответное сообщение пользователя в чате. Например, после отправки пользователю HSM-сообщения с чат-кнопками, при нажатии одной из кнопок будет возвращён параметр payload (код кнопки, заданный при создании шаблона HSM-сообщения).
Вы можете также протестировать получение сообщений на тестовый номер телефона с помощью API edna для канала WhatsApp, не регистрируя собственный канал. Для этого перейдите на вкладку Тестирование в разделе Интеграция.
URL-адрес подключения
Для чтения ответных сообщений пользователей в чатах укажите API-endpoint вашей системы в ЛК при регистрации, который будет обрабатывать входящие POST запросы от API-edna.
Внимание: адрес должен начинаться с HTTPS (протокол HTTPS, порт 443).
Пример
- Пример полученного текстового сообщения
{ "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" }
- Пример сообщения-реакции, полученного в ответ на сообщение с интерактивным меню
{ "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" }
Параметры запроса
Параметр | Тип данных | Описание |
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) | Размер |
receivedAt | string | Дата и время получения |
Набор элементов, который возвращается в результате запроса, может быть дополнен на наше усмотрение, поэтому, пожалуйста, используйте элементы из списка, которые вам требуются.