CallAutomationClient class

الحزمة:

@azure/communication-call-automation

يمثل CallAutomationClient عميلا لخدمة Azure Communication CallAutomation.

المنشئون

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 Communication Service. مثال: "نقطة النهاية=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

تحتوي خيارات الطلب الإضافية على خيارات واجهة برمجة تطبيقات answerCall.

المرتجعات

Promise<CallResult>

connectCall(CallLocator, string, ConnectCallOptions)

إنشاء اتصال بمكالمة الغرفة.

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

المعلمات

callLocator

CallLocator

اتصل بمحدد الموقع لإنشاء اتصال.

callbackUrl

string

عنوان URL لرد الاتصال

options

ConnectCallOptions

تحتوي خيارات الطلب الإضافية على خيارات واجهة برمجة تطبيقات الاتصال.

المرتجعات

Promise<CallResult>

createCall(CallInvite, string, CreateCallOptions)

إنشاء استدعاء صادر من المصدر إلى هوية هدف.

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

المعلمات

targetParticipant

CallInvite

هدف واحد.

callbackUrl

string

عنوان URL لرد الاتصال.

options

CreateCallOptions

تحتوي خيارات الطلب الإضافية على خيارات واجهة برمجة تطبيقات createCallConnection.

المرتجعات

Promise<CallResult>

createGroupCall(CommunicationIdentifier[], string, CreateCallOptions)

إنشاء مكالمة صادرة من المصدر إلى مجموعة من هويات الأهداف.

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

المعلمات

targetParticipants

CommunicationIdentifier[]

مجموعة من الهويات المستهدفة.

callbackUrl

string

عنوان URL لرد الاتصال.

options

CreateCallOptions

تحتوي خيارات الطلب الإضافية على خيارات واجهة برمجة تطبيقات 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

تحتوي خيارات الطلب الإضافية على خيارات redirectCall api.

المرتجعات

Promise<void>

rejectCall(string, RejectCallOptions)

رفض المكالمة.

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

المعلمات

incomingCallContext

string

السياق المقترن باستدعاء .

options

RejectCallOptions

تحتوي خيارات الطلب الإضافية على خيارات واجهة برمجة تطبيقات rejectCall.

المرتجعات

Promise<void>