View Source WeChat.Work.Contacts.User (wechat v0.16.0)
通讯录管理-成员管理
Summary
Types
Functions
@spec batch_delete(WeChat.Work.client(), WeChat.Work.agent(), userid_list()) :: WeChat.response()
批量删除成员 - 官方文档
对应管理端的帐号。最多支持200个。若存在无效UserID,直接返回错误
batch_invite(client, agent, userid_list, party_id_list, tag_id_list)
View Source@spec batch_invite( WeChat.Work.client(), WeChat.Work.agent(), nil | userid_list(), nil | WeChat.Work.Contacts.Department.id_list(), nil | WeChat.Work.Contacts.Tag.tag_id_list() ) :: WeChat.response()
邀请成员 - 官方文档
企业可通过接口批量邀请成员使用企业微信,邀请后将通过短信或邮件下发通知。
@spec create(WeChat.Work.client(), WeChat.Work.agent(), body :: map()) :: WeChat.response()
创建成员 - 官方文档
@spec delete(WeChat.Work.client(), WeChat.Work.agent(), userid()) :: WeChat.response()
删除成员 - 官方文档
@spec get(WeChat.Work.client(), WeChat.Work.agent(), userid()) :: WeChat.response()
读取成员 - 官方文档
在通讯录同步助手中此接口可以读取企业通讯录的所有成员信息,而自建应用可以读取该应用设置的可见范围内的成员信息。
@spec get_join_qrcode(WeChat.Work.client(), WeChat.Work.agent(), size_type()) :: WeChat.response()
获取加入企业二维码 - 官方文档
支持企业用户获取实时成员加入二维码。
@spec get_userid(WeChat.Work.client(), WeChat.Work.agent(), mobile :: String.t()) :: WeChat.response()
手机号获取 userid - 官方文档
通过手机号获取其所对应的userid。
@spec get_userid_by_email( WeChat.Work.client(), WeChat.Work.agent(), email :: String.t(), email_type :: 1 | 2 ) :: WeChat.response()
邮箱获取 userid - 官方文档
通过邮箱获取其所对应的userid。
@spec join_confirm(WeChat.Work.client(), WeChat.Work.agent(), userid()) :: WeChat.response()
二次验证 - 官方文档
此接口可以满足安全性要求高的企业进行成员验证。开启二次验证后,当且仅当成员登录时,需跳转至企业自定义的页面进行验证。验证频率可在设置页面选择。
企业在开启二次验证时,必须在管理端填写企业二次验证页面的url。
当成员登录企业微信或关注微工作台(原企业号)进入企业时,会自动跳转到企业的验证页面。在跳转到企业的验证页面时,会带上如下参数:code=CODE。
企业收到code后,使用 “通讯录同步助手” 调用接口 “根据code获取成员信息” 获取成员的userid。
如果成员是首次加入企业,企业获取到userid,并验证了成员信息后,调用如下接口即可让成员成功加入企业。
@spec list_department_users( WeChat.Work.client(), WeChat.Work.agent(), WeChat.Work.Contacts.Department.id() ) :: WeChat.response()
获取部门成员(简要) - 官方文档
@spec list_department_users_detail( WeChat.Work.client(), WeChat.Work.agent(), WeChat.Work.Contacts.Department.id() ) :: WeChat.response()
获取部门成员(详情) - 官方文档
@spec list_id( WeChat.Work.client(), WeChat.Work.agent(), cursor :: String.t(), limit :: 1..10000 ) :: WeChat.response()
获取成员ID列表 - 官方文档
获取企业成员的userid与对应的部门ID列表,预计于2022年8月8号发布。若需要获取其他字段,参见「适配建议」。
@spec openid2userid(WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid()) :: WeChat.response()
openid转userid - 官方文档
该接口主要应用于使用企业支付之后的结果查询。
开发者需要知道某个结果事件的 openid
对应企业微信内成员的信息时,可以通过调用该接口进行转换查询。
@spec update(WeChat.Work.client(), WeChat.Work.agent(), body :: map()) :: WeChat.response()
更新成员 - 官方文档
@spec userid2openid(WeChat.Work.client(), WeChat.Work.agent(), userid()) :: WeChat.response()
userid转openid - 官方文档
该接口使用场景为企业支付,在使用企业红包和向员工付款时,需要自行将企业微信的 userid
转成 openid
。
注:需要成员使用微信登录企业微信或者关注微工作台(原企业号)才能转成 openid
;
如果是外部联系人,请使用外部联系人 openid
转换 openid