getCallObjectIds()

Usage

Returns any active call object IDs in the order in which they arrived or null if there aren’t any active calls. This method is for computer-telephony integration (CTI); it’s only available in API version 24.0 or later.

Syntax

1sforce.console.cti.getCallObjectIds( (optional) callback:Function )

Arguments

Name	Type	Description
callback	function	JavaScript method called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<apex:page>
2    <apex:includeScript value="/support/console/24.0/integration.js"/>
3     <script type="text/javascript">
4
5          var callback = function (result) {
6              alert('Active call object ids: ' + result.ids);
7          };
8
9          //Note that we are using the CTI submodule here
10          sforce.console.cti.getCallObjectIds(callback);
11     </script>
12</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 fields:

Name	Type	Description
ids	string	The call object IDs of active calls or null if no call is active.
success	boolean	`true` if returning the active call object IDs was successful; `false` if returning the active call object IDs wasn’t successful.

Salesforce Console Integration Toolkit Developer's Guide