概述与指引
接口调用许可
接口调用许可帐号
基础帐号
与互通帐号
。服务商为企业提供服务时,至少需要为企业成员开通基础帐号,才能为该成员调用身份验证、应用发消息等接口。
服务商为企业提供微信客户联系相关的功能时,需要为企业成员开通互通帐号。开通了互通帐号,自动拥有了基础帐号的能力。
下文中,如无特殊说明,
接口调用许可帐号
将简称为许可帐号
,或者帐号
。接入指引
服务商下单为企业购买新的帐号,可以同时购买基础帐号与互通帐号。下单之后,需要到服务商管理端发起支付,支付完成之后,订单才能生效。查看接口详情
可以下单为一批已激活帐号的成员续期。同样,下单之后,需要到服务商管理端发起支付,支付完成之后,订单才能生效。查看接口详情
由于目前需要在服务商管理端手动发起支付,故服务商的系统有必要在某个时机查询订单的状态,当订单已支付完成,则可再调用获取订单中的帐号列表接口,以获取帐号激活码列表。查看接口详情
查询指定订单下的接口许可帐号列表。若为购买帐号的订单,则返回帐号激活码列表;若为续期帐号的订单,则返回续期帐号的成员列表。注意,若是购买帐号的订单,则仅订单支付完成时,企业微信系统才会生成帐号,故支付完成之前,该接口不会返回帐号激活码。
当订单为购买帐号的订单时,该接口尤其重要,因为获取到帐号激活码列表之后,服务商后续可以自动地为企业的成员绑定激活相应的服务能力。
查看接口详情
将帐号激活码绑定到某个企业员工上,以对其激活相应的服务能力。查看接口详情
在企业员工离职或者工作范围的有变更时,允许将其许可帐号继承给其他员工。查看接口详情
除了以上六个关键的接口,企业微信还提供了获取订单列表、获取激活码详情、获取企业的帐号列表、获取成员的激活详情等接口,以让服务商可以在自己的系统中实现完整的接口调用许可管理。
许可帐号失效的表现
基础帐号失效的接口表现
基础帐号失效包括两种情况: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 |
回调 | 失效的表现 |
---|---|
添加企业客户事件 | 若成员的互通帐号失效,则该成员有新添加的客户时,不回调事件 |