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)

FieldTypeDescription
paramobjectParameters associated with the call info.
param.acceptEnabledbooleanIndicates whether the accept call button is enabled.
param.addCallerEnabledbooleanIndicates whether the add caller button is enabled.
param.callStateTimestampdateThe call timestamp.
param.conferenceEnabledbooleanIndicates whether the merge button is enabled.
param.declineEnabledbooleanIndicates whether the decline call button is enabled.
param.extensionEnabledbooleanIndicates whether an extension is enabled.
param.holdEnabledbooleanIndicates whether the hold button is enabled.
param.initialCallIdstringInitial voice call ID.
param.isBargeablebooleanReserved for future use.
param.isMutedbooleanIndicates whether the call is on mute.
param.isOnHoldbooleanIndicates whether the call is on hold.
param.isRecordingPausedbooleanIndicates whether the recording is paused.
param.isReplayablebooleanIndicates whether the call is replayable.
param.isSoftphoneCallbooleanIndicates whether this call is made with a softphone.
param.muteEnabledbooleanIndicates whether the mute button is enabled.
param.recordEnabledbooleanIndicates whether the toggle recording button is enabled.
param.removeParticipantVariantstringDescribes 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.renderContactIdstringIndicates the contact ID of the call intended to render.
param.showMuteButtonbooleanIndicates whether to show the mute button. Default value is true.
param.showRecordButtonbooleanIndicates whether to show the record button. Default value is true.
param.showAddCallerButtonbooleanIndicates whether to show the add caller button. Default value is true.
param.showAddBlindTransferButtonbooleanIndicates whether to show the blind transfer button. Default value is true.
param.showMergeButtonbooleanIndicates whether to show the merge button. Default value is true.
param.showSwapButtonbooleanIndicates whether to show the swap button. Default value is true.
param.swapEnabledbooleanIndicates whether the swap button is enabled.
param.queueIdstringThe unique ID of the queue taken from the telephony provider’s side.
param.queueNamestringThe name of the queue that appears in the call record.
param.queueTimestampdateThe date and time (in UTC) when the call entered the queue. Measured in milliseconds since the Unix epoch.
param.endCallDisabledbooleanIndicates 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.