Namespace call
Defined in: supplementaldocs.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Field Attributes | Field Name and Description |
|---|---|
|
Audio is muted.
|
|
|
Unique identifier of the call.
|
|
|
Current state of the call.
|
|
|
One of the following:
|
|
|
A map that has capability name as the key and true as the value.
|
|
|
true if the call exists.
|
|
|
true if the call is a conference call.
|
|
|
Local participant (your line info).
|
|
|
Numeric representation of callState - subject to change, do not use.
|
|
|
Remote participant (first entry in participants list).
|
|
|
Array of all remote participants on the call.
|
|
|
The new Date() when the conversationStart.cwic event was fired for the call.
|
|
|
One of the following:
|
|
|
Video is muted.
|
|
|
Contains video resolution width and height values (in pixels).
|
Field Detail
{Boolean}
audioMuted
Audio is muted.
{Number}
callId
Unique identifier of the call.
{String}
callState
Current state of the call. May be one of the following:
- "OffHook" - receiver lifted in CTI control mode, or preparing to make a call in either mode.
- "OnHook" - call is ended or about to go OffHook. If !capabilities.canOriginateCall, then call is ended.
- "Ringout" - remote party is ringing.
- "Ringin" - incoming call.
- "Proceed" - if already on a call in CTI mode and there's an incoming call it may be in "Proceed" state.
- "Connected" - call is connected.
- "Hold" - call is held.
- "RemHold" - call is held on a shared-line device.
- "Resume" - n/a.
- "Busy" - remote line busy.
- "Reorder" - call failed.
- "Conference"
- "Dialing" - dialing number.
- "RemInUse" - call on a shared-line device.
- "HoldRevert"
- "Whisper"
- "Parked"
- "ParkRevert"
- "ParkRetrieved"
- "Preservation" - call is in preservation mode.
- "WaitingForDigits"
- "Spoof_Ringout"
{String}
callType
One of the following:
- "Placed"
- "Received"
- "Missed"
{callcapability[]}
capabilities
A map that has capability name as the key and true as the value.
Call capabilities indicate operations you can perform on the call, and they should be used to control enabling/disabling/state/access to parts of the UI. Important capabilities are:
- canOriginateCall - can create new call
- canAnswerCall - call can be answered
- canHold - call can be Held
- canResume - call can be Resumed
- canEndCall - call can be Ended
- canSendDigit - can send a DTMF digit to the call
- canDirectTransfer - can tranfer call
- canJoinAcrossLine - can join this call with another call on the same line with this capability also set
- canImmediateDivert - can iDivert (e.g. to voicemail)
- canUpdateVideoCapability - can update the videoDirection on the call. See $.fn.cwic-updateConversation examples.
- canMuteAudio - can mute audio on the call
- canUnmuteAudio - can unmute audio on the call
- canMuteVideo - can mute video on the call
- canUnmuteVideo - can unmute video on the call
{Boolean}
exists
true if the call exists.
{Boolean}
isConference
true if the call is a conference call.
{participant}
localParticipant
Local participant (your line info).
{Number}
numericState
Numeric representation of callState - subject to change, do not use.
{participant}
participant
Remote participant (first entry in participants list).
{participant[]}
participants
Array of all remote participants on the call.
{Date}
start
The new Date() when the conversationStart.cwic event was fired for the call.
{String}
videoDirection
One of the following:
- "Inactive"
- "SendRecv"
- "SendOnly"
- "RecvOnly"
{Boolean}
videoMuted
Video is muted.
{Object}
videoResolution
Contains video resolution width and height values (in pixels). Included in the Call object any time the resolution changes.