Chat REST API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
ChatEnd
Indicates that a chat visitor has ended the chat.
Syntax
- URI
- https://hostname/chat/rest/Chasitor/ChatEnd
- Available since release
- This resource is available in API versions 29.0 and later.
- 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 />.