用户

1. 获取用户token

1.0.1. 地址

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

1.0.2. body

参数 类型 必需 描述
userId string 用户ID
clientId string 客户端ID
platform int 平台类型iOS 1, Android 2, Windows 3, OSX 4, WEB = 5

clientId为客户端ID,客户端SDK有获取clientId的接口。如果需要开启多端互踢,需要使用正确的platform。

1.0.3. 响应

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

1.0.4. 示例

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",
    "imToken":"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 用户头像
mobile string 用户手机号码
email string 用户邮箱
address string 用户地址
company string 用户公司
extra string 附加信息

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\",\"password\":\"123456\"}" http://localhost:18080/admin/user/create

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

3. 获取用户信息

3.0.1. 地址

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

3.0.2. body

参数 类型 必需 描述
userId string 否(三个参数必须且只能存在一个) 用户ID
name string 否(三个参数必须且只能存在一个) 登陆名
mobile string 否(三个参数必须且只能存在一个) 用户手机号码

3.0.3. 响应

参数 类型 必需 描述
userId string 用户ID
name string 登陆名
displayName string 显示名字
portrait string 用户头像
mobile string 用户手机号码
email string 用户邮箱
address string 用户地址
company string 用户公司
extra string 附加信息

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

4. 更新用户状态

封禁/禁言用户

4.0.1. 地址

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

4.0.2. body

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

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 "{\"userId\":\"a\", \"status\":1}" http://localhost:18080/admin/user/update_block_status

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

5. 查询用户状态

5.0.1. 地址

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

5.0.2. body

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

5.0.3. 响应

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

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

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

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

6.0.1. 地址

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

6.0.2. body

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

6.0.3. 响应

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

6.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_blocked_list

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

7. 获取用户在线状态

7.0.1. 地址

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

7.0.2. body

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

7.0.3. 响应

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

7.0.4. session

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

7.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
  }]
}
2018 © wildfirechat.cn 京ICP备18060403号-1 all right reserved,powered by Gitbook该文件修订时间: 2020-03-25 10:46:54

results matching ""

    No results matching ""