ChatEnd

Indicates that a chat visitor has ended the chat.

This resource is available in API versions 29.0 and later.

URI

https://HOSTNAME/chat/rest/Chasitor/ChatEnd

Where HOSTNAME is a variable.

Formats

JSON

HTTP methods

POST

Request headers

X-LIVEAGENT-API-VERSION

X-LIVEAGENT-AFFINITY

X-LIVEAGENT-SESSION-KEY

X-LIVEAGENT-SEQUENCE

Request parameters

None

Query parameters

None

Request body

ChatEndReason—Include the ChatEndReason parameter in the request body of your request to specify the reason that the chat ended. This parameter is required. For example: {reason: "client"}.

Response properties

attachedRecords—Includes attached record IDs. You can use this Visualforce component to display the attached record IDs in the post-chat page: <apex:outputText value="{!$CurrentPage.parameters.attachedRecords}"/><br />.