Salesforce Console Developer Guide
jNewer Version Available
endChat()
Ends a chat in which an agent is currently engaged. Available in API version 29.0 or
later.
Syntax
1sforce.console.chat.endChat(chatKey:String, (optional)callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| chatKey | String | The chat key for the engaged chat you wish to end. |
| callback | function | JavaScript method called upon completion of the method. |
Sample Code–Visualforce
1<apex:page>
2 <apex:includeScript value="/support/console/48.0/integration.js"/>
3 <a href="#" onClick="testEndChat();return false;">End Chat</a>
4
5 <script type="text/javascript">
6 function testEndChat() {
7 //Get the value for 'myChatKey'from the getEngagedChats() or onChatStarted() methods.
8 //These values are for example purposes only
9 var chatKey = 'myChatKey';
10 sforce.console.chat.endChat(chatKey, endSuccess);
11 }
12
13 function endSuccess(result) {
14 //Report whether ending the chat was succesful
15 if (result.success == true) {
16 alert('Ending the chat was successful');
17 } else {
18 alert('Ending the chat was not successful');
19 }
20 };
21 </script>
22</apex:page>