用户列表 | API文档

# 用户列表

# 接口说明

项	值
URL	`/openapi/v1/user/list.json`
描述	用户列表
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
ids	array	用户id	否
pageDto	object	分页信息 (可不传)	否
bizNum	string	子商户number。多商户模式下可指定查询具体子商户下的数据	否

# 请求数据

{
    "ids":["123abc","456qwe"],
    "pageDto" : {          // 分页信息 (可不传)
        "pageSize" : 20,   // 每页显示数量 最大100 默认20
        "pageNum" : 1      // 页码 (从1开始) 默认1
    }
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : [
        {
            "id": "123abc", //user的num
            "name": "wang",
            "mobile":"110",
            "disable": 0,   // 是否禁用 0: 否 1： 是
            "nodeName": "xxxx", // 所在部门名称
            "avatar":"https://xxx", //用户头像
            "liveNickname":"accc" //直播间昵称
        }
    ],
    "pageDto" : {
        "pageSize" : 20,
        "pageNum" : 1,
        "count" : 100,
        "totalPageNum" : 5
    }
}

# 用户新增

# 接口说明

项	值
URL	`/openapi/v1/user/add.json`
描述	用户新增
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
mobile	string	手机号	是
name	string	名称	是
nodeId	string	所属部门id	是
nodeIds	List	管辖部门id列表	否
avatar	string	头像url	否
liveNickname	string	直播间昵称	否

# 请求数据

{
  "mobile": "13166667777",
  "name": "test01",
  "nodeId": "123abc",
  "nodeIds":[],
  "avatar": "http://xxx",
  "liveNickname":"q123"
}

# 返回数据

{
    "code" : 200,
    "msg" : "111abc", 
    "data" : "111abc",//用户id
    "pageDto" : null
}

# 用户编辑

# 接口说明

项	值
URL	`/openapi/v1/user/mod.json`
描述	用户编辑
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	string	用户id	是
mobile	string	手机号	是
name	string	用户名称	否
nodeId	string	所属部门id	是
nodeIds	List	管辖部门id列表	否
avatar	string	头像url	否
liveNickname	string	直播间昵称	否

# 请求数据

{
  "id": "123abc",
  "name": "api01-02",
  "mobile": "13166667777",
  "nodeId": "555abc",
  "nodeIds":[],
  "avatar": "http://xxx",
  "liveNickname":"q123"
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : "",
    "pageDto" : null
}

# 用户详情

# 接口说明

项	值
URL	`/openapi/v1/user/detail.json`
描述	用户详情
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	string	用户id	是

# 请求数据

{
    "ids":"123abc"
}

# 返回数据

{
    "msg": "",
    "code": 200,
    "data": {
        "id": "123abc", //用户id
        "name": "api01-02", //用户名称
        "mobile": "13166667777",//用户手机号
        "disable": 0, //是否禁用 1:是 0:否
        "nodeName": "api-01", //所属部门名称
        "avatar": "http://xxxx", //用户头像
        "liveNickname":"accc" //直播间昵称
    },
    "pageDto": null
}

# 用户启用禁用

# 接口说明

项	值
URL	`/openapi/v1/user/enableOrDisable.json`
描述	用户启用禁用
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	string	用户id	是
disabled	integer	是否禁用 0:否 1:是	是

# 请求数据

{
  "id": "123abc",
  "disabled":1
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : "",
    "pageDto" : null
}

# 用户修改密码

# 接口说明

项	值
URL	`/openapi/v1/user/modPassword.json`
描述	用户修改密码
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
id	string	用户id	是
oldPassword	string	旧密码	是
newPassword	string	新密码	是

# 请求数据

{
   "id":"123abc", 
  "oldPassword": "667788",
  "newPassword": "667777"
}

# 返回数据

{
    "code" : 200,
    "msg" : "",
    "data" : "",
    "pageDto" : null
}

# 用户企业微信账号列表

# 接口说明

项	值
URL	`/openapi/v1/user/weworkUserList.json`
描述	用户企业微信账号列表
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
ids	array	用户id	否
pageDto	object	分页信息（可不传）	否
bizNum	String	子商户number。多商户模式下可指定查询具体子商户下的数据	否

# 请求数据

{
    "ids":["123abc","456qwe"],
    "pageDto" : {          // 分页信息 (可不传)
        "pageSize" : 20,   // 每页显示数量 最大100 默认20
        "pageNum" : 1      // 页码 (从1开始) 默认1
    }
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": [
        {
          "id": "123abc", //用户id
          "corpId": "ww12344", //企微商户id
          "bizNum": "xxxx", //商户id
          "list": [
              {
                  "weworkUserId": "xxxxx", //企微id
                  "weworkUserName": "xxx" //企微名称
              }
          ]
       }
    ],
    "pageDto" : {
        "pageSize" : 20,
        "pageNum" : 1,
        "count" : 100,
        "totalPageNum" : 5
    }
}

# 用户企业微信账号列表（含所有主子商户）

# 接口说明

项	值
URL	`/openapi/v1/user/weworkUserListForAllBiz.json`
描述	用户企业微信账号列表（含所有主子商户）
请求方式	POST
需要登录	是
注意事项	无
其他	无

# 请求参数说明

字段名	字段类型	说明	是否必传
ids	array	用户id	否
pageDto	object	分页信息（可不传）	否

# 请求数据

{
    "ids":["123abc","456qwe"],
    "pageDto" : {          // 分页信息 (可不传)
        "pageSize" : 20,   // 每页显示数量 最大100 默认20
        "pageNum" : 1      // 页码 (从1开始) 默认1
    }
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": [
        {
          "id": "123abc", //用户id
          "corpId": "ww12344", //企微商户id
          "list": [
              {
                  "weworkUserId": "xxxxx", //企微id
                  "weworkUserName": "xxx" //企微名称
              }
          ]
       }
    ],
    "pageDto" : {
        "pageSize" : 20,
        "pageNum" : 1,
        "count" : 100,
        "totalPageNum" : 5
    }
}

← 消息加密说明角色 →