分页获取群成员信息
此接口用于分页获取指定群组的成员信息,支持按照角色类型和加入群组时间排序。
开通服务
调用此接口前,您须在控制台开通信息托管服务。详情请参阅开启用户信息托管。
请求方法
POST: https://数据中心域名/entrust/group/member/query.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
groupId | String | 是 | 群组 ID。 |
type | Number | 是 | 获取身份类型:
|
pageToken | String | 是 | 分页信息,上一次请求返回 pageToken , 第一次请求不需要传。 |
size | Number | 是 | 每页条数:默认50,最大100。 |
order | Number | 是 | 排序类型:按加入群组时间正序、倒序获取。
|
请求示例
POST /entrust/group/member/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
groupId=groupId1
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 代表请求成功。 |
totalCount | Number | 群成员总数。 |
pageToken | String | 分页标识符,存在下一页时返回,下次请求时传入。 |
members | JSONArray | 成员信息列表。 |
members 结构 | ||
members[i].userId | String | 成员用户 ID。 |
members[i].nickname | String | 成员的群昵称。 |
members[i].role | String | 成员角色( 1:普通成员,2管理员,3:群主) |
members[i].time | String | 成员加入群组的时间。 |
members[i].extra | String | 群成员附加信息。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200,
"totalCount": 40,
"pageToken": "XXXXX",
"groupId": "groupId",
"members": [
{
"userId": "u01",
"role":1,
"nickname": "nickname1",
"time":12343433499942
},
{
"userId": "u02",
"nickname": "nickname2",
"time":12343433499943,
"role":3,
""extra": "xxxx",
}
]
}