分页查询用户加入的群组
该接口用于分页获取指定用户所在群组的资料信息,包括群组 ID、群名称、所有者、群头像、群简介、群公告、群权限、群扩展属性等。
开通服务
调用此接口前,您须在控制台开通信息托管服务。详情请参阅开启用户信息托管。
请求方法
POST: https://数据中心域名/entrust/joined/group/query.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 用户 ID |
role | Number | 是 | 群组身份类型:
|
pageToken | String | 是 | 分页标识,上一次请求返回 pageToken ,首次请求不传。 |
size | Number | 是 | 每页条数,默认 50,最大 100。 |
order | Number | 是 | 排序类型:按加入群组的时间排序。
|
请求示例
POST /entrust/joined/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
pageToken=XXX&oreder=1&size=50&userId=userid1&role=2
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
pageToken | String | 分页标识,如有下一页则返回,下次请求需传入。 |
profiles | JSONArray | 群组信息列表 |
groups 结构 | ||
groups[i].groupId | String | 群组 ID。 |
groups[i].name | String | 群组名称。 |
groups[i].remarkName | String | 群备注名。 |
groups[i].groupProfile | String | 群组基本信息(JSON 格式)。 |
groups[i].groupExtProfile | String | 群扩展信息(JSON 数据)。 |
groups[i].permissions | String | 群权限信息, 为 JSON 数据。 |
groups[i].owner | String | 群主。 |
groups[i].createTime | Long | 群组创建时间。 |
groups[i].joinTime | Long | 用户加入群组的时间。 |
groups[i].role | Number | 用户在群组中的角色。 |
groups[i].count | Number | 群组成员数量。 |
groupProfile
中的 key 如下:
key 值 | 类型 | 说明 |
---|---|---|
introduction | String | 群简介,最长 512 个字符。 |
announcement | String | 群公告,最长 1014 个字符。 |
portraitUrl | String | 群头像地址,最长 128 个字符。 |
permissions
中的 key 如下:
key 值 | 类型 | 描述 |
---|---|---|
joinPerm | Number | 加入群权限:
|
removePerm | Number | 将群成员移出群组权限:
|
memInvitePerm | Number | 邀请他人入群权限:
|
invitePerm | Number | 邀请加入群组处理方式:
|
profilePerm | Number | 修改群资料及权限:
|
memProfilePerm | Number | 设置群成员资料权限:
|
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code":200,
"groups":[
{
"groupId":"g123",
"createTime":17096222222,
"count":23,
"role":1,
"name":"g1231",
"portraitUrl":"XXX"
"jointime": 1709619756077
},
{
"groupId":"g456",
"createTime":1709611111,
"count":231,
"role":2,
"name":"g3333",
"portraitUrl":"XXX"
"jointime": 1709619756077
}]
}