Newer Version Available

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

sendCTIMessage()

Sends a message to the CTI adapter or Open CTI. This method is for computer-telephony integration (CTI); it’s only available in API version 24.0 or later.

Syntax

1sforce.console.cti.sendCTIMessage( msg, (optional) callback:Function )

Arguments

Name Type Description
msg string Message to send to the adapter.
callback function JavaScript method called when the message is sent.

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/24.0/integration.js"/>
19     <script type="text/javascript">
20
21           var callback = function (result) {
22              if (result.success) {
23                 alert('CTI message was sent successfully!');
24             } else {
25                 alert('CTI message was not sent successfully.');
26               }
27           };
28
29          //Note that we are using the CTI submodule here
30           sforce.console.cti.sendCTIMessage('/ANSWER?LINE_NUMBER=1', callback);
31     </script>
32</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 field:

Name Type Description
success boolean true if sending the message was successful; false if sending the message wasn’t successful.