CallAutomationClient class

Пакет:: @azure/communication-call-automation

CallAutomationClient представляет клиент в службу ВызоваAutomation Azure.

Конструкторы

CallAutomationClient(string, CallAutomationClientOptions)	Инициализирует новый экземпляр класса CallAutomationClient.
CallAutomationClient(string, TokenCredential \| KeyCredential, CallAutomationClientOptions)	Инициализирует новый экземпляр класса CallAutomationClient с помощью TokenCredential или KeyCredential.

Методы

answerCall(string, string, AnswerCallOptions)	Ответьте на звонок.
connectCall(CallLocator, string, ConnectCallOptions)	Создайте подключение к вызову комнаты.
createCall(CallInvite, string, CreateCallOptions)	Создайте исходящий вызов из источника в целевое удостоверение.
createGroupCall(CommunicationIdentifier[], string, CreateCallOptions)	Создайте исходящий вызов из источника в группу удостоверений целевых объектов.
getCallConnection(string)	Инициализирует новый экземпляр CallConnection.
getCallRecording()	Инициализирует новый экземпляр CallRecording.
getSourceIdentity()	Получение исходного удостоверения, используемого для вызова создания и ответа
redirectCall(string, CallInvite, OperationOptions)	Перенаправьте вызов.
rejectCall(string, RejectCallOptions)	Отклоните вызов.

Сведения о конструкторе

CallAutomationClient(string, CallAutomationClientOptions)

Инициализирует новый экземпляр класса CallAutomationClient.

new CallAutomationClient(connectionString: string, options?: CallAutomationClientOptions)

Параметры

connectionString: string

Строка подключения для подключения к ресурсу Службы коммуникации Azure. Пример: endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options: CallAutomationClientOptions

Необязательный. Параметры настройки конвейера HTTP.

CallAutomationClient(string, TokenCredential | KeyCredential, CallAutomationClientOptions)

Инициализирует новый экземпляр класса CallAutomationClient с помощью TokenCredential или KeyCredential.

new CallAutomationClient(endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationClientOptions)

Параметры

endpoint: string

Конечная точка службы (например, https://contoso.eastus.communications.azure.net).

credential: TokenCredential | KeyCredential

TokenCredential или KeyCredential, используемый для проверки подлинности запросов к службе.

options: CallAutomationClientOptions

Необязательный. Параметры настройки конвейера HTTP.

Сведения о методе

answerCall(string, string, AnswerCallOptions)

Ответьте на звонок.

function answerCall(incomingCallContext: string, callbackUrl: string, options?: AnswerCallOptions): Promise<CallResult>

Параметры

incomingCallContext: string

Контекст, связанный с вызовом.

callbackUrl: string

URL-адрес обратного вызова.

options: AnswerCallOptions

Дополнительные параметры запроса содержат параметры api answerCall.

Возвращаемое значение

Promise<CallResult>

connectCall(CallLocator, string, ConnectCallOptions)

Создайте подключение к вызову комнаты.

function connectCall(callLocator: CallLocator, callbackUrl: string, options?: ConnectCallOptions): Promise<CallResult>

Параметры

callLocator: CallLocator

Указатель вызова для создания подключения.

callbackUrl: string

URL-адрес обратного вызова

options: ConnectCallOptions

Дополнительные параметры запроса содержат параметры api подключения.

Возвращаемое значение

Promise<CallResult>

createCall(CallInvite, string, CreateCallOptions)

Создайте исходящий вызов из источника в целевое удостоверение.

function createCall(targetParticipant: CallInvite, callbackUrl: string, options?: CreateCallOptions): Promise<CallResult>

Параметры

targetParticipant: CallInvite

Один целевой объект.

callbackUrl: string

URL-адрес обратного вызова.

options: CreateCallOptions

Дополнительные параметры запроса содержат параметры api createCallConnection.

Возвращаемое значение

Promise<CallResult>

createGroupCall(CommunicationIdentifier[], string, CreateCallOptions)

Создайте исходящий вызов из источника в группу удостоверений целевых объектов.

function createGroupCall(targetParticipants: CommunicationIdentifier[], callbackUrl: string, options?: CreateCallOptions): Promise<CallResult>

Параметры

targetParticipants: CommunicationIdentifier[]

Группа удостоверений целевых объектов.

callbackUrl: string

URL-адрес обратного вызова.

options: CreateCallOptions

Дополнительные параметры запроса содержат параметры api createCallConnection.

Возвращаемое значение

Promise<CallResult>

getCallConnection(string)

Инициализирует новый экземпляр CallConnection.

function getCallConnection(callConnectionId: string): CallConnection

Параметры

callConnectionId: string

Идентификатор CallConnection для экземпляра CallConnection. (например: 421CONTOSO-cRD6-4RDc-a078-99dRANDOMf).

Возвращаемое значение

CallConnection

getCallRecording()

Инициализирует новый экземпляр CallRecording.

function getCallRecording(): CallRecording

Возвращаемое значение

CallRecording

getSourceIdentity()

Получение исходного удостоверения, используемого для вызова создания и ответа

function getSourceIdentity(): undefined | CommunicationUserIdentifier

Возвращаемое значение

undefined | CommunicationUserIdentifier

redirectCall(string, CallInvite, OperationOptions)

Перенаправьте вызов.

function redirectCall(incomingCallContext: string, targetParticipant: CallInvite, options?: OperationOptions): Promise<void>

Параметры

incomingCallContext: string

Контекст, связанный с вызовом.

targetParticipant: CallInvite

Целевое удостоверение для перенаправления вызова.

options: OperationOptions

Дополнительные параметры запроса содержат параметры API перенаправленияCall.

Возвращаемое значение

Promise<void>

rejectCall(string, RejectCallOptions)

Отклоните вызов.

function rejectCall(incomingCallContext: string, options?: RejectCallOptions): Promise<void>

Параметры

incomingCallContext: string

Контекст, связанный с вызовом.

options: RejectCallOptions

Дополнительные параметры запроса содержат параметры api отклонитьCall.

Возвращаемое значение

Promise<void>