用户

1. 获取用户token

1.0.1. 地址

http://domain:18080/admin/user/get_token

1.0.2. body

参数	类型	必需	描述
userId	string	是	用户ID
clientId	string	是	客户端ID
platform	int	是	平台，见下面

clientId为客户端ID，客户端SDK有获取clientId的接口。 platform为客户端类型标识，必须正确填写，否则connect的时候，会失败或者多端互踢等功能失效。

1.0.3. 平台

平台	值	平台类型
iOS	1	移动端
Android	2	移动端
Windows	3	PC端
OSX	4	PC端
Web	5	网页端
WX(小程序)	6	小程序端
Linux	7	PC端
iPad	8	Pad端
APad	9	Pad端
Harmony	10	移动端
Harmony_Pad	11	Pad端
Harmony_PC	12	PC端

一共有移动端、PC端、Web端、小程序端、Pad端，共5个端。平台类型是用来做多端互踢的，当关闭多端时，每个端只能登录一个设备，不同端可以同时登录。当打开多端时，任意端都可以登录一个或多个设备。

1.0.4. 响应

参数	类型	必需	描述
userId	string	是	用户ID
token	string	是	用户token

1.0.5. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"a\",\"clientId\":\"xxxxx\",\"platform\":1}" http://localhost:18080/admin/user/get_token

{
  "code":0,
  "msg":"success",
  "result":{
    "userId":"a",
    "token":"hN0AF2XX6+pOWqMS7iQiZnCFfGA53r1r"
  }
}

2. 注册/更新用户

2.0.1. 地址

http://domain:18080/admin/user/create

2.0.2. body

参数	类型	必需	描述
userId	string	否	用户ID，如果传空，系统会自动生成一个用户id。*必须保证唯一性。*
name	string	是	帐号名，*必须保证唯一性。*
displayName	string	是	显示名字
portrait	string	否	用户头像
gender	int	否	用户性别
mobile	string	否	用户手机号码
email	string	否	用户邮箱
address	string	否	用户地址
company	string	否	用户公司
social	string	否	用户社交账号
extra	string	否	附加信息

userId是用户在系统中的唯一ID，会一直保持不变，一般是对用户不可见的。name是用户的可见账户ID，可以是登录名，特殊情况下可以修改，但要保持唯一性。以微信为例，微信号就是我们的“name”，可以看见，可以用来登录使用，可以查找用户，也可以修改；另外微信还给每个用户分配一个UUID，这个是不可见的，也会是一直保持不变的，这个就对应我们的”userId“。

2.0.3. 响应

参数	类型	必需	描述
userId	string	是	用户ID

2.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"name\":\"a\",\"displayName\":\"A\"}" http://localhost:18080/admin/user/create

{
  "code":0,
  "msg":"success",
  "result":{
    "userId":"a",
  }
}

3. 注册/更新机器人

机器人是一种特殊的用户角色，跟普通用户在用一个空间中，需要避免机器人用户id跟普通用户id冲突的可能。使用Server API来创建机器人，然后机器人服务使用robot api来发送消息。

3.0.1. 地址

http://domain:18080/admin/robot/create

3.0.2. body

参数	类型	必需	描述
userId	string	否	用户ID，如果传空，系统会自动生成一个用户id
name	string	是	登录名
displayName	string	是	显示名字
portrait	string	否	用户头像
mobile	string	否	用户手机号码
gender	int	否	用户性别
email	string	否	用户邮箱
address	string	否	用户地址
company	string	否	用户公司
social	string	否	用户社交账号
extra	string	否	附加信息
owner	string	是	机器人拥有者
secret	string	否	机器人密钥
callback	string	否	机器人消息回掉地址
robotExtra	string	否	机器人附加信息

3.0.3. 响应

参数	类型	必需	描述
userId	string	是	机器人用户ID
secret	string	是	机器人密钥

如果创建时不填写secret，会自动生成一个

3.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"name\":\"a\",\"displayName\":\"A\",\"callback\":\"http://localhost/robot\",\"owner\":\"b\"}" http://localhost:18080/admin/robot/create

{
  "code":0,
  "msg":"success",
  "result":{
    "userId":"a",
    "secret":"xxxxx"
  }
}

4. 更新用户

4.0.1. 地址

http://domain:18080/admin/user/update

4.0.2. body

参数	类型	必需	描述
flag	int	是	更新用户信息的字段信息，第0bit位为1时更新userInfo中的昵称信息，第1位更新头像，第2位更新性别，第3更新电话，第4位更新email，第5位更新地址，第6位更新公司，第7位更新社交信息，第8位更新extra信息，第9位更新name信息。比如更新用户头像和昵称，flag应该位 0x03，mask参考
userInfo	json	是	要更新的用户信息，与创建用户参数一致，注意必须带有userId参数，其它带上flag指定修改的字段

4.0.3. 响应

N/A

4.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"flag\":1, \"userInfo\":{\"userId\":\"user1\",\"displayName\":\"A\"}}" http://localhost:18080/admin/user/update

{
  "code":0,
  "msg":"success"
}

创建用户接口和更新用户接口都可以更新用户信息，区别是创建用户接口会覆盖原有信息，更新接口只更新flag指定的字段。更新接口在社区版0.55版本才支持。

5. 获取用户信息

5.0.1. 地址

http://domain:18080/admin/user/get_info

5.0.2. body

参数	类型	必需	描述
userId	string	否（三个参数必须且只能存在一个）	用户ID
name	string	否（三个参数必须且只能存在一个）	登录名
mobile	string	否（三个参数必须且只能存在一个）	用户手机号码
includeDeleted	boolean	否	是否包含已删除用户，默认为false

5.0.3. 响应

参数	类型	必需	描述
userId	string	是	用户ID
name	string	是	登录名
displayName	string	是	显示名字
portrait	string	否	用户头像
gender	int	否	用户性别
mobile	string	否	用户手机号码
email	string	否	用户邮箱
address	string	否	用户地址
company	string	否	用户公司
social	string	否	用户社交账号
extra	string	否	附加信息

5.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost:18080/admin/user/get_info

{
  "code":0,
  "msg":"success",
  "result":{
    "userId":"a",
    "name":"usera"
  }
}

6. 通过邮箱获取用户

通过邮箱地址获取用户信息列表（可能有多个用户使用同一邮箱）。

6.0.1. 地址

http://domain:18080/admin/user/get_info_by_email

6.0.2. body

参数	类型	必需	描述
email	string	是	用户邮箱

6.0.3. 响应

参数	类型	必需	描述
result	Object[]	是	用户信息列表

6.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "\"user1@example.com\"" http://localhost:18080/admin/user/get_info_by_email

{
  "code":0,
  "msg":"success",
  "result":[
    {
      "userId":"user1",
      "name":"name1",
      "email":"user1@example.com"
    }
  ]
}

7. 获取所有用户(分页)

分页获取系统中的所有用户。

7.0.1. 地址

http://domain:18080/admin/user/all

7.0.2. body

参数	类型	必需	描述
count	int	是	每页数量
offset	int	是	偏移量

7.0.3. 响应

参数	类型	必需	描述
result	Object[]	是	用户信息列表

7.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"count\":10,\"offset\":0}" http://localhost:18080/admin/user/all

{
  "code":0,
  "msg":"success",
  "result":[
    {
      "userId":"user1",
      "name":"name1"
    }
  ]
}

8. 批量获取用户信息

根据用户ID列表批量获取用户信息。

8.0.1. 地址

http://domain:18080/admin/user/batch_get_infos

8.0.2. body

参数	类型	必需	描述
list	string[]	是	用户ID列表

8.0.3. 响应

参数	类型	必需	描述
result	Object[]	是	用户信息列表

8.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"list\":[\"user1\",\"user2\"]}" http://localhost:18080/admin/user/batch_get_infos

{
  "code":0,
  "msg":"success",
  "result":[
    {
      "userId":"user1",
      "name":"name1"
    },
    {
      "userId":"user2",
      "name":"name2"
    }
  ]
}

9. 更新用户状态

封禁/禁言用户

9.0.1. 地址

http://domain:18080/admin/user/update_block_status

9.0.2. body

参数	类型	必需	描述
userId	string	是	用户ID
status	int	是	用户状态，0 正常；1 被禁言，2 被封禁

9.0.3. 响应

N/A

9.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"a\", \"status\":1}" http://localhost:18080/admin/user/update_block_status

{
  "code":0,
  "msg":"success"
}

10. 查询用户状态

10.0.1. 地址

http://domain:18080/admin/user/check_block_status

10.0.2. body

参数	类型	必需	描述
userId	string	是	用户ID

10.0.3. 响应

参数	类型	必需	描述
status	int	是	用户状态，0 正常；1 被禁言，2 被封禁

10.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost:18080/admin/user/check_block_status

{
  "code":0,
  "msg":"success",
  "result":{
    "status":0
  }
}

11. 获取封禁/禁言用户列表

11.0.1. 地址

http://domain:18080/admin/user/get_blocked_list

11.0.2. body

N/A

11.0.3. 响应

参数	类型	必需	描述
result	[user status]	是	用户状态列表，用户状态1为禁言，2为封禁，不包含正常状态的用户

11.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" http://localhost:18080/admin/user/get_blocked_list

{
  "code":0,
  "msg":"success",
  "result":[
    {
      "userId":"a",
      "status":1,
    },
    {
      "userId":"b",
      "status":2,
    },
    {
      "userId":"c",
      "status":1,
    },
  ]
}

12. 获取用户在线状态

12.0.1. 地址

http://domain:18080/admin/user/onlinestatus

12.0.2. body

参数	类型	必需	描述
userId	string	是	用户ID

12.0.3. 响应

参数	类型	必需	描述
sessions	json list	是	所有端的连接情况

12.0.4. session

参数	类型	必需	描述
clientId	string	是	客户端ID
userId	string	是	User Id
platform	int	是	platform
status	int	是	0 online, 1 have session offline
lastSeen	long	是	最后一次可见时间

12.0.5. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost:18080/admin/user/onlinestatus

{
  "code":0,
  "msg":"success",
  "result":[{
    "clientId":"clientidxxx",
    "userId":"useridxxx",
    "platform":0,
    "status":0,
    "lastSeen":1392312342
  }]
}

13. 强迫用户或客户端下线

13.0.1. 地址

http://domain:18080/admin/user/kickoff_client

13.0.2. body

参数	类型	必需	描述
first	string	是	用户ID
second	string	否	clientId。当clientId存在会踢掉对应用户对应客户端；当clientId为空时，踢掉用户的所有客户端

13.0.3. 响应

N/A

13.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"first\":\"a\"}" http://localhost:18080/admin/user/kickoff_client

{
  "code":0,
  "msg":"success"
}

14. 获取机器人信息

14.0.1. 地址

http://domain:18080/admin/user/get_robot_info

14.0.2. body

参数	类型	必需	描述
robotId	string	是	机器人ID

14.0.3. 响应

参数	类型	必需	描述
userId	string	是	用户ID
name	string	是	登录名
displayName	string	是	显示名字
portrait	string	否	用户头像
mobile	string	否	用户手机号码
email	string	否	用户邮箱
address	string	否	用户地址
company	string	否	用户公司
extra	string	否	附加信息
updateDt	long	否	最后更新时间
owner	string	否	机器人拥有者id
secret	string	否	机器人密钥
callback	string	否	回调地址
robotExtra	string	否	机器人附加信息

14.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"robotId\":\"a\"}" http://localhost:18080/admin/user/get_robot_info

{
  "code":0,
  "msg":"success",
  "result":{
    "userId":"a",
    "name":"usera",
    "owner":"userId2"
    "secret":"123456"
  }
}

15. 销毁用户或者机器人

15.0.1. 地址

http://domain:18080/admin/user/destroy

15.0.2. body

参数	类型	必需	描述
userId	string	是	被删除的用户ID或者机器人ID

15.0.3. 响应

N/A

15.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"userId1\"}" http://domain:18080/admin/user/destroy

{
  "code":0,
  "msg":"success"
}

16. 验证用户

此方法是用于开放平台验证用户身份的，详情请参考开放平台.

16.0.1. 地址

http://domain:18080/admin/user/app_get_user_info

16.0.2. body

参数	类型	必需	描述
authCode	string	是	验证码（前端页面通过jssdk调用im sdk获取得到）

16.0.3. 响应

参数	类型	必需	描述
userId	string	是	用户ID
displayName	string	否(如果存在用户信息则一定存在)	用户昵称
portraitUrl	string	否(如果存在用户信息则一定存在)	用户头像

16.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"authCode\":\"authCode1\"}" http://domain:18080/admin/user/app_get_user_info

{
  "code":0,
  "msg":"success"
  "result":{
    "userId":"userid1",
    "dispalyName":"name1",
    "portraitUrl":"url"
  }
}

17. 创建或更新设备(仅专业版支持)

创建或更新设备信息。

17.0.1. 地址

http://domain:18080/admin/device/create_or_update

17.0.2. body

参数	类型	必需	描述
deviceId	string	否	设备ID
owners	string[]	否	设备拥有者用户ID列表
extra	string	否	附加信息

17.0.3. 响应

参数	类型	必需	描述
deviceId	string	是	设备ID
token	string	是	设备token
secret	string	是	设备密钥

17.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"deviceId\":\"device1\",       \
    \"owners\":[\"user1\",\"user2\"],                        \
    \"extra\":\"extra info\"                        \
  }"                                \
  http://localhost:18080/admin/device/create_or_update

{
  "code":0,
  "msg":"success",
  "result":{
    "deviceId":"device1",
    "token":"token123",
    "secret":"secret456"
  }
}

18. 获取设备信息(仅专业版支持)

获取设备详细信息。

18.0.1. 地址

http://domain:18080/admin/device/get

18.0.2. body

参数	类型	必需	描述
deviceId	string	是	设备ID

18.0.3. 响应

参数	类型	必需	描述
deviceId	string	是	设备ID
token	string	是	设备token
secret	string	是	设备密钥
state	int	是	设备状态
owners	string[]	否	设备拥有者列表
extra	string	否	附加信息

18.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"deviceId\":\"device1\"}" http://localhost:18080/admin/device/get

{
  "code":0,
  "msg":"success",
  "result":{
    "deviceId":"device1",
    "token":"token123",
    "secret":"secret456",
    "state":1,
    "owners":["user1"]
  }
}

19. 获取用户设备列表

获取指定用户的所有设备。

19.0.1. 地址

http://domain:18080/admin/device/user_devices

19.0.2. body

参数	类型	必需	描述
userId	string	是	用户ID

19.0.3. 响应

参数	类型	必需	描述
devices	Object[]	是	设备列表

19.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"user1\"}" http://localhost:18080/admin/device/user_devices

{
  "code":0,
  "msg":"success",
  "result":{
    "devices":[{
      "deviceId":"device1",
      "token":"token123",
      "state":1
    }]
  }
}

20. 获取在线用户数量

获取系统中各个节点的在线用户数量。

20.0.1. 地址

http://domain:18080/admin/user/online_count

20.0.2. body

N/A

20.0.3. 响应

参数	类型	必需	描述
result	Object[]	是	节点在线用户统计

节点信息

参数	类型	必需	描述
node	int	是	节点ID
count	int	是	在线用户数量

20.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" http://localhost:18080/admin/user/online_count

{
  "code":0,
  "msg":"success",
  "result":[
    {
      "node":0,
      "count":1523
    },
    {
      "node":1,
      "count":876
    }
  ]
}

21. 获取在线用户列表

获取指定节点的在线用户列表。

21.0.1. 地址

http://domain:18080/admin/user/online_list

21.0.2. body

参数	类型	必需	描述
nodeId	int	是	节点ID
offset	int	是	偏移量
count	int	是	数量

21.0.3. 响应

参数	类型	必需	描述
userClients	Object[]	是	在线用户客户端列表
totalCount	int	是	总数量
offset	int	是	偏移量

用户客户端信息

参数	类型	必需	描述
userId	string	是	用户ID
clientId	string	是	客户端ID
platform	int	是	平台类型
ip	string	是	IP地址

21.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"nodeId\":0,\"offset\":0,\"count\":10}" http://localhost:18080/admin/user/online_list

{
  "code":0,
  "msg":"success",
  "result":{
    "userClients":[{
      "userId":"user1",
      "clientId":"client1",
      "platform":1,
      "ip":"192.168.1.100"
    }],
    "totalCount":1523,
    "offset":0
  }
}

22. 获取用户会话

获取指定用户的所有会话信息。

22.0.1. 地址

http://domain:18080/admin/user/session_list

22.0.2. body

参数	类型	必需	描述
userId	string	是	用户ID

22.0.3. 响应

参数	类型	必需	描述
userSessions	Object[]	是	用户会话列表

用户会话信息

参数	类型	必需	描述
userId	string	是	用户ID
clientId	string	是	客户端ID
platform	int	是	平台类型
pushType	int	是	推送类型
deviceToken	string	否	设备token
deviceVoipToken	string	否	VoIP token
isOnline	bool	是	是否在线

22.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"user1\"}" http://localhost:18080/admin/user/session_list

{
  "code":0,
  "msg":"success",
  "result":{
    "userSessions":[{
      "userId":"user1",
      "clientId":"client1",
      "platform":1,
      "pushType":0,
      "deviceToken":"token123",
      "isOnline":true
    }]
  }
}