CallInfo
Represents information about a call such as whether it is a softphone call, call control buttons are enabled and so on, using key value pairs in a JSON object. The field values can be sent at the start of the call or during an ongoing call.
new CallInfo(param)
| Field | Type | Description |
|---|---|---|
| param | object | Parameters associated with the call info. |
| param.acceptEnabled | boolean | Indicates whether the accept call button is enabled. |
| param.addCallerEnabled | boolean | Indicates whether the add caller button is enabled. |
| param.callStateTimestamp | date | The call timestamp. |
| param.conferenceEnabled | boolean | Indicates whether the merge button is enabled. |
| param.declineEnabled | boolean | Indicates whether the decline call button is enabled. |
| param.extensionEnabled | boolean | Indicates whether an extension is enabled. |
| param.holdEnabled | boolean | Indicates whether the hold button is enabled. |
| param.initialCallId | string | Initial voice call ID. |
| param.isBargeable | boolean | Reserved for future use. |
| param.isMuted | boolean | Indicates whether the call is on mute. |
| param.isOnHold | boolean | Indicates whether the call is on hold. |
| param.isRecordingPaused | boolean | Indicates whether the recording is paused. |
| param.isReplayable | boolean | Indicates whether the call is replayable. |
| param.isSoftphoneCall | boolean | Indicates whether this call is made with a softphone. |
| param.muteEnabled | boolean | Indicates whether the mute button is enabled. |
| param.recordEnabled | boolean | Indicates whether the toggle recording button is enabled. |
| param.removeParticipantVariant | string | Describes the remove participant button functionality. Possible values: ALWAYS (button is always enabled), NEVER (button is always disabled), ALWAYS_EXCEPT_ON_HOLD (button is disabled when the participant is on hold). |
| param.renderContactId | string | Indicates the contact ID of the call intended to render. |
| param.showMuteButton | boolean | Indicates whether to show the mute button. Default value is true. |
| param.showRecordButton | boolean | Indicates whether to show the record button. Default value is true. |
| param.showAddCallerButton | boolean | Indicates whether to show the add caller button. Default value is true. |
| param.showAddBlindTransferButton | boolean | Indicates whether to show the blind transfer button. Default value is true. |
| param.showMergeButton | boolean | Indicates whether to show the merge button. Default value is true. |
| param.showSwapButton | boolean | Indicates whether to show the swap button. Default value is true. |
| param.swapEnabled | boolean | Indicates whether the swap button is enabled. |
| param.queueId | string | The unique ID of the queue taken from the telephony provider’s side. |
| param.queueName | string | The name of the queue that appears in the call record. |
| param.queueTimestamp | date | The date and time (in UTC) when the call entered the queue. Measured in milliseconds since the Unix epoch. |
| param.endCallDisabled | boolean | Indicates whether the End Call button in the softphone is disabled (true) or enabled (false) for a call. By default, this value is false, meaning the End Call button is enabled for an active call. If true, the End Call button is disabled until enabled back for an active call. |