Edit

Share via

CallInfo interface

Package:
@azure/communication-calling

Information about a Call.

Extends
CallInfoCommon

Properties

groupId

Get the group Id of the call if you joined the call using the CallAgent.join(groupLocator: GroupLocator) API.
roomId

Get the Room Id of the call if you joined the call using the CallAgent.join(roomLocator: RoomLocator) API.

Inherited Properties

callScenario

Get the Call type of the call
context

Get the additional information context needed to get more details about the call
direction

Get the Call direction of the call Outgoing or Incoming
initiatorKind

Get the initiator type of the call
participantId

Get the local participant Id
targetKind

Get the initiator target type of the call
threadId

Get the teams meeting threadId id.

Inherited Methods

getServerCallId()

Get the server call ID.

Property Details

groupId

Get the group Id of the call if you joined the call using the CallAgent.join(groupLocator: GroupLocator) API.

groupId: undefined | string

Property Value

undefined | string

roomId

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get the Room Id of the call if you joined the call using the CallAgent.join(roomLocator: RoomLocator) API.

roomId: undefined | string

Property Value

undefined | string

Inherited Property Details

callScenario

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get the Call type of the call

callScenario?: CallInformationScenario

Property Value

CallInformationScenario

Inherited From CallInfoCommon.callScenario

context

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get the additional information context needed to get more details about the call

context?: CallInformationContext

Property Value

CallInformationContext

Inherited From CallInfoCommon.context

direction

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get the Call direction of the call Outgoing or Incoming

direction?: CallDirection

Property Value

CallDirection

Inherited From CallInfoCommon.direction

initiatorKind

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get the initiator type of the call

initiatorKind?: CallInformationIdentifierKind

Property Value

CallInformationIdentifierKind

Inherited From CallInfoCommon.initiatorKind

participantId

Get the local participant Id

participantId: string

Property Value

string

Inherited From CallInfoCommon.participantId

targetKind

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get the initiator target type of the call

targetKind?: string

Property Value

string

Inherited From CallInfoCommon.targetKind

threadId

Get the teams meeting threadId id.

threadId: undefined | string

Property Value

undefined | string

Inherited From CallInfoCommon.threadId

Inherited Method Details

getServerCallId()

Get the server call ID.

function getServerCallId(): Promise<string>

Returns

Promise<string>

Inherited From CallInfoCommon.getServerCallId