用户

1. 获取用户token

1.0.1. 地址

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

1.0.2. body

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

1.0.3. 平台

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

1.0.4. 响应

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

2.0.3. 响应

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

3.0.3. 响应

如果创建时不填写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

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

5.0.3. 响应

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/update_block_status

6.0.2. body

6.0.3. 响应

N/A

6.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"
}

7. 查询用户状态

7.0.1. 地址

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

7.0.2. body

7.0.3. 响应

7.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
  }
}

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

8.0.1. 地址

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

8.0.2. body

N/A

8.0.3. 响应

8.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,
    },
  ]
}

9. 获取用户在线状态

9.0.1. 地址

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

9.0.2. body

9.0.3. 响应

9.0.4. session

9.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
  }]
}

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

10.0.1. 地址

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

10.0.2. body

10.0.3. 响应

N/A

10.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"
}

11. 获取机器人信息

11.0.1. 地址

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

11.0.2. body

11.0.3. 响应

11.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"
  }
}

12. 销毁用户或者机器人

12.0.1. 地址

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

12.0.2. body

12.0.3. 响应

N/A

12.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"
}

13. 验证用户

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

13.0.1. 地址

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

13.0.2. body

13.0.3. 响应

13.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"
  }
}