Receiving Messages

This method helps your server read a client’s response message in the chat. For example, if a client received an HSM message with chat buttons, if they click one of them, the payload parameter will be returned (the code button that was set when creating a template for the HSM message).

URL

For your server to be able to read response messages, during registration, you need to specify your system’s API endpoint that will process incoming POST requests from edna API.

Only the HTTPS protocol is supported, so the address must start with HTTPS, port 443.

Request Example

• Example of a received text message

{
    "id": 101,
    "subject": "test_subject_WA",
    "subjectId": 234,
    "subscriber": {
        "id": 202,
        "identifier": "79000000000"
    },
    "userInfo": {
        "userName": "alex",
        "firstName": null,
        "lastName": null,
        "avatarUrl": null
    },
    "messageContent": {
        "type": "TEXT",
        "attachment": null,
        "location": null,
        "caption": null,
        "text": "Thank you for your help",
        "payload": null,
        "story": null,
        "items": null
    },
    "receivedAt": "2022-04-29T15:30:08Z"
}

• Example of a received message that is a response to a message with an interactive menu

{
    "id": 102,
    "subject": "test_subject_WA",
    "subjectId": 234,
    "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"
}

Request Parameters