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

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

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

Для чтения ответных сообщений пользователей в чатах укажите 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
}

Пример входящего сообщения со значением PRODUCT в параметре messageContent.type:

{
    "id": 803101,
    "subject": "test_subject_WA",
    "subjectId": 47610,
    "subscriber": {
        "id": 4633047,
        "identifier": "79997776655"
    },
    "userInfo": {
        "userName": "Иван Иванов",
        "firstName": null,
        "lastName": null,
        "avatarUrl": null
    },
    "messageContent": {
        "type": "PRODUCT",
        "attachment": null,
        "location": null,
        "caption": null,
        "text": "Hello",
        "payload": null,
        "story": null,
        "items": null,
        "contact": null,
        "product": {
            "id": "321",
            "catalogId": "123"
        },
        "catalog": null,
        "order": null
    },
    "receivedAt": "2024-08-05T08: 24: 14Z",
    "replyOutMessageId": null,
    "replyOutMessageExternalRequestId": null,
    "replyInMessageId": null
} 

Пример входящего сообщения со значением ORDER в параметре messageContent.type:

{
    "id": 804201,
    "subject": "test_subject_WA",
    "subjectId": 47610,
    "subscriber": {
        "id": 4633047,
        "identifier": "79997776655"
    },
    "userInfo": {
        "userName": "Иван Иванов",
        "firstName": null,
        "lastName": null,
        "avatarUrl": null
    },
    "messageContent": {
        "type": "ORDER",
        "attachment": null,
        "location": null,
        "caption": null,
        "text": null,
        "payload": null,
        "story": null,
        "items": null,
        "contact": null,
        "product": null,
        "catalog": null,
        "order": {
            "catalogId": "1022121105031922",
            "products": [
                {
                    "id": "111222",
                    "quantity": 2,
                    "price": 5,
                    "currency": "RUB"
                }
            ]
        }
    },
    "receivedAt": "2024-08-05T12:44:22Z",
    "replyOutMessageId": null,
    "replyOutMessageExternalRequestId": null,
    "replyInMessageId": null
} 

Примеры колбэков для входящих сообщений с параметром referral — позволяет получать информацию о месте, в котором клиент начал диалог в WhatsApp:

{
    "id": 115611,
    "subject": "test_WA",
    "subjectId": 195,
    "subscriber": {
        "id": 1111111,
        "identifier": "79000000000"
    },
    "userInfo": {
        "userName": "Anna",
        "firstName": null,
        "lastName": null,
        "avatarUrl": null
    },
    "messageContent": {
        "type": "TEXT",
        "attachment": null,
        "location": null,
        "referral": {
            "body": "This is a great product",
            "headline": "Our new product",
            "sourceId": "123",
            "sourceType": "ad",
            "sourceUrl": "https://www.fb.com"
        },
        "caption": null,
        "text": "text for test",
        "payload": null,
        "story": null,
        "items": null,
        "contact": null,
        "product": null,
        "catalog": null,
        "order": null
    },
    "receivedAt": "2024-01-11T11:20:00Z",
    "replyOutMessageId": null,
    "replyOutMessageExternalRequestId": null,
    "replyInMessageId": null
}

Пример колбэка для входящего сообщения со значением FLOW в параметре messageContent.type:

[
    {
        "id": 101,
        "subject": "test_subject_WA",
        "subjectId": 50520,
        "subscriber": {
            "id": 4633047,
            "identifier": "79997776655"
        },
        "userInfo": {
            "userName": "Иван Иванов",
            "firstName": null,
            "lastName": null,
            "avatarUrl": null
        },
        "messageContent": {
            "type": "FLOW",
            "attachment": null,
            "location": null,
            "referral": null,
            "caption": null,
            "text": "{\"flow_token\":\"example\"}",
            "payload": null,
            "story": null,
            "items": null,
            "contact": null,
            "product": null,
            "catalog": null,
            "order": null
        },
        "receivedAt": "2025-03-25T12:12:12Z",
        "replyOutMessageId": null,
        "replyOutMessageExternalRequestId": null,
        "replyInMessageId": null
    }
] 

[
    {
        "id": 101,
        "subject": "test_subject_WA",
        "subjectId": 50520,
        "subscriber": {
            "id": 4633047,
            "identifier": "79997776655"
        },
        "userInfo": {
            "userName": "Иван Иванов",
            "firstName": null,
            "lastName": null,
            "avatarUrl": null
        },
        "messageContent": {
            "type": "FLOW",
            "attachment": null,
            "location": null,
            "referral": null,
            "caption": null,
            "text": "{\"screen_0_Name_0\":\"Ivan\",\"screen_0_Order_number_1\":\"6\",\"screen_0_Choose_a_topic_2\":\"0_order\",\"flow_token\":\"example\"}",
            "payload": null,
            "story": null,
            "items": null,
            "contact": null,
            "product": null,
            "catalog": null,
            "order": null
        },
        "receivedAt": "2025-03-25T12:12:12Z",
        "replyOutMessageId": null,
        "replyOutMessageExternalRequestId": null,
        "replyInMessageId": null
    }
] 

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

Параметры ответа