查询用户所在的群组
根据用户 ID 查询该用户加入的所有群组,返回群组 ID 及群组名称。
默认情况下,此接口可获取用户加入的前 5000 个群组列表。您也可以使用 page
和 size
参数进行分页查询。
提示
融云即时通讯服务不存储群组资料信息,群组资料及群成员信息建议由您的应用服务器自行维护。如果应用服务端维护的用户群组关系数据有缺失,可通过此接口来核对校验。
请求方法
POST: https://数据中心域名/user/group/query.json
频率限制: 每秒 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文支持以下 application/x-www-form-urlencoded
表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 用户 ID。 |
page | Int | 否 | 页码。如需分页查询,请传入此参数。如果传入此参数,则 size 参数也建议传入。如不分页,则无需传入(或传 0 ),此时接口将返回用户加入的前 5000 个群组。 |
size | Int | 否 | 每页条数,仅在 page 传入有效值时生效。默认每页 50 条,最大值为 1000。 |
请求示例
HTTP
POST /user/group/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
userId=123
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Int | 返回码,200 为正常。 |
groups | String | 用户加入的群信息数组。 |
name | String | 群名称。 |
id | String | 群组 ID。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code":200,
"groups":[
{
"name":"GroupName_1",
"id":"GroupId_1"
},
{
"name":"GroupName_8",
"id":"GroupId_8"
}]
}