获取员工列表
GET
/open-api/staff/list获取员工列表。
列表按照微伴系统内的员工创建时间进行排序,可根据更新时间选取区间进行筛选数据。
因为微伴系统内员工各数据字段来源不同(自建应用,第三方应用,消息存档应用),如果员工未在特定来源下授权给微伴,则来自此来源的对应数据字段可能缺失。
具体授权情况请根据员工数据中的 ia_authorized, oa_authorized, ma_authorized 字段进行判断。调用此接口需购买基础席位。
请求参数
Query 参数
start_time
开始时间
示例值:
1640833484
end_time
结束时间
示例值:
1640833485
limit
string
可选
列表返回长度。默认值为30,最大值为100
示例值:
30
offset
string
可选
列表偏移。用于迭代获取所有数据,默认值为0
示例值:
0
fields
string
可选
如需要获取部门ID需带上此参数,["department"]
示例值:
["department"]
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
errcode
integer
可选
状态码,0为正常,非0代表错误。业务错误码下述,全局错误码见 全局错误码
errmsg
string
可选
错误信息,成功时为'ok',错误时会以中文方式显示错误原因
total
integer
员工总数
staff_list
array [object {23}]
员工列表
id
string
员工id
alias
string
员工别名
name
string
员工名称
english_name
string | null
员工英文名称
status
integer
可选
激活状态。1=已激活,2=已禁用,4=未激活。已激活代表已激活企业微信或已关注微工作台(原企业号)。未激活代表既未激活企业微信又未关注微工作台(原企业号)。如果一个员工被移除了企业(比如离职),也会是状态4
address
string | null
地址
avatar
string
员工头像
created_at
integer
可选
数据创建时间(微伴系统内时间)
department
array[string]
员工所属部门ID
email
string
邮箱
extattr
object | null
可选
员工扩展属性,由企业微信提供,具体见企业微信对应文档
mobile
string
手机号码
moment_address
string | null
企业朋友圈地址
oa_authorized
boolean
可选
是否在第三方应用授权
position
string
职位信息
qr_code
string
可选
员工个人二维码,扫描可添加为外部联系人
telephone
string
座机
external_contact_able
boolean
可选
是否配置了客户联系功能(既是否属于客服)
external_position
string | null
可选
对外职务。 第三方仅通讯录应用可获取
external_profile
object | null
可选
员工自定义展示信息,可以有多个字段和多种类型,包括文本,网页和小程序,仅当联系人类型是企业微信用户时/有此字段,字段详情见企业微信对应文档
gender
integer
可选
员工性别。0-未知 1-男性 2-女性
ia_authorized
boolean
是否在自建应用授权
ma_authorized
boolean
是否在消息存档授权
示例
{
"errcode": 0,
"errmsg": "ok",
"total": 1,
"staff_list": [
{
"id": "zhangsan",
"alias": "小张",
"name": "张三",
"english_name": "San Zhang",
"status": 1,
"address": "xxx",
"avatar": "http://wework.qpic.cn/bizmail/6orVYFdOtxfZXkvvYWRWL83jpYATML7JcbDnYCB8PftMfuLwqzD9bQ/",
"created_at": 1578942639,
"email": "xxx",
"extattr": {
"attrs": []
},
"mobile": "13600000000",
"moment_address": "http://wtjpnamxad.devclient.weibanzhushou.com/mobile/moment?code=8M5780D883C9E5D071E9C737C7406C9FCDC0DC6A75CBEF5819A830A9982D241DF098812041B95019BC042CA4DF019C46",
"oa_authorized": true,
"position": "xxxx",
"qr_code": "https://open.work.weixin.qq.com/wwopen/userQRCode?vcode=vc9d8f940363c17952",
"telephone": "021-10000000",
"external_contact_able": true,
"external_position": null,
"external_profile": {
"external_attr": [],
"external_corp_name": ""
},
"gender": 1,
"ia_authorized": true,
"ma_authorized": true
}
]
}
修改于 6 个月前