StartCallOptions interface

Package:

@azure/communication-calling

Options for starting an outgoing call.

Extends

JoinCallOptions

Properties

alternateCallerId	A phone number in E.164 format that will be used to represent callers identity.  For example, using the alternateCallerId to add a participant using PSTN, this number will  be used as the caller id in the PSTN call.
customContext	Options for adding custom context.
threadId	Thread ID is required if user is of type MicrosoftTeamsUserIdentifier.

Inherited Properties

audioOptions
videoOptions

Property Details

alternateCallerId

A phone number in E.164 format that will be used to represent callers identity.  For example, using the alternateCallerId to add a participant using PSTN, this number will  be used as the caller id in the PSTN call.

alternateCallerId?: PhoneNumberIdentifier

Property Value

PhoneNumberIdentifier

customContext

Options for adding custom context.

customContext?: CustomContext

Property Value

CustomContext

threadId

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.

Thread ID is required if user is of type MicrosoftTeamsUserIdentifier.

threadId?: string

Property Value

string

Inherited Property Details

audioOptions

audioOptions?: AudioOptions

Property Value

AudioOptions

Inherited From JoinCallOptions.audioOptions

videoOptions

videoOptions?: VideoOptions

Property Value

VideoOptions

Inherited From JoinCallOptions.videoOptions