Conversation

Example

{
    "author": 
    {
        "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20",
        "name": "John",
        "image": null,
        "email": "[email protected]",
        "status": "client",
        "isBot": false
    },
    "creationTime": "2023-09-01T12:56:39.0847826+03:00",
    "feedback": null,
    "fields": [],
    "id": 254626,
    "initialPageUrl": "https://faq.socialboards.com/socialboards",
    "isClosed": false,
    "isTakeoverEnabled": true,
    "lastModifiedTime": "2023-09-01T12:56:39.0847826+03:00",
    "latestPageUrl": "https://faq.socialboards.com/socialboards",
    "messages": [
        {
            "author": {
                "id": "fc2481f6-28a4-4ca7-849a-344fd6ab1b20",
                "name": "John",
                "image": null,
                "email": "[email protected]",
                "status": "client",
                "isBot": false
            },
            "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"
        }
    ],
    "queuePositionInfo": 
    {
        "position": 1403,
        "waitTime": 15
    },
    "totalMessagesCount": 1
}

Fields

Field	Type	Comments
author	User model	Conversation author
creationTime	string	Conversation creation time
feedback	ConversationFeedback model	Client satisfaction from conversation
fields	array of Custom Field Id with Value models	Conversation additional fields
id	integer	Conversation unique id
initialPageUrl	string	Represents the URL of the page where the conversation began
isClosed	boolean	If true, it indicates that the conversation is closed by agent or ended by client
isTakeoverEnabled	boolean	If true, it indicates that the conversation in takeover mode
lastModifiedTime	string	Conversation last modified time
latestPageUrl	string	Represents the URL of the latest page where the conversation is taking place
messages	array of ConversationMessage models	Conversation messages
queuePositionInfo	ConversationPositionInfo model	Current position of conversation in the system. If -1 conversation not in queue and currently processed by agent
totalMessagesCount	integer	Total messages in conversation