Receiving Messages

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

Connection URL

In order for your server to be able to read response messages, you should specify your system’s API endpoint during registration, which will handle incoming POST requests from the edna API.

Request Example

An 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"
}

An 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