用户

1. 获取用户token

1.0.1. 地址

http://domain/admin/user/get_token

1.0.2. body

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

clientId为客户端ID,客户端SDK有获取clientId的接口

1.0.3. 响应

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

1.0.4. 示例

curl -X POST -H "nonce:14723" -H "timestamp":"1539698981861" -H "sign":"9e9f98672f466a81e6dd61570689528cf38e6418" -H "Content-Type:application/json" -d "{\"userId\":\"a\",\"clientId\":\"xxxxx\"}" http://localhost/admin/user/get_token

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

2. 注册/更新用户

2.0.1. 地址

http://domain/admin/user/create

2.0.2. body

参数 类型 必需 描述
userId string 用户ID,如果传空,系统会自动生成一个用户id
name string 登陆名
password string 用户密码,可以为空,如果为空,用户不可以在野火IM服务器登陆
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:14723" -H "timestamp":"1539698981861" -H "sign":"9e9f98672f466a81e6dd61570689528cf38e6418" -H "Content-Type:application/json" -d "{\"name\":\"a\",\"displayName\":\"A\",\"password\":\"123456\"}" http://localhost/admin/user/create

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

3. 获取用户信息

3.0.1. 地址

http://domain/admin/user/get_info

3.0.2. body

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

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:14723" -H "timestamp":"1539698981861" -H "sign":"9e9f98672f466a81e6dd61570689528cf38e6418" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost/admin/user/get_info

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

4. 更新用户状态

封禁/禁言用户

4.0.1. 地址

http://domain/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:14723" -H "timestamp":"1539698981861" -H "sign":"9e9f98672f466a81e6dd61570689528cf38e6418" -H "Content-Type:application/json" -d "{\"userId\":\"a\", \"status\":1}" http://localhost/admin/user/update_block_status

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

5. 查询用户状态

5.0.1. 地址

http://domain/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:14723" -H "timestamp":"1539698981861" -H "sign":"9e9f98672f466a81e6dd61570689528cf38e6418" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost/admin/user/check_block_status

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

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

6.0.1. 地址

http://domain/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:14723" -H "timestamp":"1539698981861" -H "sign":"9e9f98672f466a81e6dd61570689528cf38e6418" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost/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/admin/user/onlinestatus

7.0.2. body

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

7.0.3. 响应

参数 类型 必需 描述
status int 0 online, 1 have session offline, 2 no session

7.0.4. 示例

curl -X POST -H "nonce:14723" -H "timestamp":"1539698981861" -H "sign":"9e9f98672f466a81e6dd61570689528cf38e6418" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost/admin/user/onlinestatus

{
  "code":0,
  "msg":"success",
  "result":{
    "status":0
  }
}
2018 © wildfirechat.cn 京ICP备18060403号-1 all right reserved,powered by Gitbook该文件修订时间: 2019-05-25 14:48:40

results matching ""

    No results matching ""