エージェントインスタンスを作成し、エージェントが存在するチャンネル、チャンネル内の名前、およびチャンネルへの参加に必須のトークンを返します。
操作説明
この API を使用すると、指定された AI エージェント ID (AIAgentId) に基づいてエージェントインスタンスを作成できます。API 応答の情報を使用して、対応するルームに参加し、エージェントと会話できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:GenerateAIAgentCall |
none |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AIAgentId |
string |
必須 |
エージェント ID。 |
39f8e0bc005e4f309379701645f4**** |
| Expire |
integer |
任意 |
任意。トークンの有効期限時間 (秒単位)。デフォルト値: 3600。有効な値: 0 から 604800。 |
3600 |
| UserId |
string |
任意 |
呼び出しチャンネル内のユーザー名。このパラメーターを指定しない場合、システムによってユーザー名が自動的に生成されます。ユーザー名は最大 64 文字です。 |
877ae632caae49b1afc81c2e8194ffb4 |
TemplateConfig
deprecated
|
AIAgentTemplateConfig |
任意 |
説明
エージェントのテンプレート設定。[非推奨] 詳細については、AgentConfig パラメーターを参照してください。 |
|
| UserData |
string |
任意 |
カスタムユーザー情報。 |
{"Email":"johndoe@example.com","Preferences":{"Language":"en"}} |
| SessionId |
string |
任意 |
会話の一意な識別子。デフォルト値: なし。 |
fw1gr0bc005e4f309379701645f4**** |
| AgentConfig | AIAgentConfig |
任意 |
エージェントのテンプレート設定。指定された設定は、コンソール内のエージェントのテンプレート設定とマージされて更新されます。このパラメーターを指定しない場合、コンソール内のエージェントのデフォルト設定が使用されます。 説明
TemplateConfig の互換性ルール: AgentConfig のフィールドが優先されます。TemplateConfig に AgentConfig で指定されていないフィールドが含まれている場合、TemplateConfig のフィールドが使用されます。TemplateConfig の代わりに AgentConfig を使用することを推奨します。 |
|
| ChatSyncConfig |
object |
任意 |
チャット記録を同期するための設定。 |
|
| IMAIAgentId |
string |
任意 |
IM 用のエージェント ID。 |
******005e4f309379701645f4**** |
| ReceiverId |
string |
任意 |
受信ユーザーの ID。 |
4167626d312034b2b1c3b7f2f3e41884 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ。 |
||
| AIAgentUserId |
string |
ARTC チャンネル内のエージェントの名前。 |
877ae632caae49b1afc81c2e8194ffb4 |
| AvatarUserId |
string |
会話に参加するデジタルヒューマンのユーザー ID。 |
avatar_39f8e0bc005e4f309379701645f4**** |
| ChannelId |
string |
ARTC チャンネル ID。 |
70f22d5784194938a7e387052f2b3208 |
| InstanceId |
string |
生成されたエージェントのインスタンス ID。 |
39f8e0bc005e4f309379701645f4**** |
| RequestId |
string |
リクエスト ID。 |
7B117AF5-2A16-412C-B127-FA6175ED1AD0 |
| Token |
string |
クライアント用の ARTC トークン。 |
eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx |
| UserId |
string |
ARTC チャンネル内のユーザー名。 |
user123 |
例
成功レスポンス
JSONJSON
{
"AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"AvatarUserId": "avatar_39f8e0bc005e4f309379701645f4****",
"ChannelId": "70f22d5784194938a7e387052f2b3208",
"InstanceId": "39f8e0bc005e4f309379701645f4****",
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
"Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"UserId": "user123"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。