跳到主要内容

查询用户代聊列表

查询用户代聊配置列表:分页查询某个用户的代聊配置列表。

请求方法​

POST: https://数据中心域名/v3/user/proxychat/query.json

频率限制: 每秒钟限 100 次

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

正文参数​

HTTP 请求正文数据格式为 application/json:

参数类型必传说明
pageInt否页码(从 1 开始),默认值为 1。
sizeInt否每页返回的数据量,默认值为 50。
userIdString是被代聊用户的唯一标识,用于过滤查询,长度 ≤ 64 字符。

请求示例​

HTTP
POST  /v3/user/proxychat/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,
"size": 10,
"userId": "user_001"
}

返回结果​

返回值类型说明
codeInt返回码。200 表示成功。
proxyChatsArray<Object>代聊配置列表。
proxyChats[].userIdString被代聊用户 ID。
proxyChats[].targetIdString代聊目标用户 ID。
proxyChats[].botUserIdString助理 Bot 用户 ID。
proxyChats[].metadataMap<String,String>动态变量(最多 32 组)。
proxyChats[].createdAtLong创建时间(毫秒时间戳)。
proxyChats[].updatedAtLong更新时间(毫秒时间戳)。
totalInt总条目数。
hasNextBoolean是否有下一页。

返回示例​

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

{
"code": 200,
"message": "success",
"proxyChats": [
{
"userId": "user_001",
"targetId": "user_002",
"botUserId": "bot_123",
"metadata": {
"role": "assistant"
},
"createdAt": 1694467200000,
"updatedAt": 1694467200000
},
{
"userId": "user_001",
"targetId": "user_003",
"botUserId": "bot_456",
"metadata": {
"role": "translator"
},
"createdAt": 1694467200000,
"updatedAt": 1694467200000
}
],
"total": 2,
"hasNext": false
}

错误码​

详见:错误码说明