目录
企业微信通过向服务商开放接口,实现企业微信与服务商产品之间的相互调用,一起满足企业在各应用场景下的使用需求。为了确保服务商正确与规范的使用接口,企业微信向服务商颁发接口调用许可。
服务商在获得调用许可并在企业管理员授权后,可将账号激活码绑定到企业成员,以激活基于该成员调用企业微信接口的能力。
开通接口调用许可时,服务商向企业微信支付许可费用,同时取消现有的按照收款资金固定比例收取的“技术服务费”。
许可账号,也即接口调用许可账号,按照能力的不同,分为两种类型:基础账号
与互通账号
。
服务商为企业提供服务时,至少需要为企业成员开通基础账号,才能为该成员调用身份验证、应用发消息等接口。
服务商为企业提供微信客户联系相关的功能时,需要为企业成员开通互通账号。开通了互通账号,自动拥有了基础账号的能力。
下文中,如无特殊说明,接口调用许可账号
将简称为许可账号
,或者账号
。
企业微信服务商管理端提供了下单、支付、绑定激活、退款等功能。为了提高服务商的工作效率,企业微信提供了以下接口,以让服务商可以更加自动化地处理账号激活等事务,从而让企业获得更好的使用体验。
一、下单购买账号
服务商下单为企业购买新的账号,可以同时购买基础账号与互通账号。下单之后,需要到服务商管理端发起支付,支付完成之后,订单才能生效。查看接口详情
二、下单续期账号
可以下单为一批已激活账号的成员续期。同样,下单之后,需要到服务商管理端发起支付,支付完成之后,订单才能生效。查看接口详情
三、获取订单详情
由于目前需要在服务商管理端手动发起支付,故服务商的系统有必要在某个时机查询订单的状态,当订单已支付完成,则可再调用获取订单中的账号列表接口,以获取账号激活码列表。查看接口详情
四、获取订单中的账号列表
查询指定订单下的接口许可账号列表。若为购买账号的订单,则返回账号激活码列表;若为续期账号的订单,则返回续期账号的成员列表。注意,若是购买账号的订单,则仅订单支付完成时,企业微信系统才会生成账号,故支付完成之前,该接口不会返回账号激活码。
当订单为购买账号的订单时,该接口尤其重要,因为获取到账号激活码列表之后,服务商后续可以自动地为企业的成员绑定激活相应的服务能力。
查看接口详情
五、激活账号
将账号激活码绑定到某个企业员工上,以对其激活相应的服务能力。查看接口详情
六、账号继承
在企业员工离职或者工作范围的有变更时,允许将其许可账号继承给其他员工。查看接口详情
七、其他接口
除了以上六个关键的接口,企业微信还提供了获取订单列表、获取激活码详情、获取企业的账号列表、获取成员的激活详情等接口,以让服务商可以在自己的系统中实现完整的接口调用许可管理。
如果服务商没有为企业成员开通接口许可,或者已开通的接口许可过期,原则上将无法为该企业成员调用企业微信的接口,服务商需要及时开通或续期接口许可。目前明确有影响的接口包括但不限于以下列表。
基础账号失效包括两种情况:1. 未配置基础账号,2. 基础账号已过期。
特别地,若配置了有效的互通账号,则自动拥有了基础账号。
接口 | 失效的表现 |
---|---|
身份验证 | 提示用户联系服务商购买基础账号 |
小程序登录 | 提示用户联系服务商购买基础账号 |
发送应用消息 | touser中基础账号失效的成员会返回在unlicenseduser中, toparty或totag中基础账号失效的成员将收不到该应用消息 |
创建日程 | admins和attendees中若存在基础账号失效的成员,接口返回错误码701099 |
更新日程 | admins和attendees中若存在基础账号失效的成员,接口返回错误码701099 |
新增日程参与者 | attendees中若存在基础账号失效的成员,接口返回错误码701099 |
创建预约会议 | admin_userid和attendees中若存在基础账号失效的成员,接口返回错误码701099 |
修改预约会议 | admin_userid和attendees中若存在基础账号失效的成员,接口返回错误码701099 |
新建文档 | admin_users中若存在基础账号失效的成员,接口返回错误码701099 |
修改文档成员及权限 | update_file_member_list.userid中若存在基础账号失效的企业内成员,接口返回错误码701099 |
新建收集表 | fill_in_range.userids或fill_in_range.departmentids中若存在基础账号失效的企业内成员,接口返回错误码701099 |
编辑收集表 | fill_in_range.userids或fill_in_range.departmentids中若存在基础账号失效的企业内成员,接口返回错误码701099 |
新建空间 | auth_info.userid或auth_info.departmentid中若存在基础账号失效的企业内成员,接口返回错误码701099 |
添加成员/部门 | auth_info.userid或auth_info.departmentid中若存在基础账号失效的企业内成员,接口返回错误码701099 |
发送邮件 | to.userid、cc.userid、bcc.userid中若存在基础账号失效的企业内成员(邮箱地址不受影响),接口返回错误码701099 |
互通账号失效包括两种情况:1. 未配置互通账号,2. 互通账号已过期。
接口 | 失效的表现 |
---|---|
获取客户列表 | 若成员的互通账号失效,则无法获取该成员的客户列表,此时接口返回错误码701008 |
获取客户详情 | 若成员的互通账号失效,返回的跟进人follow_user不包含该成员; 若客户的所有跟进人均无有效互通账号,则无法获取该客户的详情,此时接口返回错误码701008 |
批量获取客户详情 | 若成员的互通账号失效,则无法获取该成员的客户列表; 若客户的所有跟进人均无有效互通账号,则无法获取该客户的详情;若全部跟进人均无有效互通账号,此时接口返回错误码701008 |
获取客户群列表 | 若群主的互通账号失效,则无法获取群主对应的客户列表;若所有群主均无有效互通账号,此时接口返回错误码701008 |
获取客户群详情 | 若群主的互通账号失效,则无法获取该群的详情,此时接口返回错误码701008 |
微信客服添加接待人员 | 若成员的互通账号失效,则无法将其添加到微信客服的接待人员里,此时接口返回的结果里相应的userid错误码为701008 |
微信客服变更会话状态 | 若成员的互通账号失效,则无法为其分配客服会话,此时接口返回错误码701008 |
微信客服为客户升级为专员或客户群服务 | 若成员的互通账号失效,则无法将该成员作为专员或客户群群主推荐给客户,此时接口返回错误码701008 |
回调 | 失效的表现 |
---|---|
添加企业客户事件 | 若成员的互通账号失效,则该成员有新添加的客户时,不回调事件 |
由于企业授权安装服务商的应用之后,会有90天的免费试用期,服务商难以测试到接口不可调用的表现,企业微信发布了测试企业
的功能,服务商可在 服务商管理端-应用管理-开发配置 或者 服务商助手-工具-通用配置-开发配置 配置测试企业。配置为测试的企业,有以下特点:
通过测试企业,服务商可以方便地调试到有许可账号和无许可账号的不同表现。