Get conversation by id

All API requests should contain authorization headers.

Request

GET chat/conversations/{id}

Query parameters

Name

Type

Required

Comments

includeMessages

boolean

false

By default is false

orderyBy

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

Response

{
    "data": {
        "author": {
            "email": "john@dow.com",
            "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20",
            "image": null,
            "isBot": false,
            "name": "John",
            "status": "client"
        },
        "creationTime": "2023-09-01T12:56:39.0847826+03:00",
        "feedback": null,
        "id": 254626,
        "isClosed": false,
        "isTakeoverEnabled": true,
        "lastModifiedTime": "2023-09-01T12:56:39.0847826+03:00",
        "messages": [
            {
                "author": {
                    "email": null,
                    "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20",
                    "image": null,
                    "isBot": false,
                    "name": "John",
                    "status": "client"
                },
                "creationTime": "2023-09-01T12:56:39.0847826+03:00",
                "id": 0,
                "lastModifiedTime": "2023-09-01T12:56:39.0847826+03:00",
                "message": "Hi, I have some questions about the Chat API"
            },
            {
                "author": {
                    "email": "john@dow.com",
                    "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20",
                    "image": null,
                    "isBot": false,
                    "name": "John",
                    "status": "client"
                },
                "creationTime": "2023-09-01T12:58:39.0847826+03:00",
                "id": 667151,
                "lastModifiedTime": "2023-09-01T12:58:39.0847826+03: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-09-01T13:03:49.0847826+03:00",
                "id": 667154,
                "lastModifiedTime": "2023-09-01T13:03:49.0847826+03:00",
                "message": "And this is another message from third-party platform"
            }
        ],
        "queuePositionInfo": 
        {
            "position": 1403,
            "waitTime": 15
        },
        "totalMessagesCount": 3
    },
    "errorCode": -1,
    "errorText": null
}

Data field has type of Conversation object.

PreviousAdd messages to conversation NextList conversation messages

Last updated 1 year ago

Was this helpful?

{ "data": { "author": { "email": "john@dow.com", "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20", "image": null, "isBot": false, "name": "John", "status": "client" }, "creationTime": "2023-09-01T12:56:39.0847826+03:00", "feedback": null, "id": 254626, "isClosed": false, "isTakeoverEnabled": true, "lastModifiedTime": "2023-09-01T12:56:39.0847826+03:00", "messages": [ { "author": { "email": null, "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20", "image": null, "isBot": false, "name": "John", "status": "client" }, "creationTime": "2023-09-01T12:56:39.0847826+03:00", "id": 0, "lastModifiedTime": "2023-09-01T12:56:39.0847826+03:00", "message": "Hi, I have some questions about the Chat API" }, { "author": { "email": "john@dow.com", "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20", "image": null, "isBot": false, "name": "John", "status": "client" }, "creationTime": "2023-09-01T12:58:39.0847826+03:00", "id": 667151, "lastModifiedTime": "2023-09-01T12:58:39.0847826+03: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-09-01T13:03:49.0847826+03:00", "id": 667154, "lastModifiedTime": "2023-09-01T13:03:49.0847826+03:00", "message": "And this is another message from third-party platform" } ], "queuePositionInfo": { "position": 1403, "waitTime": 15 }, "totalMessagesCount": 3 }, "errorCode": -1, "errorText": null }