Newer Version Available

This content describes an older version of this product. View Latest

acceptChat()

Accepts a chat request. Available in API version 29.0 or later.

Syntax

1sforce.console.chat.acceptChat(chatKey:String, (optional)callback:Function)

Arguments

Name Type Description
chatKey String The chat key for the chat request you wish to accept.
callback function JavaScript method called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18    <apex:includeScript value="/support/console/29.0/integration.js"/>
19    <a href="#" onClick="testAcceptChat();return false;">Accept Chat</a> 
20
21    <script type="text/javascript">
22        function testAcceptChat() {
23            //Get the value for 'myChatKey'from the getChatRequests() or onChatRequested() methods. 
24            //These values are for example purposes only
25            var chatKey = 'myChatKey';
26            sforce.console.chat.acceptChat(chatKey, acceptSuccess);
27        }
28        
29        function acceptSuccess(result) {
30            //Report whether accepting the chat was succesful
31            if (result.success == true) {
32                alert('Accepting the chat was successful');
33            } else {
34                alert('Accepting the chat was not successful');
35            }
36        };
37    </script>
38</apex:page>

Response

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:

Name Type Description
success Boolean true if accepting the chat was successful; false if accepting the chat wasn’t successful.