Package version:

Class CallAutomationClient

A CallAutomationClient represents a Client to the Azure Communication CallAutomation service.

Constructors

constructor

Methods

answerCall connectCall createCall createGroupCall getCallConnection getCallRecording getSourceIdentity redirectCall rejectCall

Constructors

constructor

Methods

answerCall

  • answerCall(incomingCallContext, callbackUrl, options?): Promise<CallResult>

  • Answer the call.

    Parameters

    • incomingCallContext: string

      The context associated with the call.

    • callbackUrl: string

      The callback url.

    • options: AnswerCallOptions = {}

      Additional request options contains answerCall api options.

    Returns Promise<CallResult>

connectCall

  • connectCall(callLocator, callbackUrl, options?): Promise<CallResult>

  • Create connection to room call.

    Parameters

    • callLocator: CallLocator

      Call locator to create connection.

    • callbackUrl: string

      The callback url

    • options: ConnectCallOptions = {}

      Additional request options contains connect api options.

    Returns Promise<CallResult>

createCall

  • createCall(targetParticipant, callbackUrl, options?): Promise<CallResult>

  • Create an outgoing call from source to a target identity.

    Parameters

    • targetParticipant: CallInvite

      A single target.

    • callbackUrl: string

      The callback url.

    • options: CreateCallOptions = {}

      Additional request options contains createCallConnection api options.

    Returns Promise<CallResult>

createGroupCall

  • createGroupCall(targetParticipants, callbackUrl, options?): Promise<CallResult>

  • Create an outgoing call from source to a group of targets identities.

    Parameters

    • targetParticipants: CommunicationIdentifier[]

      A group of targets identities.

    • callbackUrl: string

      The callback url.

    • options: CreateCallOptions = {}

      Additional request options contains createCallConnection api options.

    Returns Promise<CallResult>

getCallConnection

  • getCallConnection(callConnectionId): CallConnection

  • Initializes a new instance of CallConnection.

    Parameters

    • callConnectionId: string

      The CallConnection id for the CallConnection instance. (ex: 421CONTOSO-cRD6-4RDc-a078-99dRANDOMf).

    Returns CallConnection

getCallRecording

getSourceIdentity

redirectCall

  • redirectCall(incomingCallContext, targetParticipant, options?): Promise<void>

  • Redirect the call.

    Parameters

    • incomingCallContext: string

      The context associated with the call.

    • targetParticipant: CallInvite

      The target identity to redirect the call to.

    • options: OperationOptions = {}

      Additional request options contains redirectCall api options.

    Returns Promise<void>

rejectCall

  • rejectCall(incomingCallContext, options?): Promise<void>

  • Reject the call.

    Parameters

    • incomingCallContext: string

      The context associated with the call.

    • options: RejectCallOptions = {}

      Additional request options contains rejectCall api options.

    Returns Promise<void>

Settings

Member Visibility