列出机器人

检索应用程序内所有机器人的列表。

请求方法

POST： https://数据中心域名/v3/bot/query.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数

HTTP 请求正文数据格式为 application/json，支持以下 HTTP 请求参数：

参数	类型	必传	说明
page	Int	否	当前页码，默认值为 1。
pageSize	Int	否	每页数量，默认值为 10。
includeIntegration	Boolean	否	是否包含机器人集成平台信息，默认值为 false。

请求示例

HTTP

POST  /v3/bot/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: e0x9wycxx2qdq
Nonce: 83682
Timestamp: 1726627371000
Signature: 81be659c74fccb5be993d553c51f5e26c13e6825
Content-Type: application/json
{
    "page":1,
    "pageSize":20,
    "includeIntegration":false
}

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值	返回类型	说明
code	Int	返回码，200 表示处理成功。
total	Int	数据总条数。
hasNext	Boolean	是否存在下一页。
bots[]	Array<Object>	机器人列表。
bots[].userId	String	机器人的唯一 ID。
bots[].name	String	机器人的昵称。
bots[].type	String	机器人的类型。
bots[].profileUrl	String	机器人头像的 URL。
bots[].integrations[]	Array<Object>	集成平台配置列表。
bots[].integrations[].enabled	Boolean	是否启用该集成项。
bots[].integrations[].type	String	集成类型。
bots[].integrations[].callbackUrl	String	平台回调地址。
bots[].integrations[].objectNames	Array<String>	监听的消息类型。
bots[].integrations[].events	Array<String>	触发事件类型。
bots[].integrations[].stream	Boolean	是否启用流式响应。
bots[].integrations[].handleResponse	Boolean	是否处理第三方返回结果。
bots[].integrations[].auth.apiKey	String	第三方平台认证信息。
bots[].integrations[].agent.agentId	String	AI Agent Id。
bots[].integrations.waitForInputCompletion	Boolean	延迟输入，增强拟人化互动感。
bots[].integrations.gentleResponse	Boolean	回复缓慢显现，模拟自然对话节奏，避免一次性输出。
bots[].metadata	Map<String, String>	自定义键值对。

返回结果示例

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX

{
  "code": 200,
  "total": 2,
  "hasNext": false,
  "bots": [
    {
      "userId": "bot-10001",
      "name": "助手A",
      "profileUrl": "https://example.com/avatarA.png",
      "type": "AI",
      "metadata": {
        "creator": "运营团队",
        "version": "1.0"
      },
      "integrations": [],
      "createdAt": 1680000000000,
      "updatedAt": 1680003600000
    },
    {
      "userId": "bot-10002",
      "name": "助手B",
      "profileUrl": "https://example.com/avatarB.png",
      "type": "AI",
      "metadata": {
        "creator": "研发团队",
        "version": "1.1"
      },
      "integrations": [
        {
          "enabled": true,
          "type": "webhook",
          "callbackUrl": "https://webhook.example.com/callback",
          "objectNames": ["RC:Text"],
          "events": ["message:private"]
        }
      ],
      "createdAt": 1680007200000,
      "updatedAt": 1680010800000
    }
  ]
}

错误码

详见错误码说明