Получение сообщений

Данный метод позволит вашему серверу прочитать ответное сообщение пользователя в чате. Например, после отправки пользователю HSM-сообщения с чат-кнопками, при нажатии одной из кнопок будет возвращён параметр payload (код кнопки, заданный при создании шаблона HSM-сообщения).

URL-адрес подключения

Для чтения ответных сообщений пользователей в чатах укажите API-endpoint вашей системы в ЛК при регистрации, который будет обрабатывать входящие POST запросы от API-edna. Внимание, адрес должен начинаться с HTTPS (протокол HTTPS , порт 443).

Пример

[
    {
        "id": 101,
        "subject": "test_subject_WA",
        "subscriber": {
            "id": 202,
            "identifier": "79000000000"
        },
        "userInfo": {
            "userName": "alex",
            "firstName": null,
            "lastName": null,
            "avatarUrl": null
        },
        "messageContent": {
            "type": "TEXT",
            "attachment": null,
            "location": null,
            "caption": null,
            "text": "Test in",
            "payload": null
        },
        "receivedAt": "2021-01-21T08:00:00Z"
    }
]

Параметры запроса

ПараметрТип данныхОписание
idlongИдентификатор запроса
subjectstringПодпись
subscriberobject Информация об отправителе сообщения
subscriber.idlongИдентификатор
subscriber.identifierstringНомер телефона
userInfoobjectИнформация о пользователе
userInfo.userNamestringИмя
userInfo.firstNamestringФамилия
userInfo.lastNamestringОтчество
userInfo.avatarUrlstringАватар
messageContentstringИнформация о сообщении
messageContent.idstringИдентификатор сообщения. Генерируется сторонней системой, после чего значение должно быть передано в запрос
messageContent.textstring
(optional)
Текст сообщения
messageContent.typestringОпределяет тип сообщения. Может быть текст, кнопка, изображение, документ, аудио или видео
messageContent.captionstring
(optional)
Название
messageContent.payloadstring
(optional)
Код кнопки. Указывается при создании HSM шаблона
messageContent.locationobject (optional)Адрес локации
messageContent.attachmentobject (optional)null или данные документа
messageContent.attachment.urlstring
(optional)
URL прикрепленного изображения\документа\видео
messageContent.attachmentnamestring
(optional)
Название прикрепленного изображения\документа\видео
messageContent.attachmentsizestring
(optional)
Размер
receivedAtstringДата и время получения
Отправка сообщений
Cледующая статья Получение информации о каскадах