CallAutomationClient class
CallAutomationClient 代表 Azure 通訊 CallAutomation 服務的用戶端。
建構函式
| Call |
初始化 CallAutomationClient 類別的新實例。 |
| Call |
使用 TokenCredential 或 KeyCredential，初始化 CallAutomationClient 類別的新實例。 |
方法
| answer |
接聽電話。 |
| connect |
建立會議室通話的連線。 |
| create |
建立從來源到目標身分識別的傳出呼叫。 |
| create |
建立從來源到目標身分識別群組的傳出呼叫。 |
| get |
初始化 CallConnection 的新實例。 |
| get |
初始化 CallRecording 的新實例。 |
| get |
取得用於建立和接聽通話的來源身分識別 |
| redirect |
重新導向呼叫。 |
| reject |
拒絕通話。 |
建構函式詳細資料
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)
使用 TokenCredential 或 KeyCredential，初始化 CallAutomationClient 類別的新實例。
new CallAutomationClient(endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationClientOptions)參數
- endpoint
-
string
服務的端點（例如：https://contoso.eastus.communications.azure.net）。
- credential
用來驗證服務要求的 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 api 選項。
傳回
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
其他要求選項包含 createCallConnection API 選項。
傳回
Promise<CallResult>
createGroupCall(CommunicationIdentifier[], string, CreateCallOptions)
建立從來源到目標身分識別群組的傳出呼叫。
function createGroupCall(targetParticipants: CommunicationIdentifier[], callbackUrl: string, options?: CreateCallOptions): Promise<CallResult>參數
- targetParticipants
一組目標身分識別。
- callbackUrl
-
string
回呼 URL。
- options
- CreateCallOptions
其他要求選項包含 createCallConnection API 選項。
傳回
Promise<CallResult>
getCallConnection(string)
初始化 CallConnection 的新實例。
function getCallConnection(callConnectionId: string): CallConnection參數
- callConnectionId
-
string
CallConnection 實例的 CallConnection 識別符。 （例如：421CONTOSO-cRD6-4RDc-a078-99dRANDOMf）。
傳回
getCallRecording()
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 API 選項。
傳回
Promise<void>