Interface ICall

This will hold information about each call object obtained using sidebar.getCalls() method

Hierarchy

  • ICall

Properties

callType disconnectReason? id localParticipant remoteParticipants state

Properties

Readonly callType

callType: CALL_TYPE

Type of call.

It can be one of the following,

  • "Placed"

  • "Received"

Optional Readonly disconnectReason

disconnectReason?: DISCONNECT_REASON

Reason for call disconnection. Only present when state is "Disconnected" or "Ended".

It can be one of the following,

  • "LocalUser" - ended or declined by this user on this device

  • "RemoteUser" - ended or declined by the other party

  • "AnsweredElsewhere" - answered on another of this user's devices sharing the line

  • "AnsweredByHuntGroup" - the call was delivered through a hunt group and answered elsewhere in that group. This does not identify who answered: it is also reported when this user answers on another of their own devices that is a member of the same hunt group. Currently reported for Unified CM calls only.

  • "Busy" - a line was already in use, so the call could not be completed

  • "Timeout" - the call or a reconnection attempt timed out

  • "Error" - the call failed (network, device, or service error)

  • "Unknown" - the host reported a reason this SDK version does not recognise

Readonly id

id: string

ID of the call

Readonly localParticipant

localParticipant: IParticipant

Holds information of the local participant

Readonly remoteParticipants

remoteParticipants: IParticipant[]

Represents the list of remote participants in the call

Readonly state

state: CALL_STATE

State of the call.

It can be one of the following,

  • "Started"

  • "Connecting"

  • "Connected"

  • "Disconnecting"

  • "Disconnected"

  • "Rejected"

  • "Hold"

  • "Ended"

Settings

Member Visibility

Theme