Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
Salesforce Classic API
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Sample Visualforce Page Using the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods
Methods for Primary Tabs and Subtabs
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
fireOnCallBegin()
fireOnCallEnd()
fireOnCallLogSaved()
getCallAttachedData()
getCallObjectIds()
onCallBegin()
onCallEnd()
onCallLogSaved()
onSendCTIMessage()
sendCTIMessage()
setCallAttachedData()
setCallObjectIds()
Methods for Application-Level Custom Console Components
Methods for Push Notifications
Methods for Console Events
Methods for Chat
Methods for Omni-Channel
Other Resources
PDF

Newer Version Available

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

onCallBegin()

Registers a function that is called when a call begins (comes in). This method is for computer-telephony integration (CTI); it’s only available in API version 24.0 or later.

Syntax

Arguments

Name Type Description
eventHandler function JavaScript method called when a call begins.

Sample Code–Visualforce

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
id string The call object ID of the call which has begun.