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.

NameTypeDescription
callObjectIdstringThe object ID of the call.
callTypestringString that specifies the call type, which must be internal, inbound or outbound.
callLabelstringString that specifies a call as it appears in the Attach Call drop-down button. For example, Call Label — Inbound Call 12:52:31 PM.
callbackfunctionJavaScript method called upon completion of the method.

This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field:

NameTypeDescription
successbooleantrue if firing the event is successful, false otherwise.