ListAIAgentInstance - 查询AI智能体实例列表_智能媒体服务(IMS)-阿里云帮助中心

查询AI智能体实例列表，可以获取所有或指定条件下的智能体实例列表。

接口说明

该接口允许用户根据指定的智能体 ID（AIAgentId），以及可选的时间范围（StartTime 和 EndTime）、每页记录数（PageSize）和当前页码（PageNumber）来查询 AI 智能体实例列表。返回结果包含每个实例的状态、运行时配置、模板配置、用户自定义数据及对话通话记录的下载链接。

注意分页参数默认值：PageSize 为 10，PageNumber 为 1。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ice:ListAIAgentInstance	none	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
AIAgentId	string	是	智能体 Id。	39f8e0bc005e4f309379701645f4***
StartTime	string	否	查询的开始时间（ISO 8601 格式）。默认无。	2023-01-01T00:00:00Z
EndTime	string	否	查询的结束时间（ISO 8601 格式）。默认无。	2023-01-02T00:00:00Z
PageSize	long	否	每页数量，默认 10，取值范围 0~100。	10
PageNumber	long	否	当前页数，默认值 1，取值范围 1~100。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Instances	array<object>	智能体实例结构体列表。
Instances	object
CallLogUrl	string	智能体对话通话记录文件 URL，该文件内部是 CallLog 结构（Json 格式）。	https://example.com/call_logs/12345.json
RuntimeConfig	AIAgentRuntimeConfig	智能体运行时所需要的配置。	{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}
Status	string	实例状态： Executing 运行中 Finished 结束	Finished
TemplateConfig	AIAgentTemplateConfig	智能体示例所使用的模版配置。	{"VoiceChat": {"VoiceId": "zhixiaoxia"}}
UserData	string	用户自定义信息。	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
RequestId	string	请求 ID。	7B117AF5-2A16-412C-B127-FA6175ED1AD0

示例

正常返回示例

JSON格式

{
  "Instances": [
    {
      "CallLogUrl": "https://example.com/call_logs/12345.json",
      "RuntimeConfig": {
        "AvatarChat3D": {
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "VisionChat": {
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "VoiceChat": {
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        }
      },
      "Status": "Finished",
      "TemplateConfig": {
        "VoiceChat": {
          "Greeting": "早上好，我的朋友",
          "UserOnlineTimeout": 60,
          "UserOfflineTimeout": 5,
          "WorkflowOverrideParams": "",
          "EnableIntelligentSegment": true,
          "AvatarUrlType": "",
          "BailianAppParams": "{}",
          "AsrMaxSilence": 400,
          "AvatarUrl": "",
          "AppId": "",
          "Volume": 100,
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 0,
          "GracefulShutdown": false,
          "EnablePushToTalk": false
        },
        "MessageChat": {
          "AppId": ""
        },
        "VisionChat": {
          "Greeting": "早上好，我的朋友！\n",
          "UserOnlineTimeout": 60,
          "UserOfflineTimeout": 5,
          "WorkflowOverrideParams": "",
          "EnableIntelligentSegment": true,
          "BailianAppParams": "{}",
          "AsrMaxSilence": 400,
          "AppId": "",
          "Volume": 100,
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 0,
          "GracefulShutdown": false,
          "EnablePushToTalk": false
        },
        "AvatarChat3D": {
          "Greeting": "早上好，我的朋友！",
          "UserOnlineTimeout": 60,
          "UserOfflineTimeout": 5,
          "WorkflowOverrideParams": "",
          "EnableIntelligentSegment": true,
          "BailianAppParams": "{}",
          "AsrMaxSilence": 400,
          "AppId": "",
          "Volume": 100,
          "AvatarId": "1231",
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 0,
          "GracefulShutdown": false,
          "EnablePushToTalk": false
        }
      },
      "UserData": "{\"Email\":\"johndoe@example.com\",\"Preferences\":{\"Language\":\"en\"}}"
    }
  ],
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

错误码

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