跳到主要内容

分页获取应用全部用户列表

获取所有托管在融云服务器上的应用用户的列表,返回结果分页展示。

开通服务

调用此接口前,您须在控制台开通信息托管服务。

请求方法

POST: https://数据中心域名/user/profile/query.json

频率限制: 每秒钟限 100 次

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
pageNumber默认 1
sizeNumber默认20,最大 100
orderNumber根据注册时间的排序机制,默认正序,0为正序,1为倒序

请求示例

POST /user/profile/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

page=1&count=30&order=1

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeNumber返回码,200 为正常。
userListJSONArray用户列表信息
userList结构

userList 结构的组成如下:

返回值返回类型说明
userList[i].userIdString用户ID
userList[i].userProfileString用户基本信息, 为 JSON 数据
userList[i].userExtProfileString用户扩展信息, 为 JSON 数据

userProfile 中的 key 如下:

key 值类型长度/取值范围描述
uniqueIdString长度不超过 32 个字符用户应用号
nameString长度不超过 32 个字符昵称
portraitUriString长度不超过 128 个字符头像地址
emailString长度不超过 128 个字符Email 地址
birthdayString长度不超过 32 个字符生日
genderInt取值范为:
  • 0:未知
  • 1:男
  • 2: 女
性别
locationString长度不超过 32 个字符所在地
roleInt0~100角色
levelInt0~100级别

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code": 200,
"userList": [
{
"userId": "u01",
"userProfile": {"appName":"testAppName","level":2},
"userExtProfile": {"ext_Profile":"testExt"}
}
]
}