分页查询应用下群组信息
您可以通过此接口查询指定应用的群组信息,查询结果分页返回。
开通服务
调用此接口前,您须在控制台开通信息托管服务。详情请参阅开启用户信息托管。
请求方法
POST: https://数据中心域名/entrust/group/query.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
pageToken | String | 否 | 分页标识,上次请求返回的分页信息,首次请求不传。 |
size | Number | 否 | 每页条数,默认50,最大 1000。 |
order | Number | 否 | 按群组创建时间排序。
|
请求示例
POST /entrust/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=XXXXXX&oreder=1&size=50
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为请求成功。 |
pageToken | String | 分页标识,如有下一页则返回,下次请求时传入。 |
groups | JSONArray | 群组信息列表。 |
groups 结构 | ||
groups[i].groupId | String | 群组ID |
groups[i].name | String | 群名称 |
groups[i].groupProfile | String | 群组基本信息, 为 JSON 格式。 |
groups[i].creator | String | 群组创建者。 |
groups[i].owner | String | 群主 |
groups[i].time | Long | 群组创建时间 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code":200,
"pageToken": "XXXX",
"groups":[
{
"groupId":"g123",
"owner":"u23",
"creator":"u12",
"name":"g1231",
"portraitUrl":"XXX"
"time": 1709619756077
},
{
"groupId":"g456",
"owner":"u2333",
"creator":"u1332",
"name":"g1231",
"time": 1709619756077
}]
}