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.
| 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. |
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. |