AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 智能媒体服务 开发参考 API参考 API目录 AI实时互动 智能体管理 DescribeAIAgentInstance - 查询智能体实例详情

DescribeAIAgentInstance - 查询智能体实例详情

更新时间：
产品详情
我的收藏

查询实例。

接口说明

  • 功能描述：此接口用于查询指定智能体实例的详细信息。
  • 使用场景：当需要监控或分析智能体在通话中的表现，或者调试智能体配置效果时，可调用此接口获取所需数据。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用前面加 * 表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:DescribeAIAgentInstancenone
*全部资源
*
    无
无

请求参数

名称类型必填描述示例值
InstanceIdstring是

智能体实例 ID。

说明 InstanceId 为智能体实例启动成功后，返回的唯一的 Id。启动智能体接口，请参见StartAIAgentInstance 、 GenerateAIAgentCall 。
39f8e0bc005e4f309379701645f4****

返回参数

名称类型描述示例值
object

Schema of Response

Instanceobject

智能体实例信息

CallLogUrlstring

通话日志的 URL。

https://example.com/call_logs/12345
RuntimeConfigAIAgentRuntimeConfig

智能体运行时的配置信息。

{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}
Statusstring

智能体实例的状态，如 Finished，Executing。

枚举值：
  • Finished：结束。
  • Executing：运行中。
Finished
TemplateConfigdeprecatedAIAgentTemplateConfig

智能体模版配置。

{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}
UserDatastring

用户自定义信息。

{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionIdstring

对话的唯一标记，默认无。

955535**************
AgentConfigAIAgentConfig

智能体模版配置。

GmtCreatestring

创建时间(UTC)

2025-07-18T06:39:08.000+00:00
GmtModifiedstring

修改时间(UTC)

2025-07-18T06:40:12.000+00:00
RequestIdstring

请求 ID。

7B117AF5-2A16-412C-B127-FA6175ED1AD0

示例

正常返回示例

JSON格式

{
  "Instance": {
    "CallLogUrl": "https://example.com/call_logs/12345",
    "RuntimeConfig": {
      "VoiceChat": {
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "ChannelId": "70f22d5784194938a7e387052f2b3208"
      },
      "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
      "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
      "VisionChat": {
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "ChannelId": "70f22d5784194938a7e387052f2b3208"
      },
      "ChannelId": "70f22d5784194938a7e387052f2b3208\n",
      "AvatarChat3D": {
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "ChannelId": "70f22d5784194938a7e387052f2b3208"
      }
    },
    "Status": "Finished",
    "TemplateConfig": {
      "VoiceChat": {
        "Greeting": "早上好，我的朋友",
        "LlmHistory": [
          {
            "Role": "user",
            "Content": "你好"
          }
        ],
        "WorkflowOverrideParams": {},
        "EnableIntelligentSegment": true,
        "AvatarUrlType": "USER",
        "AvatarUrl": "http://example.com/a.jpg",
        "VoiceIdList": [
          "zhixiaoxia"
        ],
        "CharBreak": true,
        "EnableVoiceInterrupt": true,
        "VoiceprintId": "uniqueId",
        "GracefulShutdown": false,
        "InterruptWords": [
          "停止"
        ],
        "UserOnlineTimeout": 60,
        "AsrLanguageId": "zh_mandarin",
        "UserOfflineTimeout": 5,
        "LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。",
        "BailianAppParams": {},
        "VadLevel": 0,
        "LlmHistoryLimit": 10,
        "AsrMaxSilence": 400,
        "WakeUpQuery": "今天天气怎么样？",
        "AppId": "xxxxx",
        "Volume": 100,
        "VoiceId": "zhixiaoxia",
        "UseVoiceprint": false,
        "MaxIdleTime": 600,
        "AsrHotWords": [
          "检查"
        ],
        "EnablePushToTalk": false
      },
      "MessageChat": {
        "AppId": "xxxxx",
        "VoiceIdList": [
          "zhixiaoxia"
        ]
      },
      "VisionChat": {
        "Greeting": "早上好，我的朋友！\n",
        "LlmHistory": [
          {
            "Role": "user",
            "Content": "你好"
          }
        ],
        "WorkflowOverrideParams": {},
        "EnableIntelligentSegment": true,
        "VoiceIdList": [
          "zhixiaoxia"
        ],
        "CharBreak": true,
        "EnableVoiceInterrupt": true,
        "VoiceprintId": "uniqueId",
        "GracefulShutdown": false,
        "InterruptWords": [
          "停止"
        ],
        "UserOnlineTimeout": 60,
        "AsrLanguageId": "zh_mandarin",
        "UserOfflineTimeout": 5,
        "LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\n",
        "BailianAppParams": {},
        "VadLevel": 0,
        "LlmHistoryLimit": 10,
        "AsrMaxSilence": 400,
        "WakeUpQuery": "今天天气怎么样？",
        "AppId": "xxxxx",
        "Volume": 100,
        "VoiceId": "zhixiaoxia",
        "UseVoiceprint": false,
        "MaxIdleTime": 600,
        "AsrHotWords": [
          "检查"
        ],
        "EnablePushToTalk": false
      },
      "AvatarChat3D": {
        "Greeting": "早上好，我的朋友！",
        "LlmHistory": [
          {
            "Role": "user",
            "Content": "你好"
          }
        ],
        "WorkflowOverrideParams": {},
        "EnableIntelligentSegment": true,
        "VoiceIdList": [
          "zhixiaoxia"
        ],
        "AvatarId": 1231,
        "CharBreak": true,
        "EnableVoiceInterrupt": true,
        "VoiceprintId": "uniqueId",
        "GracefulShutdown": false,
        "InterruptWords": [
          "停止"
        ],
        "UserOnlineTimeout": 60,
        "AsrLanguageId": "zh_mandarin",
        "UserOfflineTimeout": 5,
        "LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。",
        "BailianAppParams": {},
        "VadLevel": 0,
        "LlmHistoryLimit": 10,
        "AsrMaxSilence": 400,
        "WakeUpQuery": "今天天气怎么样？",
        "AppId": "xxxxx",
        "Volume": 100,
        "VoiceId": "zhixiaoxia",
        "UseVoiceprint": false,
        "MaxIdleTime": 600,
        "AsrHotWords": [
          "检查"
        ],
        "EnablePushToTalk": false
      }
    },
    "UserData": {
      "Email": "johndoe@example.com",
      "Preferences": {
        "Language": "en"
      }
    },
    "SessionId": "955535**************",
    "AgentConfig": {
      "AppId": "*******aaab****",
      "Greeting": "你好",
      "WakeUpQuery": "今天天气怎么样？\n",
      "MaxIdleTime": 600,
      "UserOnlineTimeout": 60,
      "UserOfflineTimeout": 5,
      "EnablePushToTalk": false,
      "GracefulShutdown": true,
      "Volume": 100,
      "WorkflowOverrideParams": {},
      "AvatarUrl": "http://example.com/a.jpg\n",
      "AvatarUrlType": "USER",
      "EnableIntelligentSegment": true,
      "AsrConfig": {
        "AsrMaxSilence": 400,
        "AsrLanguageId": "zh_mandarin",
        "CustomParams": "mode=fast&sample=16000&format=wav",
        "VadDuration": 300,
        "AsrHotWords": [
          "检查"
        ],
        "VadLevel": 1
      },
      "TtsConfig": {
        "PronunciationRules": [
          {
            "Type": "replacement",
            "Word": "一一零",
            "Pronunciation": "幺幺零"
          }
        ],
        "VoiceIdList": [
          "zhixiaoxia"
        ],
        "VoiceId": "longcheng_v2\n\n",
        "Emotion": "happy",
        "ModelId": "speech-01-turbo",
        "LanguageId": "Chinese",
        "SpeechRate": 1
      },
      "LlmConfig": {
        "FunctionMap": [
          {
            "Function": "hangup",
            "MatchFunction": "hangup"
          }
        ],
        "LlmHistoryLimit": 10,
        "LlmCompleteReply": true,
        "LlmHistory": [
          {
            "Role": "user",
            "Content": "你好"
          }
        ],
        "LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\n",
        "OpenAIExtraQuery": "api-version=2024-02-01&api-key=sk-xxx",
        "OutputMaxDelay": 2000,
        "BailianAppParams": {
          "biz_params": {
            "user_defined_params": {
              "your_plugin_id": {
                "article_index": 2
              }
            }
          },
          "memory_id": "your_memory_id",
          "image_list": [
            "https://your_image_url"
          ],
          "rag_options": {
            "pipeline_ids": [
              "your_id"
            ],
            "file_ids": [
              "文档ID1",
              "文档ID2"
            ],
            "metadata_filter": {
              "name": "张三"
            },
            "structured_filter": {
              "key1": "value1",
              "key2": "value2"
            },
            "tags": [
              "标签1",
              "标签2"
            ]
          }
        },
        "OutputMinLength": 5
      },
      "AvatarConfig": {
        "AvatarId": 5257
      },
      "InterruptConfig": {
        "InterruptWords": [
          "打断一下"
        ],
        "EnableVoiceInterrupt": true
      },
      "VoiceprintConfig": {
        "VoiceprintId": "zhixiaoxia",
        "UseVoiceprint": false
      },
      "TurnDetectionConfig": {
        "SemanticWaitDuration": -1,
        "TurnEndWords": [
          "我说完了"
        ],
        "Mode": "Semantic"
      },
      "ExperimentalConfig": "",
      "VcrConfig": {
        "PeopleCount": {
          "Enabled": false
        },
        "StillFrameMotion": {
          "Enabled": false,
          "CallbackDelay": 3000
        },
        "Equipment": {
          "Enabled": false
        },
        "HeadMotion": {
          "Enabled": false
        },
        "LookAway": {
          "Enabled": true
        },
        "InvalidFrameMotion": {
          "Enabled": false,
          "CallbackDelay": 3000
        }
      },
      "OutboundCallConfig": {
        "SipDomain": "",
        "Type": 0
      },
      "InboundCallConfig": {
        "Type": 0,
        "AuthUrl": "",
        "AuthToken": ""
      },
      "AmbientSoundConfig": {
        "ResourceId": "f67901c595834************",
        "Volume": 50
      }
    },
    "GmtCreate": "2025-07-18T06:39:08.000+00:00",
    "GmtModified": "2025-07-18T06:40:12.000+00:00"
  },
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

错误码

访问错误中心查看更多错误码。
上一篇：UpdateAIAgentInstance - 更新AI智能体实例配置下一篇：ListAIAgentInstance - 查询AI智能体实例列表