fireOnCallBegin()

Fires an event that notifies a call has begun. Use to get information or send information between an interaction log and a custom console component. This method is only available in API version 31.0 or later.

Syntax

1sforce.console.cti.fireOnCallBegin( callObjectId:String, callType:String, callLabel:String, (optional)callback:Function )

Arguments

Name	Type	Description
callObjectId	string	The object ID of the call.
callType	string	String that specifies the call type, which must be `internal`, `inbound` or `outbound`.
callLabel	string	String that specifies a call as it appears in the Attach Call drop-down button. For example, `Call Label — Inbound Call 12:52:31 PM`.
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    <A HREF="#" onClick="testFireOnCallBegin();return false">
19             Click here to start a call</A>
20
21    <apex:includeScript value="/support/console/31.0/integration.js"/>
22    <script type="text/javascript">
23
24        function testFireOnCallBegin() {
25            sforce.console.cti.fireOnCallBegin('call.794937' , 'outbound' , 'label 1');
26        }
27
28    </script>
29</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 firing the event is successful, `false` otherwise.

Salesforce Console Integration Toolkit Developer's Guide

fireOnCallBegin()

Syntax

Arguments

Sample Code–Visualforce

Response