DescribeAIAgentInstance - 查询智能体实例详情_智能媒体服务(IMS)-阿里云帮助中心

查询实例。

接口说明

请求说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	需要查询的智能体实例 ID	39f8e0bc005e4f309379701645f4****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	7B117AF5-2A16-412C-B127-FA6175ED1AD0
Instance	object	智能体实例信息
Status	string	智能体实例的状态，如 Finished，Executing。	Finished
UserData	string	用户自定义信息。	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
CallLogUrl	string	通话日志的 URL。	https://example.com/call_logs/12345
RuntimeConfig	AIAgentRuntimeConfig	智能体运行时的配置信息。	{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}
TemplateConfig	AIAgentTemplateConfig	智能体模版配置。	{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}

示例

正常返回示例

JSON格式

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "Instance": {
    "Status": "Finished",
    "UserData": "{\"Email\":\"johndoe@example.com\",\"Preferences\":{\"Language\":\"en\"}}",
    "CallLogUrl": "https://example.com/call_logs/12345",
    "RuntimeConfig": {
      "VoiceChat": {
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "ChannelId": "70f22d5784194938a7e387052f2b3208",
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx"
      },
      "AvatarChat3D": {
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "ChannelId": "70f22d5784194938a7e387052f2b3208",
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx"
      }
    },
    "TemplateConfig": {
      "VoiceChat": {
        "AppId": "",
        "VoiceId": "zhixiaoxia",
        "Greeting": "早上好，我的朋友",
        "Volume": 100,
        "EnableVoiceInterrupt": true,
        "GracefulShutdown": true
      },
      "AvatarChat3D": {
        "AppId": "",
        "VoiceId": "zhixiaoxia",
        "Greeting": "早上好，我的朋友！",
        "Volume": 100,
        "EnableVoiceInterrupt": true,
        "GracefulShutdown": true,
        "AvatarId": ""
      },
      "MessageChat": {
        "AppId": ""
      }
    }
  }
}

错误码

访问错误中心查看更多错误码。