# 查询员工信息

> 接口返回员工相关的基础属性，可用于客户跟进人，共享人，创建人id等的映射关系建立

```
POST https://qw-openapi-tx.dustess.com/customer/v1/getStaffList?accessToken=

Content-Type: application/json
```

**应用场景**

- 员工id可作为联系人的跟进人、共享人、创建人；企业的跟进人
- 员工id可作为订单的业绩归属人、创建人
- 同1个员工退出企业后再重新加入企业，id将会被更新(属于新员工)



**接口限制**：每分钟调用600次；单次最大限制500；


**请求参数**

| 请求参数名         | 类型     | 说明                                                             | 是否必须 |
| ------------------ | -------- | ---------------------------------------------------------------- | -------- |
| page               | `Int`    | 当前页数                                                         | true     |
| page_size          | `Int`    | 页记录数                                                         | true     |
| user_name          | `String` | 员工名称, 支持模糊查询, 仅支持中文、字母、数字，长度不能超过64位 | false    |
| phones             | `String` | 手机号, 多个手机号使用逗号隔开                                   | false    |
| qw_user_ids        | `String` | 企微userid，多个id使用逗号隔开                                   | false    |
| user_ids           | `String` | 员工id, 多个员工id使用逗号隔开                                   | false    |
| enable_scrm_status | `Int`    | 员⼯是否开启系统,（0-不限；1-是；2-否）                           | false    |
| cus_emp_codes | `String`    | 自定义员工编码，多个员工编号使用逗号隔开                           | false    |

**请求参数示例**
`json` - Request-Example:


```json
{
  "page": 2,
  "page_size": 20,
  "user_name": "",
  "phones": "18140111111,18234561111",
  "qw_user_ids": "xxxx,ffff",
  "user_ids": "1,2,3",
  "enable_scrm_status": 1,
  "cus_emp_codes": "xxxxx,yyyyy,zzzzz"
}
```

**成功响应**

| 响应参数名                   | 类型                | 说明                                                                                                                                                      |
| ---------------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| success                      | `Bool`              | 请求状态，true：成功，false：失败_Allowed values: true,false_                                                                                             |
| code                         | `Int`               | 响应代码                                                                                                                                                  |
| msg                          | `String`            | 消息提示                                                                                                                                                  |
| data                         | `Object`            | 数据信息                                                                                                                                                  |
| data.count                   | `Int`               | 员工总数量                                                                                                                                                |
| data.list                    | `Object[]`          | 员工信息                                                                                                                                                  |
| data.list._id                | `String`            | 员工id                                                                                                                                                    |
| data.list.avatar             | `String`            | 头像                                                                                                                                                      |
| data.list.department         | `Int[]`             | 部门id列表                                                                                                                                                |
| data.list.department_details | `Object[]`          | 部门详情 {id、name}列表                                                                                                                                   |
| data.list.isDelete           | `Bool`              | 是否离职 true：是，false：否_Allowed values: true,false_                                                                                                  |
| data.list.name               | `String`            | 名称                                                                                                                                                      |
| data.list.permit             | `Bool`              | 是否开启会话存档 true：是，false：否_Allowed values: true,false_                                                                                          |
| data.list.position           | `String`            | 职位                                                                                                                                                      |
| data.list.qr_code            | `String`            | 二维码                                                                                                                                                    |
| data.list.thumb_avatar       | `String`            | 头像缩略图                                                                                                                                                |
| data.list.userid             | `String`            | 企微员工id                                                                                                                                                |
| data.list.mobile             | `String`            | 电话号码                                                                                                                                                  |
| data.list.roles              | `Map[string]string` | 角色id和名称map                                                                                                                                           |
| data.list.extattr            | `Object`            | 成员额外属性                                                                                                                                              |
| data.list.external_profile   | `Object`            | 成员对外属性                                                                                                                                              |
| data.list.external_position  | `String`            | 对外职务                                                                                                                                                  |
| data.list.scrmEnable         | `Bool`              | 是否启用了scrm系统                                                                                                                                        |
| data.list.cus_emp_code       | `String`            | 自定义员工编号                                                                                                                                            |
| data.list.status             | `Int`               | 员工账号状态； 1=已激活(在职)，2=已禁用，4=未激活，5=退出企业(离职)，已激活代表已激活企业微信或已关注微信插件，未激活代表既未激活企业微信又未关注微信插件 |
| data.list.mainDepartment     | `Int`               | 员工所在主部门 |

**成功响应示例**


```json
 {
    "success": true,
    "msg": "OK",
    "data": {
      "count": 1,
      "list": [
        {
          "_id": "3986",
          "avatar": "https://wework.qpic.cn/bizmail/test/0",
          "department": [
            1
          ],
          "department_details": [
            {
              "id": 1,
              "name": "部门一"
            }
          ],
          "isDelete": false,
          "name": "ttt",
          "permit": false,
          "position": "",
          "qr_code": "https://open.work.weixin.qq.com/wwopen/userQRCode?vcode=test",
          "roles": {
            "84320658-1111-1111-1111-1e6f213706fd": "xxxx"
          },
          "status": 1,
          "thumb_avatar": "https://wework.qpic.cn/bizmail/test/100",
          "userid": "ZhangSan",
          "enable": 0,
          "alias": "",
          "extattr": {"a":"b"},
          "external_position": "",
          "external_profile": {
            "external_attr": null,
            "external_corp_name": ""
          },
          "scrmEnable": false,
          "mobile": "18140111111",
          "mainDepartment": 0
        }
      ]
    }
  }
```


**错误响应示例**


```json
 {
    "success": false,
    "code": 10001,
    "msg": "system unknown error",
    "data": null
}
```
