DescribeRtcRobotInstance - Intelligent Media Services - Alibaba Cloud ドキュメントセンター

実時間通信 (RTC) 実時間会話型 AI エージェントインスタンスの情報を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ice:DescribeRtcRobotInstance

none

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	インスタンスの ID。	727dc0e296014bb58670940a3da95592

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ。
AuthToken	string	RTC チャンネルに参加するための認証トークン。	**********
ChannelId	string	チャンネルの ID。	testId
Config	object	AI エージェントの詳細設定。
EnableVoiceInterrupt	boolean	音声による割り込みを許可するかどうかを指定します。	true
Greeting	string	挨拶メッセージ。	Hello
VoiceId	string	音声の ID。	zhixiaoxia
RequestId	string	リクエストの ID。	20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91
Status	string	インスタンスステータス。有効な値: Executing: 実行中。 Finished: 完了。	Executing
UserData	string	カスタムユーザー情報。	{}
UserId	string	チャンネル内の AI エージェントの ID。	my-robot

例

成功レスポンス

JSONJSON

{
  "AuthToken": "**********",
  "ChannelId": "testId",
  "Config": {
    "EnableVoiceInterrupt": true,
    "Greeting": "Hello",
    "VoiceId": "zhixiaoxia"
  },
  "RequestId": "20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91",
  "Status": "Executing",
  "UserData": "{}",
  "UserId": "my-robot"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。