获取指定标签下的会话列表
获取指定标签下的会话列表
查询指定标签下所有会话的列表信息。返回结果包含标签 ID 和该标签下的所有会话信息,每个会话包含目标 ID 和会话类型。
请求方法
GET: https://数据中心域名/tag/conversation/get.json
频率限制: 每秒 100 次
签名规则: 所有服务端 API 请求均需要进行签名验证,详见 API 请求签名。
正文参数
HTTP 请求支持以下参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 会话所属的用户 ID。 |
tagId | String | 是 | 标签ID。 |
请求示例
HTTP
GET /tag/conversation/get.json?userId=testUserId&tagId=tag1
Host: api.rong-api.com
App-Key: xxxxxx
Nonce: 14314
Timestamp: 111111111111
Signature: xxxxxxxxxxxxxxxxxxxxxxx
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码。200 表示成功。详见服务端 API 状态码。 |
data | Object | |
data.tagId | String | 标签ID |
data.conversations | Object[] | 会话列表 |
data.conversations[].targetId | String | 目标 ID。根据会话类型的不同,该字段为单聊用户 ID、群组 ID 或系统目标 ID。 |
data.conversations[].conversationType | int | 会话类型。支持的会话类型包括:1 (二人会话)、3 (群组会话)、6 (系统会话)。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200,
"data": {
"tagId": "tag1",
"conversations": [
{
"targetId": "user1",
"conversationType": 1
},
{
"targetId": "group1",
"conversationType": 3
}
]
}
}