# 获取用户信息（支持批量）

# 接口描述

三方系统可以将用户基本信息同步到本地，分批次获取用户数据。

# 字符编码

UTF-8

# 请求地址

/openapi/center-user-pull

参数名	类型	必填	说明
accessToken	String	是	请求发起时需要在 header 中，携带 accessToken，获取方式详见获取 accessToken

# 版本号（ver）

# 请求方式

POST(application/json)

# 请求 Body 参数

参数名	类型	长度	必填	说明
ver	Integer	-	必填	api 接口版本，参见具体 API 的版本
userId	String	36	否	用户 ID（此项有值，开始时间、截止时间将忽略）
pageNum	Integer	-	必填	起始数值
pageSize	Integer	-	否	批量查询数据条数, 默认为 100，最大为 500
startRegTime	String	19	必填	用户注册时间，开始时间，格式：yyyy-MM-dd HH:mm:ss
endRegTime	String	19	必填	用户注册时间，截止时间，格式：yyyy-MM-dd HH:mm:ss

# 请求 Body 示例

{
  "ver": "1",
  "pageNum":0,
  "userId": "jie832jdf",
  "pageSize": 100,
  "startRegTime": "2022-06-13 00:00:00",
  "endRegTime": "2022-06-13 23:59:59"
}

1
2
3
4
5
6
7
8

# 返回参数列表

参数名	类型	长度	必填	说明
code	Integer	-	必填	服务响应 code
msg	String	-	否	信息描述
data	PageVo	-	否	返回数据

PageVo数据结构

属性	类型	长度	必填	说明
totalPage	Integer	-	否	用户总条数
pageNum	Integer	-	必填	起始数值
pageSize	Integer	-	否	批量查询数据条数, 默认为 100，最大为 500
userList	UserVo[]	-	否	用户信息数据

UserVo数据结构

属性	类型	长度	必填	说明
userId	String	36	必填	用户 Id
userName	String	50	否	用户昵称
account	String	100	必填	账号（手机号、邮箱账号等）
avatar	String	200	否	用户头像
userMail	String	100	否	用户邮箱
userMobile	String	50	否	用户手机号
gender	Integer	-	否	用户性别 0 男 1 女 2 未知
userType	Integer	-	必填	用户类型 0 未知 1 个人 2 企业
identified	Integer	-	必填	是否已实名制 1 是 0 否
userRegTime	String	19	必填	用户注册时间，格式：yyyy-MM-dd HH:mm:ss
firstLoginTime	String	19	否	首次登录时间，格式：yyyy-MM-dd HH:mm:ss
loginTime	String	19	否	最近一次登录时间，格式：yyyy-MM-dd HH:mm:ss
logoutTime	String	19	否	退出登录时间，格式：yyyy-MM-dd HH:mm:ss

# 返回参数示例

{
  "code": 200, 
  "msg": "成功", 
  "data": { 
    "totalPage": 1,
    "pageNum":0,
    "pageSize": 100,
    "userList": { 
      "userId": "23474832432", 
      "username": "test01", 
      "userMail": "2348232@mek.com", 
      "userMobile": "15211112222", 
      "account": "38924382", 
      "gender": 0, 
      "userType": 1,
      "identified": 1,
      "avatar": "http://www.img.com/img/avatar.png", 
      "userRegTime": "2022-06-06 13:41:00", 
      "firstLoginTime": "2022-06-07 14:19:00", 
      "loginTime": "2022-06-08 14:29:00", 
      "logoutTime": "2022-06-07 18:32:00"
    }
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# 返回码表

返回码	说明
200	成功

其它返回码见 API 返回码说明

# 获取用户信息（支持批量）

# 接口描述

# 字符编码

# 请求地址

# 请求 Header 参数

# 版本号（ver）

# 请求方式

# 请求 Body 参数

# 请求 Body 示例

# 返回参数列表

# 返回参数示例

# 返回码表