Salesforce Console 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.
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
1<apex:page>
2 <apex:includeScript value="/support/console/68.0/integration.js"/>
3 <script type="text/javascript">
4
5 var callback = function (result) {
6 if (result.success) {
7 alert('CTI message was sent successfully!');
8 } else {
9 alert('CTI message was not sent successfully.');
10 }
11 };
12
13 //Note that we are using the CTI submodule here
14 sforce.console.cti.sendCTIMessage('/ANSWER?LINE_NUMBER=1', callback);
15 </script>
16</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. |