View Source WeChat.Work.Contacts.User (wechat v0.12.0)

通讯录管理-成员管理

Link to this section Summary

Types

qrcode尺寸类型

每个成员都有唯一的 userid - 官方文档

Link to this section Types

@type size_type() :: 1..4

qrcode尺寸类型

  • 1: 171 x 171
  • 2: 399 x 399
  • 3: 741 x 741
  • 4: 2052 x 2052
@type userid() :: String.t()

每个成员都有唯一的 userid - 官方文档

即所谓“帐号”。在管理后台->“通讯录”->点进某个成员的详情页,可以看到。

@type userid_list() :: [userid()]

Link to this section Functions

Link to this function

batch_delete(client, userid_list)

View Source
@spec batch_delete(WeChat.Work.client(), userid_list()) :: WeChat.response()

批量删除成员 - 官方文档

对应管理端的帐号。最多支持200个。若存在无效UserID,直接返回错误

Link to this function

batch_invite(client, userid_list, party_id_list, tag_id_list)

View Source

邀请成员 - 官方文档

企业可通过接口批量邀请成员使用企业微信,邀请后将通过短信或邮件下发通知。

@spec create(WeChat.Work.client(), body :: map()) :: WeChat.response()

创建成员 - 官方文档

@spec delete(WeChat.Work.client(), userid()) :: WeChat.response()

删除成员 - 官方文档

读取成员 - 官方文档

在通讯录同步助手中此接口可以读取企业通讯录的所有成员信息,而自建应用可以读取该应用设置的可见范围内的成员信息。

Link to this function

get_active_stat(client, date)

View Source
@spec get_active_stat(WeChat.Work.client(), date :: String.t() | Date.t()) ::
  WeChat.response()

获取企业活跃成员数 - 官方文档

支持企业用户获取实时成员加入二维码。

Link to this function

get_join_qrcode(client, size_type)

View Source
@spec get_join_qrcode(WeChat.Work.client(), size_type()) :: WeChat.response()

获取加入企业二维码 - 官方文档

支持企业用户获取实时成员加入二维码。

Link to this function

join_confirm(client, userid)

View Source
@spec join_confirm(WeChat.Work.client(), userid()) :: WeChat.response()

二次验证 - 官方文档

此接口可以满足安全性要求高的企业进行成员验证。开启二次验证后,当且仅当成员登录时,需跳转至企业自定义的页面进行验证。验证频率可在设置页面选择。

企业在开启二次验证时,必须在管理端填写企业二次验证页面的url。

当成员登录企业微信或关注微工作台(原企业号)进入企业时,会自动跳转到企业的验证页面。在跳转到企业的验证页面时,会带上如下参数:code=CODE。

企业收到code后,使用 “通讯录同步助手” 调用接口 “根据code获取成员信息” 获取成员的userid。

如果成员是首次加入企业,企业获取到userid,并验证了成员信息后,调用如下接口即可让成员成功加入企业。

Link to this function

list_department_users(client, department_id, fetch_child \\ 0)

View Source

获取部门成员列表(简要) - 官方文档

获取部门成员列表

fetch_child 是否递归获取子部门下面的成员:

  • 1: 递归获取
  • 0: 只获取本部门
Link to this function

list_department_users_detail(client, department_id, fetch_child \\ 0)

View Source

获取部门成员列表(详情) - 官方文档

获取部门成员列表(详情)

fetch_child 是否递归获取子部门下面的成员:

  • 1: 递归获取
  • 0: 只获取本部门
Link to this function

openid2userid(client, openid)

View Source
@spec openid2userid(WeChat.Work.client(), WeChat.openid()) :: WeChat.response()

openid转userid - 官方文档

该接口主要应用于使用企业支付之后的结果查询。 开发者需要知道某个结果事件的 openid 对应企业微信内成员的信息时,可以通过调用该接口进行转换查询。

@spec update(WeChat.Work.client(), body :: map()) :: WeChat.response()

更新成员 - 官方文档

Link to this function

userid2openid(client, userid)

View Source
@spec userid2openid(WeChat.Work.client(), userid()) :: WeChat.response()

userid转openid - 官方文档

该接口使用场景为企业支付,在使用企业红包和向员工付款时,需要自行将企业微信的 userid 转成 openid

注:需要成员使用微信登录企业微信或者关注微工作台(原企业号)才能转成 openid; 如果是外部联系人,请使用外部联系人 openid 转换 openid