Salesforce Console Integration Toolkit Developer's Guide

Introducing the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
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 Live Agent
Methods for Omni-Channel
Glossary
PDF

Newer Version Available

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

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

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

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.