ListIMBots -

更新时间:
复制为 MD 格式

分页列举 IM Bots

接口说明

GET /2025-09-10/agents/im-bots;200 OK;data 含 items、pageNumber、pageSize、total;pageNumber 默认 1、pageSize 默认 20、上限 100;可按 botName(子串忽略大小写)、agentRuntimeId、botBizType、status 筛选

调试

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

调试

授权信息

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

请求语法

GET /2025-09-10/agents/im-bots HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

pageNumber

integer

默认 1;传入时须 ≥ 1

pageSize

integer

默认 20;传入时须 1–100

botName

string

agentRuntimeId

string

botBizType

string

status

string

返回参数

名称

类型

描述

示例值

ListIMBotsResult

示例

正常返回示例

JSON格式

{
  "code": "",
  "requestId": "",
  "data": {
    "items": [
      {
        "id": "",
        "tenantId": "",
        "imChannelServerResourceName": "",
        "botBizId": "",
        "botName": "",
        "agentRuntimeId": "",
        "botBizType": "",
        "botMode": "",
        "status": "",
        "lastMessageTime": "",
        "currentInstances": 0,
        "description": "",
        "metadata": {
          "agentRuntimeId": "",
          "agentRuntimeEndpointId": "",
          "agentRuntimeEndpointUrl": "",
          "protocolType": "",
          "role": "",
          "customFunctionMeta": ""
        },
        "createdAt": "",
        "updatedAt": ""
      }
    ],
    "pageNumber": 0,
    "pageSize": 0,
    "total": 0
  }
}

错误码

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

变更历史

更多信息,参考变更详情