Active Channel


The information of an active call

Fields

Name Type Notes

callId

String

notNull

The call ID, use this ID to group channels in one call

channelId

String

notNull

The channel ID, use this as unique identifier for the channel

state

Call State

notNull

The state of the channel.

name

String

notNull

The name that identifies the channel user (addressable name, phone line name, …​), show this name as participant name in the active calls list

organisationName

String

External caller organisation name if available. Not filled for internal callers (own organisation).

role

Caller Role

notNull

The role of this channel (caller, callee, conference, listening)

phone

String

The sip account that is connected with this channel

phoneUser

String

The phone user that is connected with this channel

twinChannel

Boolean

true when channel is used for twin

parkingSlot

String

for parked channel: the parking slot