List conversation messages

All API requests should contain authorization headers.

Request

GET chat/conversations/{id}/messages

Query parameters

FieldTypeRequiredComments

orderBy

Order by enumeration

false

Indicates the order of messages in the dialogue.

If set to creation_time_asc value, the system retrieves the earliest 100 messages; if set to creation_time_desc, it retrieves the latest 100 messages.

The default value is creation_time_desc

skip

integer

true

Default value equal 0

take

integer

true

Maximum value equal 100. A default value equal 100

Response

{
    "data": [
        {
            "author": {
                "email": "john@dow.com",
                "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20",
                "image": null,
                "isBot": false,
                "name": "John",
                "status": "client"
            },
            "creationTime": "2023-08-22T14:50:07.21+00:00",
            "id": 667155,
            "lastModifiedTime": "2023-09-01T15:03:59.81+00:00",
            "message": "This is an external message created on a third-party platform"
        },
        {
            "author": {
                "email": "john@dow.com",
                "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20",
                "image": null,
                "isBot": false,
                "name": "John",
                "status": "client"
            },
            "creationTime": "2023-08-22T14:50:15.21+00:00",
            "id": 667156,
            "lastModifiedTime": "2023-09-01T15:03:59.81+00:00",
            "message": "And this is another message from third-party platform"
        }
    ],
    "errorCode": -1,
    "errorText": null
}

The Data field contains an array of Conversation message objects.

Last updated