CallAutomationClient class
CallAutomationClient は、Azure Communication CallAutomation サービスへのクライアントを表します。
コンストラクター
| Call |
CallAutomationClient クラスの新しいインスタンスを初期化します。 |
| Call |
TokenCredential または KeyCredential を使用して CallAutomationClient クラスの新しいインスタンスを初期化します。 |
メソッド
| answer |
通話に応答します。 |
| connect |
ルームコールへの接続を作成します。 |
| create |
ソースからターゲット ID への発信呼び出しを作成します。 |
| create |
ソースからターゲット ID のグループへの発信呼び出しを作成します。 |
| get |
CallConnection の新しいインスタンスを初期化します。 |
| get |
CallRecording の新しいインスタンスを初期化します。 |
| get |
呼び出しの作成と応答に使用されるソース ID の取得 |
| redirect |
呼び出しをリダイレクトします。 |
| reject |
呼び出しを拒否します。 |
コンストラクターの詳細
CallAutomationClient(string, CallAutomationClientOptions)
CallAutomationClient クラスの新しいインスタンスを初期化します。
new CallAutomationClient(connectionString: string, options?: CallAutomationClientOptions)パラメーター
- connectionString
-
string
Azure Communication Service リソースに接続するための接続文字列。 例: "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)
ソースからターゲット ID への発信呼び出しを作成します。
function createCall(targetParticipant: CallInvite, callbackUrl: string, options?: CreateCallOptions): Promise<CallResult>パラメーター
- targetParticipant
- CallInvite
1 つのターゲット。
- callbackUrl
-
string
コールバック URL。
- options
- CreateCallOptions
追加の要求オプションには、createCallConnection api オプションが含まれています。
戻り値
Promise<CallResult>
createGroupCall(CommunicationIdentifier[], string, CreateCallOptions)
ソースからターゲット ID のグループへの発信呼び出しを作成します。
function createGroupCall(targetParticipants: CommunicationIdentifier[], callbackUrl: string, options?: CreateCallOptions): Promise<CallResult>パラメーター
- targetParticipants
ターゲット ID のグループ。
- callbackUrl
-
string
コールバック URL。
- options
- CreateCallOptions
追加の要求オプションには、createCallConnection api オプションが含まれています。
戻り値
Promise<CallResult>
getCallConnection(string)
CallConnection の新しいインスタンスを初期化します。
function getCallConnection(callConnectionId: string): CallConnectionパラメーター
- callConnectionId
-
string
CallConnection インスタンスの CallConnection ID。 (例: 421CONTOSO-cRD6-4RDc-a078-99dRANDOMf)。
戻り値
getCallRecording()
getSourceIdentity()
呼び出しの作成と応答に使用されるソース ID の取得
function getSourceIdentity(): undefined | CommunicationUserIdentifier戻り値
undefined | CommunicationUserIdentifier
redirectCall(string, CallInvite, OperationOptions)
呼び出しをリダイレクトします。
function redirectCall(incomingCallContext: string, targetParticipant: CallInvite, options?: OperationOptions): Promise<void>パラメーター
- incomingCallContext
-
string
呼び出しに関連付けられているコンテキスト。
- targetParticipant
- CallInvite
呼び出しのリダイレクト先のターゲット ID。
- 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>