1 获取access_token

获取access_token是调用企业微信API接口的第一步,相当于创建了一个登录凭证,其它的业务API接口,都需要依赖于access_token来鉴权调用者身份。

因此开发者,在使用业务接口前,要明确access_token的颁发来源,使用正确的access_token。

GET_ACCESS_TOKEN GET /cgi-bin/gettoken 1
1 获取企业的jsapi_ticket

生成签名之前必须先了解一下jsapi_ticket,jsapi_ticket是H5应用调用企业微信JS接口的临时票据。正常情况下,jsapi_ticket的有效期为7200秒,通过access_token来获取。由于获取jsapi_ticket的api调用次数非常有限(一小时内,一个企业最多可获取400次,且单个应用不能超过100次),频繁刷新jsapi_ticket会导致api调用受限,影响自身业务,开发者必须在自己的服务全局缓存jsapi_ticket。

GET_JSAPI_TICKET GET /cgi-bin/get_jsapi_ticket?access_token=ACCESS_TOKEN 2
1 获取企业微信API域名IP段

API域名IP即qyapi.weixin.qq.com的解析地址,由开发者调用企业微信端的接入IP。如果企业需要做防火墙配置,那么可以通过这个接口获取到所有相关的IP段。IP段有变更可能,当IP段变更时,新旧IP段会同时保留一段时间。建议企业每天定时拉取IP段,更新防火墙设置,避免因IP段变更导致网络不通。

GET_API_DOMAIN_IP GET /cgi-bin/get_api_domain_ip?access_token=ACCESS_TOKEN 3
2 通讯录管理 > 成员管理 > 创建成员 USER_CREATE GET /cgi-bin/user/create?access_token=ACCESS_TOKEN 11001 2 通讯录管理 > 成员管理 > 读取成员

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

USER_GET GET /cgi-bin/user/get?access_token=ACCESS_TOKEN 11002

应用只能获取可见范围内的成员信息,且每种应用获取的字段有所不同,在返回结果说明中会逐个说明。企业通讯录安全特别重要,企业微信将持续升级加固通讯录接口的安全机制,以下是关键的变更点:

  • 从2022年6月20号20点开始,除通讯录同步以外的基础应用(如客户联系、微信客服、会话存档、日程等),以及新创建的自建应用与代开发应用,调用该接口时,不再返回以下字段:头像、性别、手机、邮箱、企业邮箱、员工个人二维码、地址,应用需要通过oauth2手工授权的方式获取管理员与员工本人授权的字段。
  • 【重要】从2022年8月15日10点开始,“企业管理后台 - 管理工具 - 通讯录同步”的新增IP将不能再调用此接口,企业可通过「获取成员ID列表」和 「获取部门ID列表」接口获取userid和部门ID列表。查看调整详情。
2 通讯录管理 > 成员管理 > 更新成员 USER_UPDATE GET /cgi-bin/user/get?access_token=ACCESS_TOKEN 11003 2 通讯录管理 > 成员管理 > 删除成员

仅通讯录同步助手或第三方通讯录应用可调用。

若是绑定了腾讯企业邮,则会同时删除邮箱帐号。

USER_DELETE POST /cgi-bin/user/delete?access_token=ACCESS_TOKEN 11004
2 通讯录管理 > 成员管理 > 批量删除成员 USER_BATCH_DELETE POST /cgi-bin/user/batchdelete?access_token=ACCESS_TOKEN 11005 2 通讯录管理 > 成员管理 > 获取部门成员 USER_SIMPLE_LIST GET /cgi-bin/user/simplelist?access_token=ACCESS_TOKEN 11006

企业通讯录安全特别重要,企业微信将持续升级加固通讯录接口的安全机制,以下是关键的变更点::

2 通讯录管理 > 成员管理 > 获取部门成员详情 USER_LIST GET /cgi-bin/user/list?access_token=ACCESS_TOKEN 11007

应用只能获取可见范围内的成员信息,且每种应用获取的字段有所不同,在返回结果说明中会逐个说明。企业通讯录安全特别重要,企业微信持续升级加固通讯录接口的安全机制,以下是关键的变更点:

  • 从2022年6月20号20点开始,除通讯录同步以外的基础应用(如客户联系、微信客服、会话存档、日程等),以及新创建的自建应用与代开发应用,调用该接口时,不再返回以下字段:头像、性别、手机、邮箱、企业邮箱、员工个人二维码、地址,应用需要通过oauth2手工授权的方式获取管理员与员工本人授权的字段。
  • 【重要】从2022年8月15日10点开始,“企业管理后台 - 管理工具 - 通讯录同步”的新增IP将不能再调用此接口,企业可通过「获取成员ID列表」和 「获取部门ID列表」接口获取userid和部门ID列表。查看调整详情。
2 通讯录管理 > 成员管理 > userid与openid互换 > userid转openid

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



注:需要成员使用微信登录企业微信或者关注微信插件(原企业号)才能转成openid;

如果是外部联系人,请使用 外部联系人openid转换转换openid

USERID_TO_OPENID POST /cgi-bin/user/convert_to_openid?access_token=ACCESS_TOKEN 11008
2 通讯录管理 > 成员管理 > userid与openid互换 > openid转userid

该接口主要应用于使用企业支付之后的结果查询。

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

OPENID_TO_USERID POST /cgi-bin/user/convert_to_userid?access_token=ACCESS_TOKEN 11009
2 通讯录管理 > 成员管理 > 二次验证 USER_AUTH_SUCCESS GET /cgi-bin/user/authsucc?access_token=ACCESS_TOKEN 11010 2 通讯录管理 > 成员管理 > 邀请成员

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

BATCH_INVITE /cgi-bin/batch/invite?access_token=ACCESS_TOKEN POST 11011
2 通讯录管理 > 成员管理 > 获取加入企业二维码

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

GET_JOIN_QRCODE /cgi-bin/corp/get_join_qrcode?access_token=ACCESS_TOKEN GET 11012
2 通讯录管理 > 成员管理 > 获取企业活跃成员数 GET_ACTIVE_MEMBERS /cgi-bin/corp/get_join_qrcode?access_token=ACCESS_TOKEN POST 11013 2 通讯录管理 > 成员管理 > 手机号获取userid

通过手机号获取其所对应的userid。

GETUSERID /cgi-bin/user/getuserid?access_token=ACCESS_TOKEN POST 11013
2 通讯录管理 > 成员管理 > 获取成员授权列表

当企业当前授权模式为成员授权时,可调用该接口获取成员授权列表。

LIST_MEMBER_AUTH /cgi-bin/user/list_member_auth?access_token=ACCESS_TOKEN POST 11014
2 通讯录管理 > 成员管理 > 查询成员用户是否已授权

当企业当前授权模式为成员授权时,可调用该接口查询成员用户是否已授权。

CHECK_MEMBER_AUTH /cgi-bin/user/check_member_auth?access_token=ACCESS_TOKEN POST 11015
2 通讯录管理 > 成员管理 > 获取选人ticket对应的用户

当企业以成员授权的方式安装了第三方应用,成员在企业微信终端通过选人jsapi选择通讯录,应用获取到selectedTicket后,可调用该接口获取SelectedTicket对应的用户open_userid列表。

LIST_SELECTED_TICKET_USER /cgi-bin/user/list_selected_ticket_user?access_token=ACCESS_TOKEN POST 11016
2 通讯录管理 > 成员管理 > userid转换为open_userid

将自建应用或代开发应用获取的userid转换为第三方应用的userid

USERID_TO_OPENUSERID /cgi-bin/user/userid_to_openuserid?access_token=ACCESS_TOKEN POST 11017
2 通讯录管理 > 成员管理 > 邮箱获取userid

通过邮箱获取其所对应的userid。

GET_USERID_BY_EMAIL /cgi-bin/user/get_userid_by_email?access_token=ACCESS_TOKEN POST 11018
2 通讯录管理 > 成员管理 > 获取成员ID列表

获取企业成员的open_userid与对应的部门ID列表。

USER_LIST_ID /cgi-bin/user/list_id?access_token=ACCESS_TOKEN POST 11019
2 通讯录管理 > 部门管理 > 创建部门 DEPARTMENT_CREATE /cgi-bin/department/create?access_token=ACCESS_TOKEN POST 12001 2 通讯录管理 > 部门管理 > 更新部门 DEPARTMENT_UPDATE /cgi-bin/department/update?access_token=ACCESS_TOKEN POST 12002 2 通讯录管理 > 部门管理 > 删除部门 DEPARTMENT_DELETE /cgi-bin/department/delete?access_token=ACCESS_TOKEN GET 12003 2 通讯录管理 > 部门管理 > 获取部门列表

企业通讯录安全特别重要,企业微信将持续升级加固通讯录接口的安全机制,以下是关键的变更点:

  • 【重要】从2022年8月15日10点开始,“企业管理后台 - 管理工具 - 通讯录同步”的新增IP将不能再调用此接口,企业可通过「获取部门ID列表」接口获取部门ID列表。查看调整详情。
DEPARTMENT_LIST /cgi-bin/department/list?access_token=ACCESS_TOKEN GET 12004
2 通讯录管理 > 部门管理 > 获取子部门ID列表 DEPARTMENT_SIMPLELIST /cgi-bin/department/simplelist?access_token=ACCESS_TOKEN GET 12005 2 通讯录管理 > 部门管理 > 获取单个部门详情 DEPARTMENT_DETAILS /cgi-bin/department/get?access_token=ACCESS_TOKEN GET 12006

企业通讯录安全特别重要,企业微信将持续升级加固通讯录接口的安全机制,以下是关键的变更点:

  • 【重要】从2022年8月15日10点开始,“企业管理后台 - 管理工具 - 通讯录同步”的新增IP将不能再调用此接口,企业可通过「获取部门ID列表」接口获取部门ID列表。查看调整详情。
2 通讯录管理 > 标签管理 > 创建标签 TAG_CREATE /cgi-bin/tag/create?access_token=ACCESS_TOKEN POST 13001 2 通讯录管理 > 标签管理 > 更新标签名字 TAG_UPDATE /cgi-bin/tag/update?access_token=ACCESS_TOKEN POST 13002 2 通讯录管理 > 标签管理 > 删除标签 TAG_DELETE /cgi-bin/tag/delete?access_token=ACCESS_TOKEN GET 13003 2 通讯录管理 > 标签管理 > 获取标签成员 TAG_GET_MEMBER /cgi-bin/tag/get?access_token=ACCESS_TOKEN GET 13004 2 通讯录管理 > 标签管理 > 增加标签成员 TAG_ADD_MEMBER /cgi-bin/tag/addtagusers?access_token=ACCESS_TOKEN POST 13005 2 通讯录管理 > 标签管理 > 删除标签成员 TAG_DELETE_MEMBER /cgi-bin/tag/deltagusers?access_token=ACCESS_TOKEN POST 13006 2 通讯录管理 > 标签管理 > 获取标签列表 TAG_GET_LIST /cgi-bin/tag/list?access_token=ACCESS_TOKEN GET 13007 2 通讯录管理 > 异步批量接口 > 增量更新成员

本接口以userid(帐号)为主键,增量更新企业微信通讯录成员。请先下载CSV模板(下载增量更新成员模版),根据需求填写文件内容。



注意事项:



  1. 模板中的部门需填写部门ID,多个部门用分号分隔,部门ID必须为数字,根部门的部门id默认为1
  2. 文件中存在、通讯录中也存在的成员,更新成员在文件中指定的字段值
  3. 文件中存在、通讯录中不存在的成员,执行添加操作
  4. 通讯录中存在、文件中不存在的成员,保持不变
  5. 成员字段更新规则:可自行添加扩展字段。文件中有指定的字段,以指定的字段值为准;文件中没指定的字段,不更新

BATCH_SYNCUSER /cgi-bin/batch/syncuser?access_token=ACCESS_TOKEN POST 14001
2 通讯录管理 > 异步批量接口 > 全量覆盖成员

本接口以userid为主键,全量覆盖企业的通讯录成员,任务完成后企业的通讯录成员与提交的文件完全保持一致。请先下载CSV文件(下载全量覆盖成员模版),根据需求填写文件内容。



注意事项:



  1. 文件中存在、通讯录中也存在的成员,完全以文件为准
  2. 文件中存在、通讯录中不存在的成员,执行添加操作
  3. 文件中存在、通讯录中不存在的成员,执行添加操作
  4. 通讯录中存在、文件中不存在的成员,执行删除操作。出于安全考虑,下面两种情形系统将中止导入并返回相应的错误码。
    1. 需要删除的成员多于50人,且多于现有人数的20%以上
    2. 需要删除的成员少于50人,且多于现有人数的80%以上
  5. 成员字段更新规则:可自行添加扩展字段。文件中有指定的字段,以指定的字段值为准;文件中没指定的字段,不更新

BATCH_REPLACEUSER /cgi-bin/batch/replaceuser?access_token=ACCESS_TOKEN POST 14002
2 通讯录管理 > 异步批量接口 > 全量覆盖部门

本接口以partyid为键,全量覆盖企业的通讯录组织架构,任务完成后企业的通讯录组织架构与提交的文件完全保持一致。请先下载CSV文件(下载全量覆盖部门模版),根据需求填写文件内容。



注意事项:



  1. 文件中存在、通讯录中也存在的部门,执行修改操作
  2. 文件中存在、通讯录中不存在的部门,执行添加操作
  3. 文件中不存在、通讯录中存在的部门,当部门下没有任何成员或子部门时,执行删除操作
  4. 文件中不存在、通讯录中存在的部门,当部门下仍有成员或子部门时,暂时不会删除,当下次导入成员把人从部门移出后自动删除
  5. CSV文件中,部门名称、部门ID、父部门ID为必填字段,部门ID必须为数字,根部门的部门id默认为1;排序为可选字段,置空或填0不修改排序, order值大的排序靠前。

BATCH_REPLACEPARTY /cgi-bin/batch/replaceparty?access_token=ACCESS_TOKEN POST 14003
2 通讯录管理 > 异步批量接口 > 获取异步任务结果 BATCH_TASK_GET_RESULT /cgi-bin/batch/getresult?access_token=ACCESS_TOKEN GET 14004 2 通讯录管理 > 互联企业 > 获取应用的可见范围

本接口只返回互联企业中非本企业内的成员和部门的信息,如果要获取本企业的可见范围,请调用“获取应用”接口

LINKEDCORP_GET_PERM_LIST /cgi-bin/linkedcorp/agent/get_perm_list?access_token=ACCESS_TOKEN POST 15001
2 通讯录管理 > 互联企业 > 获取互联企业成员详细信息 LINKEDCORP_USER_GET /cgi-bin/linkedcorp/user/get?access_token=ACCESS_TOKEN POST 15002 2 通讯录管理 > 互联企业 > 获取互联企业部门成员 INKEDCORP_USER_SIMPLELIST /cgi-bin/linkedcorp/user/simplelist?access_token=ACCESS_TOKEN POST 15003 2 通讯录管理 > 互联企业 > 获取互联企业部门成员详情 LINKEDCORP_USER_LIST /cgi-bin/linkedcorp/user/list?access_token=ACCESS_TOKEN POST 15004 2 通讯录管理 > 互联企业 > 获取互联企业部门列表 LINKEDCORP_DEPARTMENT_LIST /cgi-bin/linkedcorp/department/list?access_token=ACCESS_TOKEN POST 15005 2 通讯录管理 > 异步导出接口 > 导出成员 EXPORT_SIMPLE_USER /cgi-bin/export/simple_user?access_token=ACCESS_TOKEN POST 16001 2 通讯录管理 > 异步导出接口 > 导出成员详情 EXPORT_USER /cgi-bin/export/user?access_token=ACCESS_TOKEN POST 16002 2 通讯录管理 > 异步导出接口 > 导出部门 EXPORT_DEPARTMENT /cgi-bin/export/department?access_token=ACCESS_TOKEN POST 16003 2 通讯录管理 > 异步导出接口 > 导出标签成员 EXPORT_TAGUSER /cgi-bin/export/taguser?access_token=ACCESS_TOKEN POST 16004 2 通讯录管理 > 异步导出接口 > 获取导出结果 EXPORT_GET_RESULT /cgi-bin/export/get_result?access_token=ACCESS_TOKEN GET 16005 3 客户联系 > 企业服务人员管理 > 获取配置了客户联系功能的成员列表

企业和第三方服务商可通过此接口获取配置了客户联系功能的成员列表。

EXTERNALCONTACT_GET_FOLLOW_USER_LIST /cgi-bin/externalcontact/get_follow_user_list?access_token=ACCESS_TOKEN GET 21001
3 客户联系 > 企业服务人员管理 > 客户联系「联系我」管理 > 配置客户联系「联系我」方式

企业可以在管理后台-客户联系-加客户中配置成员的「联系我」的二维码或者小程序按钮,客户通过扫描二维码或点击小程序上的按钮,即可获取成员联系方式,主动联系到成员。

企业可通过此接口为具有客户联系功能的成员生成专属的「联系我」二维码或者「联系我」按钮。

如果配置的是「联系我」按钮,需要开发者的小程序接入小程序插件。



注意:

通过API添加的「联系我」不会在管理端进行展示,每个企业可通过API最多配置50万个「联系我」。

用户需要妥善存储返回的config_id,config_id丢失可能导致用户无法编辑或删除「联系我」。

临时会话模式不占用「联系我」数量,但每日最多添加10万个,并且仅支持单人。

临时会话模式的二维码,添加好友完成后该二维码即刻失效。

EXTERNALCONTACT_ADD_CONTACT_WAY /cgi-bin/externalcontact/add_contact_way?access_token=ACCESS_TOKEN POST 21002
3 客户联系 > 企业服务人员管理 > 客户联系「联系我」管理 > 取企业已配置的「联系我」方式

获取企业配置的「联系我」二维码和「联系我」小程序按钮。

EXTERNALCONTACT_GET_CONTACT_WAY /cgi-bin/externalcontact/get_contact_way?access_token=ACCESS_TOKEN POST 21003
3 客户联系 > 企业服务人员管理 > 客户联系「联系我」管理 > 获取企业已配置的「联系我」列表

获取企业配置的「联系我」二维码和「联系我」小程序插件列表。不包含临时会话。

注意,该接口仅可获取2021年7月10日以后创建的「联系我」

EXTERNALCONTACT_LIST_CONTACT_WAY /cgi-bin/externalcontact/list_contact_way?access_token=ACCESS_TOKEN POST 21004
3 客户联系 > 企业服务人员管理 > 客户联系「联系我」管理 > 更新企业已配置的「联系我」方式

更新企业配置的「联系我」二维码和「联系我」小程序按钮中的信息,如使用人员和备注等。

EXTERNALCONTACT_UPDATE_CONTACT_WAY /cgi-bin/externalcontact/update_contact_way?access_token=ACCESS_TOKEN POST 21005
3 客户联系 > 企业服务人员管理 > 客户联系「联系我」管理 > 删除企业已配置的「联系我」方式

删除一个已配置的「联系我」二维码或者「联系我」小程序按钮。

EXTERNALCONTACT_DEL_CONTACT_WAY /cgi-bin/externalcontact/del_contact_way?access_token=ACCESS_TOKEN POST 21006
3 客户联系 > 企业服务人员管理 > 客户联系「联系我」管理 > 结束临时会话

将指定的企业成员和客户之前的临时会话断开,断开前会自动下发已配置的结束语。

EXTERNALCONTACT_CLOSE_TEMP_CHAT /cgi-bin/externalcontact/close_temp_chat?access_token=ACCESS_TOKEN POST 21007
3 客户联系 > 客户管理 > 获取客户列表

企业可通过此接口获取指定成员添加的客户列表。客户是指配置了客户联系功能的成员所添加的外部联系人。没有配置客户联系功能的成员,所添加的外部联系人将不会作为客户返回。

EXTERNALCONTACT_LIST /cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN GET 22001
3 客户联系 > 客户管理 > 获取客户详情

企业可通过此接口,根据外部联系人的userid,拉取客户详情。

EXTERNALCONTACT_GET /cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN GET 22002
3 客户联系 > 客户管理 > 批量获取客户详情

企业/第三方可通过此接口获取指定成员添加的客户信息列表。

EXTERNALCONTACT_BATCH_GET_BY_USER /cgi-bin/externalcontact/batch/get_by_user?access_token=ACCESS_TOKEN POST 22003
3 客户联系 > 客户管理 > 修改客户备注信息

企业可通过此接口修改指定用户添加的客户的备注信息。

EXTERNALCONTACT_REMARK /cgi-bin/externalcontact/remark?access_token=ACCESS_TOKEN POST 22004
3 客户联系 > 客户管理 > 客户联系规则组管理 > 获取规则组列表

企业可通过此接口获取企业配置的所有客户规则组id列表。

EXTERNALCONTACT_CUSTOMER_STRATEGY_LIST /cgi-bin/externalcontact/customer_strategy/list?access_token=ACCESS_TOKEN POST 22005
3 客户联系 > 客户管理 > 客户联系规则组管理 > 获取规则组详情

企业可以通过此接口获取某个客户规则组的详细信息。

EXTERNALCONTACT_CUSTOMER_STRATEGY_GET /cgi-bin/externalcontact/customer_strategy/get?access_token=ACCESS_TOKEN POST 22006
3 客户联系 > 客户管理 > 客户联系规则组管理 > 获取规则组管理范围

企业可通过此接口获取某个客户规则组管理的成员和部门列表

EXTERNALCONTACT_CUSTOMER_STRATEGY_GET_RANGE /cgi-bin/externalcontact/customer_strategy/get_range?access_token=ACCESS_TOKEN POST 22007
3 客户联系 > 客户管理 > 客户联系规则组管理 > 创建新的规则组

企业可通过此接口创建一个新的客户规则组。该接口仅支持串行调用,请勿并发创建规则组。

EXTERNALCONTACT_CUSTOMER_STRATEGY_CREATE /cgi-bin/externalcontact/customer_strategy/create?access_token=ACCESS_TOKEN POST 22008
3 客户联系 > 客户管理 > 客户联系规则组管理 > 编辑规则组及其管理范围

企业可通过此接口编辑规则组的基本信息和修改客户规则组管理范围。该接口仅支持串行调用,请勿并发修改规则组。

EXTERNALCONTACT_CUSTOMER_STRATEGY_EDIT /cgi-bin/externalcontact/customer_strategy/edit?access_token=ACCESS_TOKEN POST 22009
3 客户联系 > 客户管理 > 客户联系规则组管理 > 删除规则组

企业可通过此接口删除某个规则组。

EXTERNALCONTACT_CUSTOMER_STRATEGY_DEL /cgi-bin/externalcontact/customer_strategy/del?access_token=ACCESS_TOKEN POST 22010
3 客户联系 > 客户标签管理 > 管理企业标签 > 获取企业标签库

企业可通过此接口获取企业客户标签详情。

EXTERNALCONTACT_GET_CORP_TAG_LIST /cgi-bin/externalcontact/get_corp_tag_list?access_token=ACCESS_TOKEN POST 23001
3 客户联系 > 客户标签管理 > 管理企业标签 > 添加企业客户标签

企业可通过此接口向客户标签库中添加新的标签组和标签,每个企业最多可配置3000个企业标签。

EXTERNALCONTACT_ADD_CORP_TAG /cgi-bin/externalcontact/add_corp_tag?access_token=ACCESS_TOKEN POST 23002
3 客户联系 > 客户标签管理 > 管理企业标签 > 编辑企业客户标签

企业可通过此接口编辑客户标签/标签组的名称或次序值。

EXTERNALCONTACT_EDIT_CORP_TAG /cgi-bin/externalcontact/edit_corp_tag?access_token=ACCESS_TOKEN POST 23003
3 客户联系 > 客户标签管理 > 管理企业标签 > 删除企业客户标签

企业可通过此接口删除客户标签库中的标签,或删除整个标签组。

EXTERNALCONTACT_DEL_CORP_TAG /cgi-bin/externalcontact/del_corp_tag?access_token=ACCESS_TOKEN POST 23004
3 客户联系 > 客户标签管理 > 管理企业规则组下的客户标签 > 获取指定规则组下的企业客户标签

企业可通过此接口获取某个规则组内的企业客户标签详情

EXTERNALCONTACT_GET_STRATEGY_TAG_LIST /cgi-bin/externalcontact/get_strategy_tag_list?access_token=ACCESS_TOKEN POST 23005
3 客户联系 > 客户标签管理 > 管理企业规则组下的客户标签 > 为指定规则组创建企业客户标签

企业可通过此接口向规则组中添加新的标签组和标签, 每个企业的企业标签和规则组标签合计最多可配置3000个。注意, 仅可在一级规则组下添加标签。

EXTERNALCONTACT_ADD_STRATEGY_TAG /cgi-bin/externalcontact/add_strategy_tag?access_token=ACCESS_TOKEN POST 23006
3 客户联系 > 客户标签管理 > 管理企业规则组下的客户标签 > 编辑指定规则组下的企业客户标签

企业可通过此接口编辑指定规则组下的客户标签/标签组的名称或次序值,但不可重新指定标签/标签组所属规则组。

EXTERNALCONTACT_EDIT_STRATEGY_TAG /cgi-bin/externalcontact/edit_strategy_tag?access_token=ACCESS_TOKEN POST 23007
3 客户联系 > 客户标签管理 > 管理企业规则组下的客户标签 > 删除指定规则组下的企业客户标签

企业可通过此接口删除某个规则组下的标签,或删除整个标签组。

EXTERNALCONTACT_DEL_STRATEGY_TAG /cgi-bin/externalcontact/del_strategy_tag?access_token=ACCESS_TOKEN POST 23008
3 客户联系 > 客户标签管理 > 编辑客户企业标签

企业可通过此接口为指定成员的客户添加上由企业统一配置的标签

EXTERNALCONTACT_MARK_TAG /cgi-bin/externalcontact/mark_tag?access_token=ACCESS_TOKEN POST 23009
3 客户联系 > 在职继承 > 分配在职成员的客户

企业可通过此接口,转接在职成员的客户给其他成员。

EXTERNALCONTACT_TRANSFER_CUSTOMER /cgi-bin/externalcontact/transfer_customer?access_token=ACCESS_TOKEN POST 24001
3 客户联系 > 在职继承 > 查询客户接替状态

企业和第三方可通过此接口查询在职成员的客户转接情况。

EXTERNALCONTACT_TRANSFER_RESULT /cgi-bin/externalcontact/transfer_result?access_token=ACCESS_TOKEN POST 24002
3 客户联系 > 离职继承 > 获取待分配的离职成员列表

企业和第三方可通过此接口,获取所有离职成员的客户列表,并可进一步调用分配离职成员的客户接口将这些客户重新分配给其他企业成员。

EXTERNALCONTACT_GET_UNASSIGNED_LIST /cgi-bin/externalcontact/get_unassigned_list?access_token=ACCESS_TOKEN POST 25001
3 客户联系 > 离职继承 > 分配离职成员的客户

企业可通过此接口,分配离职成员的客户给其他成员

EXTERNALCONTACT_RESIGNED_TRANSFER_CUSTOMER /cgi-bin/externalcontact/resigned/transfer_customer?access_token=ACCESS_TOKEN POST 25002
3 客户联系 > 离职继承 > 查询客户接替状态

企业和第三方可通过此接口查询离职成员的客户分配情况

EXTERNALCONTACT_RESIGNED_TRANSFER_RESULT /cgi-bin/externalcontact/resigned/transfer_result?access_token=ACCESS_TOKEN POST 25003
3 客户联系 > 离职继承 > 分配离职成员的客户群

企业可通过此接口,将已离职成员为群主的群,分配给另一个客服成员。

EXTERNALCONTACT_GROUPCHAT_TRANSFER /cgi-bin/externalcontact/groupchat/transfer?access_token=ACCESS_TOKEN POST 25004
3 客户联系 > 客户群管理 > 获取客户群列表

该接口用于获取配置过客户群管理的客户群列表。

EXTERNALCONTACT_GROUPCHAT_LIST /cgi-bin/externalcontact/groupchat/list?access_token=ACCESS_TOKEN POST 26001
3 客户联系 > 客户群管理 > 获取客户群详情

通过客户群ID,获取详情。包括群名、群成员列表、群成员入群时间、入群方式。(客户群是由具有客户群使用权限的成员创建的外部群)

需注意的是,如果发生群信息变动,会立即收到群变更事件,但是部分信息是异步处理,可能需要等一段时间调此接口才能得到最新结果

EXTERNALCONTACT_GROUPCHAT_GET /cgi-bin/externalcontact/groupchat/get?access_token=ACCESS_TOKEN POST 26002
3 客户联系 > 客户群管理 > 客户群opengid转换

用户在微信里的客户群里打开小程序时,某些场景下可以获取到群的opengid,如果该群是企业微信的客户群,则企业或第三方可以调用此接口将一个opengid转换为客户群chat_id

EXTERNALCONTACT_GROUPCHAT_OPENGID_TO_CHATID /cgi-bin/externalcontact/groupchat/opengid_to_chatid?access_token=ACCESS_TOKEN POST 26003
3 客户联系 > 联系我与客户入群方式 > 客户联系「联系我」管理 > 配置客户联系「联系我」方式

企业可以在管理后台-客户联系-加客户中配置成员的「联系我」的二维码或者小程序按钮,客户通过扫描二维码或点击小程序上的按钮,即可获取成员联系方式,主动联系到成员。

企业可通过此接口为具有客户联系功能的成员生成专属的「联系我」二维码或者「联系我」按钮。

如果配置的是「联系我」按钮,需要开发者的小程序接入小程序插件。

注意:

通过API添加的「联系我」不会在管理端进行展示,每个企业可通过API最多配置50万个「联系我」。

用户需要妥善存储返回的config_id,config_id丢失可能导致用户无法编辑或删除「联系我」。

临时会话模式不占用「联系我」数量,但每日最多添加 10万个,并且仅支持单人。

临时会话模式的二维码,添加好友完成后该二维码即刻失效。

EXTERNALCONTACT_ADD_CONTACT_WAY /cgi-bin/externalcontact/add_contact_way?access_token=ACCESS_TOKEN POST 27001
3 客户联系 > 联系我与客户入群方式 > 客户联系「联系我」管理 > 获取企业已配置的「联系我」方式

获取企业配置的「联系我」二维码和「联系我」小程序按钮。

EXTERNALCONTACT_GET_CONTACT_WAY /cgi-bin/externalcontact/get_contact_way?access_token=ACCESS_TOKEN POST 27002
3 客户联系 > 联系我与客户入群方式 > 客户联系「联系我」管理 > 获取企业已配置的「联系我」列表

获取企业配置的「联系我」二维码和「联系我」小程序插件列表。不包含临时会话。

注意, 该接口仅可获取2021年7月10日以后创建的「联系我」

EXTERNALCONTACT_LIST_CONTACT_WAY /cgi-bin/externalcontact/list_contact_way?access_token=ACCESS_TOKEN POST 27003
3 客户联系 > 联系我与客户入群方式 > 客户联系「联系我」管理 > 更新企业已配置的「联系我」方式

更新企业配置的「联系我」二维码和「联系我」小程序按钮中的信息,如使用人员和备注等。

EXTERNALCONTACT_UPDATE_CONTACT_WAY /cgi-bin/externalcontact/update_contact_way?access_token=ACCESS_TOKEN POST 27004
3 客户联系 > 联系我与客户入群方式 > 客户联系「联系我」管理 > 删除企业已配置的「联系我」方式

删除一个已配置的「联系我」二维码或者「联系我」小程序按钮。

EXTERNALCONTACT_DEL_CONTACT_WAY /cgi-bin/externalcontact/del_contact_way?access_token=ACCESS_TOKEN POST 27005
3 客户联系 > 联系我与客户入群方式 > 客户联系「联系我」管理 > 结束临时会话

将指定的企业成员和客户之前的临时会话断开,断开前会自动下发已配置的结束语。

EXTERNALCONTACT_CLOSE_TEMP_CHAT /cgi-bin/externalcontact/close_temp_chat?access_token=ACCESS_TOKEN POST 27006
3 客户联系 > 联系我与客户入群方式 > 户群「加入群聊」管理 > 配置客户群进群方式

企业可以在管理后台-客户联系中配置「加入群聊」的二维码或者小程序按钮,客户通过扫描二维码或点击小程序上的按钮,即可加入特定的客户群

企业可以在管理后台-企业可通过此接口为具有客户联系功能的成员生成专属的二维码或者小程序按钮。

企业可以在管理后台-如果配置的是小程序按钮,需要开发者的小程序接入小程序插件。

注意:

通过API添加的配置不会在管理端进行展示,每个企业可通过API最多配置50万个「加入群聊」(与「联系我」共用50万的额度)。

EXTERNALCONTACT_GROUPCHAT_ADD_JOIN_WAY /cgi-bin/externalcontact/groupchat/add_join_way?access_token=ACCESS_TOKEN POST 27010
3 客户联系 > 联系我与客户入群方式 > 户群「加入群聊」管理 > 获取客户群进群方式配置

获取企业配置的群二维码或小程序按钮。

EXTERNALCONTACT_GROUPCHAT_GET_JOIN_WAY /cgi-bin/externalcontact/groupchat/get_join_way?access_token=ACCESS_TOKEN POST 27011
3 客户联系 > 联系我与客户入群方式 > 户群「加入群聊」管理 > 更新客户群进群方式配置

更新进群方式配置信息。注意:使用覆盖的方式更新。

EXTERNALCONTACT_GROUPCHAT_UPDATE_JOIN_WAY /cgi-bin/externalcontact/groupchat/update_join_way?access_token=ACCESS_TOKEN POST 27012
3 客户联系 > 联系我与客户入群方式 > 户群「加入群聊」管理 > 删除客户群进群方式配置

删除一个进群方式配置。

EXTERNALCONTACT_GROUPCHAT_DEL_JOIN_WAY /cgi-bin/externalcontact/groupchat/del_join_way?access_token=ACCESS_TOKEN POST 27012
3 客户联系 > 客户朋友圈 > 企业发表内容到客户的朋友圈 > 创建发表任务

企业和第三方应用可通过该接口创建客户朋友圈的发表任务。

EXTERNALCONTACT_ADD_MOMENT_TASK /cgi-bin/externalcontact/add_moment_task?access_token=ACCESS_TOKEN POST 27001
3 客户联系 > 客户朋友圈 > 企业发表内容到客户的朋友圈 > 获取任务创建结果

由于发表任务的创建是异步执行的,应用需要再调用该接口以获取创建的结果。

EXTERNALCONTACT_GET_MOMENT_TASK_RESULT /cgi-bin/externalcontact/get_moment_task_result?access_token=ACCESS_TOKEN GET 27002
3 客户联系 > 客户朋友圈 > 获取客户朋友圈全部的发表记录 > 获取企业全部的发表列表

企业和第三方应用可通过该接口获取企业全部的发表内容。

EXTERNALCONTACT_GET_MOMENT_LIST /cgi-bin/externalcontact/get_moment_list?access_token=ACCESS_TOKEN POST 27003
3 客户联系 > 客户朋友圈 > 获取客户朋友圈全部的发表记录 > 获取客户朋友圈企业发表的列表

企业和第三方应用可通过该接口获取企业发表的朋友圈成员执行情况

EXTERNALCONTACT_GET_MOMENT_TASK /cgi-bin/externalcontact/get_moment_task?access_token=ACCESS_TOKEN POST 27004
3 客户联系 > 客户朋友圈 > 获取客户朋友圈全部的发表记录 > 获取客户朋友圈发表时选择的可见范围

企业和第三方应用可通过该接口获取客户朋友圈创建时,选择的客户可见范围

EXTERNALCONTACT_GET_MOMENT_CUSTOMER_LIST /cgi-bin/externalcontact/get_moment_customer_list?access_token=ACCESS_TOKEN POST 27005
3 客户联系 > 客户朋友圈 > 获取客户朋友圈全部的发表记录 > 获取客户朋友圈发表后的可见客户列表

企业和第三方应用可通过该接口获取客户朋友圈发表后,可在微信朋友圈中查看的客户列表

EXTERNALCONTACT_GET_MOMENT_SEND_RESULT /cgi-bin/externalcontact/get_moment_send_result?access_token=ACCESS_TOKEN POST 27006
3 客户联系 > 客户朋友圈 > 获取客户朋友圈全部的发表记录 > 获取客户朋友圈的互动数据

企业和第三方应用可通过此接口获取客户朋友圈的互动数据。

EXTERNALCONTACT_GET_MOMENT_COMMENTS /cgi-bin/externalcontact/get_moment_comments?access_token=ACCESS_TOKEN POST 27007
3 客户联系 > 客户朋友圈 > 客户朋友圈规则组管理 > 获取规则组列表

企业可通过此接口获取企业配置的所有客户朋友圈规则组id列表。

EXTERNALCONTACT_MOMENT_STRATEGY_LIST /cgi-bin/externalcontact/moment_strategy/list?access_token=ACCESS_TOKEN POST 27008
3 客户联系 > 客户朋友圈 > 客户朋友圈规则组管理 > 获取规则组详情

企业可以通过此接口获取某个客户朋友圈规则组的详细信息。

EXTERNALCONTACT_MOMENT_STRATEGY_GET /cgi-bin/externalcontact/moment_strategy/get?access_token=ACCESS_TOKEN POST 27009
3 客户联系 > 客户朋友圈 > 客户朋友圈规则组管理 > 获取规则组管理范围

企业可通过此接口获取某个朋友圈规则组管理的成员和部门列表

EXTERNALCONTACT_MOMENT_STRATEGY_GET_RANGE /cgi-bin/externalcontact/moment_strategy/get_range?access_token=ACCESS_TOKEN POST 27010
3 客户联系 > 客户朋友圈 > 客户朋友圈规则组管理 > 创建新的规则组

企业可通过此接口创建一个新的客户朋友圈规则组。该接口仅支持串行调用,请勿并发创建规则组。

EXTERNALCONTACT_MOMENT_STRATEGY_CREATE /cgi-bin/externalcontact/moment_strategy/create?access_token=ACCESS_TOKEN POST 27011
3 客户联系 > 客户朋友圈 > 客户朋友圈规则组管理 > 编辑规则组及其管理范围

企业可通过此接口编辑规则组的基本信息和修改客户朋友圈规则组管理范围。该接口仅支持串行调用,请勿并发修改规则组。

EXTERNALCONTACT_MOMENT_STRATEGY_EDIT /cgi-bin/externalcontact/moment_strategy/edit?access_token=ACCESS_TOKEN POST 27012
3 客户联系 > 客户朋友圈 > 客户朋友圈规则组管理 > 删除规则组

企业可通过此接口删除某个客户朋友圈规则组。

EXTERNALCONTACT_MOMENT_STRATEGY_DEL /cgi-bin/externalcontact/moment_strategy/del?access_token=ACCESS_TOKEN POST 27013
3 客户联系 > 消息推送 > 创建企业群发

企业跟第三方应用可通过此接口添加企业群发消息的任务并通知成员发送给相关客户或客户群。(注:企业微信终端需升级到2.7.5版本及以上

注意:调用该接口并不会直接发送消息给客户/客户群,需要成员确认后才会执行发送(客服人员的企业微信需要升级到2.7.5及以上版本

旧接口创建企业群发已经废弃,接口升级后支持发送视频文件,并且支持最多同时发送9个附件。

仅会推送给最后跟客户进行聊天互动的企业成员。

每位客户/每个客户群每天可接收1条群发消息,可以是企业统一创建发送的,也可以是成员自己创建发送的;超过接收上限的客户/客户群将无法再收到群发消息。

EXTERNALCONTACT_ADD_MSG_TEMPLATE /cgi-bin/externalcontact/add_msg_template?access_token=ACCESS_TOKEN POST 28001
3 客户联系 > 消息推送 > 获取企业的全部群发记录 > 获取群发记录列表

企业和第三方应用可通过此接口获取企业与成员的群发记录。

EXTERNALCONTACT_GET_GROUPMSG_LIST_V2 /cgi-bin/externalcontact/get_groupmsg_list_v2?access_token=ACCESS_TOKEN POST 28002
3 客户联系 > 消息推送 > 获取企业的全部群发记录 > 获取群发成员发送任务列表

EXTERNALCONTACT_GET_GROUPMSG_TASK /cgi-bin/externalcontact/get_groupmsg_task?access_token=ACCESS_TOKEN POST 28003
3 客户联系 > 消息推送 > 获取企业的全部群发记录 > 获取企业群发成员执行结果

EXTERNALCONTACT_GET_GROUPMSG_SEND_RESULT /cgi-bin/externalcontact/get_groupmsg_send_result?access_token=ACCESS_TOKEN POST 28004
3 客户联系 > 消息推送 > 发送新客户欢迎语

  1. 企业微信在向企业推送添加外部联系人事件时,会额外返回一个welcome_code,企业以此为凭据调用接口,即可通过成员向新添加的客户发送个性化的欢迎语。
  2. 为了保证用户体验以及避免滥用,企业仅可在收到相关事件后20秒内调用,且只可调用一次。

    如果企业已经在管理端为相关成员配置了可用的欢迎语,则推送添加外部联系人事件时不会返回welcome_code。
  3. 每次添加新客户时 可能有多个企业自建应用/第三方应用收到带有welcome_code的回调事件,但仅有最先调用的可以发送成功。后续调用将返回 41051(externaluser has started chatting)错误,请用户根据实际使用需求,合理设置应用可见范围,避免冲突
  4. 旧接口发送新客户欢迎语已经废弃,接口升级后支持发送视频文件,并且最多支持同时发送9个附件

EXTERNALCONTACT_SEND_WELCOME_MSG /cgi-bin/externalcontact/send_welcome_msg?access_token=ACCESS_TOKEN POST 28005
3 客户联系 > 消息推送 > 入群欢迎语素材管理 > 添加入群欢迎语素材

企业可通过此API向企业的入群欢迎语素材库中添加素材。每个企业的入群欢迎语素材库中,最多容纳100个素材。

EXTERNALCONTACT_GROUP_WELCOME_TEMPLATE_ADD /cgi-bin/externalcontact/group_welcome_template/add?access_token=ACCESS_TOKEN POST 28006
3 客户联系 > 消息推送 > 入群欢迎语素材管理 > 编辑入群欢迎语素材

企业可通过此API编辑入群欢迎语素材库中的素材,且仅能够编辑调用方自己创建的入群欢迎语素材

EXTERNALCONTACT_GROUP_WELCOME_TEMPLATE_EDIT /cgi-bin/externalcontact/group_welcome_template/edit?access_token=ACCESS_TOKEN POST 28007
3 客户联系 > 消息推送 > 入群欢迎语素材管理 > 获取入群欢迎语素材

企业可通过此API获取入群欢迎语素材。

EXTERNALCONTACT_GROUP_WELCOME_TEMPLATE_GET /cgi-bin/externalcontact/group_welcome_template/get?access_token=ACCESS_TOKEN POST 28008
3 客户联系 > 消息推送 > 入群欢迎语素材管理 > 删除入群欢迎语素材

企业可通过此API删除入群欢迎语素材,且仅能删除调用方自己创建的入群欢迎语素材。

EXTERNALCONTACT_GROUP_WELCOME_TEMPLATE_DEL /cgi-bin/externalcontact/group_welcome_template/del?access_token=ACCESS_TOKEN POST 28009
3 客户联系 > 统计管理 > 获取「联系客户统计」数据

企业可通过此接口获取成员联系客户的数据,包括发起申请数、新增客户数、聊天数、发送消息数和删除/拉黑成员的客户数等指标。

EXTERNALCONTACT_GET_USER_BEHAVIOR_DATA /cgi-bin/externalcontact/get_user_behavior_data?access_token=ACCESS_TOKEN POST 28010
3 客户联系 > 统计管理 > 获取「群聊数据统计」数据 > 按群主聚合的方式

按群主聚合的方式获取指定日期的统计数据。注意,企业微信仅存储180天的数据。

EXTERNALCONTACT_GROUPCHAT_STATISTIC /cgi-bin/externalcontact/groupchat/statistic?access_token=ACCESS_TOKEN POST 28011
3 客户联系 > 统计管理 > 获取「群聊数据统计」数据 > 按自然日聚合的方式

按自然日聚合的方式获取指定日期的统计数据。注意,企业微信仅存储180天的数据。

EXTERNALCONTACT_GROUPCHAT_STATISTIC_GROUP_BY_DAY /cgi-bin/externalcontact/groupchat/statistic_group_by_day?access_token=ACCESS_TOKEN POST 28012
3 客户联系 > 管理商品图册 > 创建商品图册

企业和第三方应用可以通过此接口增加商品

EXTERNALCONTACT_ADD_PRODUCT_ALBUM /cgi-bin/externalcontact/add_product_album?access_token=ACCESS_TOKEN POST 29001
3 客户联系 > 管理商品图册 > 获取商品图册

企业和第三方应用可以通过此接口获取商品信息

EXTERNALCONTACT_GET_PRODUCT_ALBUM /cgi-bin/externalcontact/get_product_album?access_token=ACCESS_TOKEN POST 29002
3 客户联系 > 管理商品图册 > 获取商品图册列表

企业和第三方应用可以通过此接口导出商品

EXTERNALCONTACT_GET_PRODUCT_ALBUM_LIST /cgi-bin/externalcontact/get_product_album_list?access_token=ACCESS_TOKEN POST 29003
3 客户联系 > 管理商品图册 > 编辑商品图册

企业和第三方应用可以通过此接口修改商品信息

EXTERNALCONTACT_UPDATE_PRODUCT_ALBUM /cgi-bin/externalcontact/update_product_album?access_token=ACCESS_TOKEN POST 29004
3 客户联系 > 管理商品图册 > 删除商品图册

企业和第三方应用可以通过此接口删除商品信息

EXTERNALCONTACT_DELETE_PRODUCT_ALBUM /cgi-bin/externalcontact/delete_product_album?access_token=ACCESS_TOKEN POST 29005
3 客户联系 > 管理聊天敏感词 > 新建敏感词规则

企业和第三方应用可以通过此接口新建敏感词规则

EXTERNALCONTACT_ADD_INTERCEPT_RULE /cgi-bin/externalcontact/add_intercept_rule?access_token=ACCESS_TOKEN POST 21001
3 客户联系 > 管理聊天敏感词 > 获取敏感词规则列表

企业和第三方应用可以通过此接口获取敏感词规则列表

EXTERNALCONTACT_GET_INTERCEPT_RULE_LIST /cgi-bin/externalcontact/get_intercept_rule_list?access_token=ACCESS_TOKEN GET 21002
3 客户联系 > 管理聊天敏感词 > 获取敏感词规则详情

企业和第三方应用可以通过此接口获取敏感词规则详情

EXTERNALCONTACT_GET_INTERCEPT_RULE /cgi-bin/externalcontact/get_intercept_rule?access_token=ACCESS_TOKEN POST 21003
3 客户联系 > 管理聊天敏感词 > 修改敏感词规则

企业和第三方应用可以通过此接口修改敏感词规则

EXTERNALCONTACT_UPDATE_INTERCEPT_RULE /cgi-bin/externalcontact/update_intercept_rule?access_token=ACCESS_TOKEN POST 21004
3 客户联系 > 管理聊天敏感词 > 删除敏感词规则

企业和第三方应用可以通过此接口修改敏感词规则

EXTERNALCONTACT_DEL_INTERCEPT_RULE /cgi-bin/externalcontact/del_intercept_rule?access_token=ACCESS_TOKEN POST 21005
3 客户联系 > 上传附件资源

素材上传得到media_id,该media_id仅三天内有效

media_id在同一企业内应用之间可以共享

EXTERNALCONTACT_DEL_INTERCEPT_RULE /cgi-bin/media/upload_attachment?access_token=ACCESS_TOKEN&media_type=TYPE&attachment_type=1 POST 21101
4 微信客服 > 客服账号管理 > 添加客服帐号

添加客服帐号,并可设置客服名称和头像。目前一家企业最多可添加 5000个客服帐号。

KF_ACCOUNT_ADD /cgi-bin/kf/account/add?access_token=ACCESS_TOKEN POST 31001
4 微信客服 > 客服账号管理 > 删除客服帐号

删除已有的客服帐号

KF_ACCOUNT_DEL /cgi-bin/kf/account/del?access_token=ACCESS_TOKEN POST 31002
4 微信客服 > 客服账号管理 > 修改客服帐号

修改已有的客服帐号,可修改客服名称和头像。

KF_ACCOUNT_UPDATE /cgi-bin/kf/account/update?access_token=ACCESS_TOKEN POST 31003
4 微信客服 > 客服账号管理 > 获取客服帐号列表

获取客服帐号列表,包括所有的客服帐号的客服ID、名称和头像。

KF_ACCOUNT_LIST /cgi-bin/kf/account/list?access_token=ACCESS_TOKEN GET 31004
4 微信客服 > 客服账号管理 > 获取客服帐号链接

企业可通过此接口获取带有不同参数的客服链接,不同客服帐号对应不同的客服链接。获取后,企业可将链接嵌入到网页等场景中,微信用户点击链接即可向对应的客服帐号发起咨询。企业可依据参数来识别用户的咨询来源等。

KF_ADD_CONTACT_WAY /cgi-bin/kf/add_contact_way?access_token=ACCESS_TOKEN POST 31005
4 微信客服 > 接待人员管理 > 添加接待人员

添加指定客服帐号的接待人员,每个客服帐号目前最多可添加 2000个接待人员, 20个部门。

KF_SERVICER_ADD /cgi-bin/kf/servicer/add?access_token=ACCESS_TOKEN POST 32001
4 微信客服 > 接待人员管理 > 删除接待人员

从客服帐号删除接待人员

KF_SERVICER_DEL /cgi-bin/kf/servicer/del?access_token=ACCESS_TOKEN POST 32002
4 微信客服 > 接待人员管理 > 获取接待人员列表

获取某个客服帐号的接待人员列表

KF_SERVICER_LIST /cgi-bin/kf/servicer/list?access_token=ACCESS_TOKEN GET 32003
4 微信客服 > 会话分配与消息收发 > 分配客服会话 > 获取会话状态

KF_SERVICE_STATE_GET /cgi-bin/kf/service_state/get?access_token=ACCESS_TOKEN POST 33001
4 微信客服 > 会话分配与消息收发 > 分配客服会话 > 变更会话状态

KF_SERVICE_STATE_TRANS /cgi-bin/kf/service_state/trans?access_token=ACCESS_TOKEN POST 33002
4 微信客服 > 会话分配与消息收发 > 接收消息和事件 > 读取消息

微信客户发送的消息、接待人员在企业微信回复的消息、发送消息接口发送失败事件(如被用户拒收)、客户点击菜单消息的回复消息,可以通过该接口获取具体的消息内容和事件。不支持读取通过发送消息接口发送的消息。

支持的消息类型:文本、图片、语音、视频、文件、位置、链接、名片、小程序、菜单、事件。

KF_SYNC_MSG /cgi-bin/kf/sync_msg?access_token=ACCESS_TOKEN POST 33003
4 微信客服 > 会话分配与消息收发 > 发送消息

当微信客户处于“新接入待处理”或“由智能助手接待”状态下,可调用该接口给用户发送消息。

注意仅当微信客户在主动发送消息给客服后的48小时内,企业可发送消息给客户,最多可发送5条消息;若用户继续发送消息,企业可再次下发消息。

支持发送消息类型:文本、图片、语音、视频、文件、图文、小程序、菜单消息、地理位置。

目前该接口允许下发消息条数和下发时限如下:

用户动作 允许下发条数限制 下发时限
用户发送消息 5条 48 小时

KF_SEND_MSG /cgi-bin/kf/send_msg?access_token=ACCESS_TOKEN POST 33004
4 微信客服 > 会话分配与消息收发 > 送欢迎语等事件响应消息

当特定的事件回调消息包含code字段,或通过接口变更到特定的会话状态,会返回code字段

开发者可以此code为凭证,调用该接口给用户发送相应事件场景下的消息,如客服欢迎语、客服提示语和会话结束语等。

除"用户进入会话事件"以外,响应消息仅支持会话处于获取该code的会话状态时发送,如将会话转入待接入池时获得的code仅能在会话状态为”待接入池排队中“时发送。

目前支持的事件场景和相关约束如下:

事件场景 允许下发条数 code有效期 支持的消息类型 获取code途径
用户进入会话,用于发送客服欢迎语 1条 20秒 文本、菜单 事件回调
进入接待池,用于发送排队提示语等 1条 48小时 文本 转接会话接口
从接待池接入会话,用于发送非工作时间的提示语或超时未回复的提示语等 1条 48小时 文本 事件回调、转接会话接口
结束会话,用于发送结束会话提示语或满意度评价等 1条 20秒 文本、菜单 事件回调、转接会话接口

KF_SEND_MSG_ON_EVENT /cgi-bin/kf/send_msg_on_event?access_token=ACCESS_TOKEN POST 33005
4 微信客服 > 「升级服务」配置 > 获取配置的专员与客户群

企业需要在管理后台或移动端中的「微信客服」-「升级服务」中,配置专员和客户群。该接口提供获取配置的专员与客户群列表的能力。

KF_CUSTOMER_GET_UPGRADE_SERVICE_CONFIG /cgi-bin/kf/customer/get_upgrade_service_config?access_token=ACCESS_TOKEN GET 34001
4 微信客服 > 「升级服务」配置 > 为客户升级为专员或客户群服务

企业可通过其他接口获知客户的 external_userid 以及客户与接待人员的聊天内容,因此可以结合实际业务场景,为客户推荐指定的服务专员或客户群。

通过该 API 为客户指定专员或客户群后,接待人员可在企业微信中,见到特殊的状态提示(Windows 为 icon 样式变化,移动端为出现一条 bar ),便于接待人员知晓企业的指定动作。

KF_CUSTOMER_UPGRADE_SERVICE /cgi-bin/kf/customer/upgrade_service?access_token=ACCESS_TOKEN POST 34002
4 微信客服 > 「升级服务」配置 > 为客户取消推荐

当企业通过 API 为客户指定了专员或客户群后,如果客户已经完成服务升级,或是企业需要取消推荐,则可调用该接口清空之前为客户指定的专员或客户群。清空后,企业微信中的特殊状态提示也会同步消失。

KF_CUSTOMER_CANCEL_UPGRADE_SERVICE /cgi-bin/kf/customer/cancel_upgrade_service?access_token=ACCESS_TOKEN POST 34003
4 微信客服 > 其他基础信息获取 > 获取客户基础信息

KF_CUSTOMER_BATCHGET /cgi-bin/kf/customer/batchget?access_token=ACCESS_TOKEN POST 35001
4 微信客服 > 统计管理 > 获取「客户数据统计」企业汇总数据

通过此接口,可以获取咨询会话数、咨询客户数等企业汇总统计数据

KF_GET_CORP_STATISTIC /cgi-bin/kf/get_corp_statistic?access_token=ACCESS_TOKEN POST 36001
4 微信客服 > 统计管理 > 获取「客户数据统计」接待人员明细数据

通过此接口,可获取接入人工会话数、咨询会话数等与接待人员相关的统计信息

KF_GET_SERVICER_STATISTIC /cgi-bin/kf/get_servicer_statistic?access_token=ACCESS_TOKEN POST 36002
5 身份验证 > 获取访问用户身份

该接口用于根据code获取成员信息

GET_USER_INFO_BY_CODE /cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN GET 41001
5 身份验证 > 获取访问用户敏感信息

自建应用与代开发应用可通过该接口获取成员授权的敏感字段

GET_USER_DETAIL_BY_USER_TICKET /cgi-bin/user/getuserdetail?access_token=ACCESS_TOKEN POST 41002
6 应用管理 > 获取应用 > 获取应用的jsapi_ticket

应用的jsapi_ticket用于计算agentConfig(参见“通过agentConfig注入应用的权限”)的签名,签名计算方法与上述介绍的config的签名算法完全相同,但需要注意以下区别:

  1. 签名的jsapi_ticket必须使用以下接口获取。且必须用wx.agentConfig中的agentid对应的应用去获取access_token。
  2. 签名用的noncestr和timestamp必须与wx.agentConfig中的nonceStr和timestamp相同。

正常情况下, 应用的jsapi_ticket的有效期为7200秒,通过access_token来获取。由于获取jsapi_ticket的api调用次数非常有限(一小时内,每个应用不能超过100次),频繁刷新jsapi_ticket会导致api调用受限,影响自身业务,开发者必须在自己的服务全局缓存应用的jsapi_ticket。

AGENT_GET_TICKET /cgi-bin/ticket/get?access_token=ACCESS_TOKEN&type=agent_config GET 51000
6 应用管理 > 获取应用 > 获取指定的应用详情

对于互联企业的应用,如果需要获取应用可见范围内其他互联企业的部门与成员,请调用互联企业-获取应用可见范围接口

AGENT_GET /cgi-bin/agent/get?access_token=ACCESS_TOKEN GET 51001
6 应用管理 > 获取应用 > 获取access_token对应的应用列表

AGENT_LIST /cgi-bin/agent/list?access_token=ACCESS_TOKEN GET 51002
6 应用管理 > 设置应用

AGENT_SET /cgi-bin/agent/set?access_token=ACCESS_TOKEN POST 51003
6 应用管理 > 自定义菜单 > 创建菜单

自定义菜单接口可实现多种类型按钮,如下:

字段值 功能名称 说明
click 点击推事件 成员点击click类型按钮后,企业微信服务器会通过消息接口推送消息类型为event 的结构给开发者(参考消息接口指南),并且带上按钮中开发者填写的key值,开发者可以通过自定义的key值与成员进行交互;
view 跳转URL 成员点击view类型按钮后,企业微信客户端将会打开开发者在按钮中填写的网页URL,可与网页授权获取成员基本信息接口结合,获得成员基本信息。
scancode_push 扫码推事件 成员点击按钮后,企业微信客户端将调起扫一扫工具,完成扫码操作后显示扫描结果(如果是URL,将进入URL),且会将扫码的结果传给开发者,开发者可用于下发消息。
scancode_waitmsg 扫码推事件 且弹出“消息接收中”提示框 成员点击按钮后,企业微信客户端将调起扫一扫工具,完成扫码操作后,将扫码的结果传给开发者,同时收起扫一扫工具,然后弹出“消息接收中”提示框,随后可能会收到开发者下发的消息。
pic_sysphoto 弹出系统拍照发图 弹出系统拍照发图 成员点击按钮后,企业微信客户端将调起系统相机,完成拍照操作后,会将拍摄的相片发送给开发者,并推送事件给开发者,同时收起系统相机,随后可能会收到开发者下发的消息。
pic_photo_or_album 弹出拍照或者相册发图 成员点击按钮后,企业微信客户端将弹出选择器供成员选择“拍照”或者“从手机相册选择”。成员选择后即走其他两种流程。
pic_weixin 弹出企业微信相册发图器 成员点击按钮后,企业微信客户端将调起企业微信相册,完成选择操作后,将选择的相片发送给开发者的服务器,并推送事件给开发者,同时收起相册,随后可能会收到开发者下发的消息。
location_select 弹出地理位置选择器 成员点击按钮后,企业微信客户端将调起地理位置选择工具,完成选择操作后,将选择的地理位置发送给开发者的服务器,同时收起位置选择工具,随后可能会收到开发者下发的消息。
view_miniprogram 跳转到小程序 成员点击按钮后,企业微信客户端将会打开开发者在按钮中配置的小程序

MENU_CREATE /cgi-bin/menu/create?access_token=ACCESS_TOKEN POST 51004
6 应用管理 > 自定义菜单 > 获取菜单

MENU_GET /cgi-bin/menu/get?access_token=ACCESS_TOKEN GET 51005
6 应用管理 > 自定义菜单 > 删除菜单

MENU_DELETE /cgi-bin/menu/delete?access_token=ACCESS_TOKEN GET 51006
6 应用管理 > 设置工作台自定义展示 > 设置应用在工作台展示的模版

请求说明:该接口指定应用自定义模版类型。同时也支持设置企业默认模版数据。若type指定为 "normal" 则为取消自定义模式,改为普通展示模式

AGENT_SET_WORKBENCH_TEMPLATE /cgi-bin/agent/set_workbench_template?access_token=ACCESS_TOKEN POST 51007
6 应用管理 > 设置工作台自定义展示 > 获取应用在工作台展示的模版

AGENT_GET_WORKBENCH_TEMPLATE /cgi-bin/agent/get_workbench_template?access_token=ACCESS_TOKEN POST 51008
6 应用管理 > 设置工作台自定义展示 > 设置应用在用户工作台展示的数据

AGENT_SET_WORKBENCH_DATA /cgi-bin/agent/set_workbench_data?access_token=ACCESS_TOKEN POST 51009
7 消息推送 > 发送应用消息

应用支持推送文本、图片、视频、文件、图文等类型。

MESSAGE_SEND /cgi-bin/message/send?access_token=ACCESS_TOKEN POST 61001
7 消息推送 > 更新模版卡片消息

应用可以发送模板卡片消息,发送之后可再通过接口更新可回调的用户任务卡片消息的替换文案信息(仅原卡片为 按钮交互型、投票选择型、多项选择型的卡片以及填写了action_menu字段的文本通知型、图文展示型可以调用本接口更新)。

请注意,当应用调用发送模版卡片消息后,接口会返回一个response_code,通过response_code用户可以调用本接口一次。后续如果有用户点击任务卡片,回调接口也会带上response_code,开发者通过该code也可以调用本接口一次,注意response_code的有效期是24小时,超过24小时后将无法使用。

MESSAGE_UPDATE_TEMPLATE_CARD /cgi-bin/message/update_template_card?access_token=ACCESS_TOKEN POST 61002
7 消息推送 > 撤回应用消息

MESSAGE_RECALL /cgi-bin/message/recall?access_token=ACCESS_TOKEN POST 61003
7 消息推送 > 发送消息到群聊会话 > 创建群聊会话

APPCHAT_CREATE /cgi-bin/appchat/create?access_token=ACCESS_TOKEN POST 61004
7 消息推送 > 发送消息到群聊会话 > 修改群聊会话

APPCHAT_UPDATE /cgi-bin/appchat/update?access_token=ACCESS_TOKEN POST 61005
7 消息推送 > 发送消息到群聊会话 > 获取群聊会话

APPCHAT_GET /cgi-bin/appchat/get?access_token=ACCESS_TOKEN GET 61006
7 消息推送 > 发送消息到群聊会话 > 应用推送消息

应用支持推送文本、图片、视频、文件、图文等类型。

APP_CHAT_SEND /cgi-bin/appchat/send?access_token=ACCESS_TOKEN POST 61007
7 消息推送 > 互联企业消息推送 > 发送应用消息

互联企业是企业微信提供的满足集团与子公司、企业与上下游供应商进行连接的功能,企业可以共享通讯录以及应用给互联企业,如需要,你可以前往管理后台-通讯录创建互联企业,之后你可以在自建应用的可见范围设置互联企业的通讯录;此接口主要满足开发者给互联企业成员推送消息的诉求。

LINKEDCORP_MESSAGE_SEND /cgi-bin/linkedcorp/message/send?access_token=ACCESS_TOKEN POST 61008
7 消息推送 > 家校消息推送 > 发送「学校通知」

学校可以通过此接口来给家长发送不同类型的学校通知,来满足多种场景下的学校通知需求。目前支持的消息类型为文本、图片、语音、视频、文件、图文。。

EXTERNALCONTACT_MESSAGE_SEND /cgi-bin/externalcontact/message/send?access_token=ACCESS_TOKEN POST 61009
8 素材管理 > 上传临时素材

素材上传得到media_id,该media_id仅三天内有效

media_id在同一企业内应用之间可以共享

MEDIA_UPLOAD /cgi-bin/media/upload?access_token=ACCESS_TOKEN POST 71001
8 素材管理 > 上传图片

上传图片得到图片URL,该URL永久有效

返回的图片URL,仅能用于图文消息正文中的图片展示,或者给客户发送欢迎语等;若用于非企业微信环境下的页面,图片将被屏蔽。

每个企业每月最多可上传3000张图片,每天最多可上传1000张图片

MEDIA_UPLOADIMG /cgi-bin/media/uploadimg?access_token=ACCESS_TOKEN POST 71002
8 素材管理 > 获取临时素材

MEDIA_GET /cgi-bin/media/get?access_token=ACCESS_TOKEN POST 71003
8 素材管理 > 获取高清语音素材

可以使用本接口获取从JSSDK的uploadVoice接口上传的临时语音素材,格式为speex,16K采样率。该音频比上文的临时素材获取接口(格式为amr,8K采样率)更加清晰,适合用作语音识别等对音质要求较高的业务。

MEDIA_GET_JSSDK /cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN GET 71004
9 OA > 打卡 > 获取企业所有打卡规则

企业可通过打卡应用Secret调用本接口,获取企业内所有打卡规则数据。

GET_CORP_CHECKIN_OPTION /cgi-bin/checkin/getcorpcheckinoption?access_token=ACCESS_TOKEN POST 81001
9 OA > 打卡 > 获取员工打卡规则

企业可通过打卡应用Secret获取的token,获取指定员工指定日期的打卡规则

第三方应用可获取应用可见范围内指定员工指定日期的打卡规则

GET_CHECKIN_OPTION /cgi-bin/checkin/getcheckinoption?access_token=ACCESS_TOKEN POST 81002
9 OA > 打卡 > 获取打卡记录数据

企业可通过打卡应用Secret调用本接口,获取指定员工指定时间段内的打卡记录数据。

第三方应用可获取应用可见范围内指定员工指定日期的打卡记录数据。

GET_CHECKIN_DATA /cgi-bin/checkin/getcheckindata?access_token=ACCESS_TOKEN POST 81003
9 OA > 打卡 > 获取打卡日报数据

企业可通过打卡应用Secret调用本接口,获取指定员工指定时间段内的打卡日报统计数据。

第三方应用可获取应用可见范围内指定员工指定日期内的打卡日报统计数据。

GET_CHECKIN_DAY_DATA /cgi-bin/checkin/getcheckin_daydata?access_token=ACCESS_TOKEN POST 81004
9 OA > 打卡 > 获取打卡月报数据

企业可通过打卡应用Secret调用本接口,获取指定员工指定时间段内的打卡月报统计数据

第三方应用可获取应用可见范围内指定员工指定日期内的打卡月报统计数据。

GET_CHECKIN_MONTH_DATA /cgi-bin/checkin/getcheckin_monthdata?access_token=ACCESS_TOKEN POST 81005
9 OA > 打卡 > 获取打卡人员排班信息

企业可通过打卡应用Secret调用本接口,获取打卡规则为“按班次上下班”规则的指定员工指定时间段内的排班信息。

第三方应用获取应用可见范围内、打卡规则为“按班次上下班”规则的指定员工指定时间段内的排班信息。

GET_CHECKIN_SCHEDU_LIST /cgi-bin/checkin/getcheckinschedulist?access_token=ACCESS_TOKEN POST 81006
9 OA > 打卡 > 为打卡人员排班

企业可通过打卡应用Secret调用本接口,为打卡规则为“按班次上下班”规则的指定员工排班。

第三方应用可通过本接口为应用可见范围内、打卡规则为“按班次上下班”规则的指定员工排班。

SET_CHECKIN_SCHEDU_LIST /cgi-bin/checkin/setcheckinschedulist?access_token=ACCESS_TOKEN POST 81007
9 OA > 打卡 > 录入打卡人员人脸信息

企业可通过打卡应用Secret调用本接口,为企业打卡人员录入人脸信息,人脸信息仅用于人脸打卡

ADD_CHECKIN_USER_FACE /cgi-bin/checkin/addcheckinuserface?access_token=ACCESS_TOKEN POST 81008
9 OA > 打卡 > 获取设备打卡数据

可通过此接口,获取考勤设备上产生的所有原始打卡记录,包括未被打卡应用记录的不符合打卡规则的记录。

第三方应用可获取应用可见范围内员工在考勤设备上产生的所有原始打卡记录,包括未被打卡应用记录的不符合打卡规则的记录。

GET_HARDWARE_CHECKIN_DATA /cgi-bin/hardware/get_hardware_checkin_data?access_token=ACCESS_TOKEN POST 7008
9 OA > 审批 > 获取审批模板详情

企业可通过审批应用或自建应用Secret调用本接口,获取企业微信“审批应用”内指定审批模板的详情。

APPROVAL_GET_TEMPLATE_DETAIL /cgi-bin/oa/gettemplatedetail?access_token=ACCESS_TOKEN POST 82001
9 OA > 审批 > 提交审批申请

企业可通过审批应用或自建应用Secret调用本接口,代应用可见范围内员工在企业微信“审批应用”内提交指定类型的审批申请。

APPROVAL_SUBMIT /cgi-bin/oa/applyevent?access_token=ACCESS_TOKEN POST 82002
9 OA > 审批 > 批量获取审批单号

审批应用及有权限的自建应用,可通过Secret调用本接口,以获取企业一段时间内企业微信“审批应用”单据的审批编号,支持按模板类型、申请人、部门、申请单审批状态等条件筛选。

自建应用调用此接口,需在“管理后台-应用管理-审批-API-审批数据权限”中,授权应用允许提交审批单据。

一次拉取调用最多拉取100个审批记录,可以通过多次拉取的方式来满足需求,但调用频率不可超过600次/分。

推荐使用此接口获取审批数据,旧接口后续将不再维护。

GET_APPROVAL_INFO /cgi-bin/oa/getapprovalinfo?access_token=ACCESS_TOKEN POST 82003
9 OA > 审批 > 获取审批申请详情

企业可通过审批应用或自建应用Secret调用本接口,根据审批单号查询企业微信“审批应用”的审批申请详情。

GET_APPROVAL_DETAIL /cgi-bin/oa/getapprovaldetail?access_token=ACCESS_TOKEN POST 82004
9 OA > 审批 > 获取企业假期管理配置

企业可通过审批应用或自建应用Secret调用本接口,获取可见范围内员工的“假期管理”配置,包括:各个假期的id、名称、请假单位、时长计算方式、发放规则等。

第三方应用可获取应用可见范围内员工的“假期管理”配置,包括:各个假期的id、名称、请假单位、时长计算方式、发放规则等。

GET_CORP_VACATIONL_CONF /cgi-bin/oa/vacation/getcorpconf?access_token=ACCESS_TOKEN POST 82005
9 OA > 审批 > 获取成员假期余额

企业可通过审批应用或自建应用Secret调用本接口,获取可见范围内各个员工的假期余额数据。

第三方应用可获取应用可见范围内各个员工的假期余额数据。

GET_USER_VACATION_QUOTA /cgi-bin/oa/vacation/getuservacationquota?access_token=ACCESS_TOKEN POST 82006
9 OA > 审批 > 修改成员假期余额

企业可通过审批应用或自建应用Secret调用本接口,修改可见范围内员工的“假期余额”。

第三方应用可通过应本接口修改应用可见范围内指定员工的“假期余额”。

SET_USER_VACATION_QUOTA /cgi-bin/oa/vacation/setoneuserquota?access_token=ACCESS_TOKEN POST 82007
9 OA > 汇报 > 批量获取汇报记录单号

企业可通过access_token调用本接口,以获取企业一段时间内企业微信“汇报应用”汇报记录编号,支持按汇报表单ID、申请人、部门等条件筛选。

一次拉取调用最多拉取100个汇报记录,可以通过多次拉取的方式来满足需求,但调用频率不可超过600次/分。

表单ID的获取方式:

管理后台--汇报应用--某个汇报的内容设置页--点击“汇报名称”,即可获取

GET_JOURNAL_RECORD_LIST /cgi-bin/oa/journal/get_record_list?access_token=ACCESS_TOKEN POST 83001
9 OA > 审批 > 获取汇报记录详情

企业可通过access_token调用本接口,根据汇报记录单号查询企业微信“汇报应用”的汇报详情。

JOURNAL_GET_RECORD_DETAIL /cgi-bin/oa/journal/get_record_detail?access_token=ACCESS_TOKEN POST 83002
9 OA > 审批 > 获取汇报统计数据

企业可通过access_token调用本接口,根据汇报表单id查询企业微信“汇报应用”的汇报统计汇总信息。该接口只能拉取到已经汇总的统计数据,对于尚未完成汇总的周期不会返回。

JOURNAL_GET_STAT_LIST /cgi-bin/oa/journal/get_stat_list?access_token=ACCESS_TOKEN POST 83003
9 OA > 自建应用 > 审批流程引擎 > 查询自建应用审批单当前状态

开发者也可主动查询审批单的当前审批状态。

CORP_GET_OPEN_APPROVAL_DATA /cgi-bin/corp/getopenapprovaldata?access_token=ACCESS_TOKEN POST 84001
9 OA > 会议室 > 会议室管理 > 添加会议室

企业可通过此接口添加一个会议室。

MEETINGROOM_ADD /cgi-bin/oa/meetingroom/add?access_token=ACCESS_TOKEN POST 85001
9 OA > 会议室 > 会议室管理 > 查询会议室

企业可通过此接口查询满足条件的会议室。

MEETINGROOM_LIST /cgi-bin/oa/meetingroom/list?access_token=ACCESS_TOKEN POST 85002
9 OA > 会议室 > 会议室管理 > 编辑会议室

企业可通过此接口编辑相关会议室的基本信息。

MEETINGROOM_EDIT /cgi-bin/oa/meetingroom/edit?access_token=ACCESS_TOKEN POST 85003
9 OA > 会议室 > 会议室管理 > 删除会议室

企业可通过此接口删除指定的会议室。

MEETINGROOM_DEL /cgi-bin/oa/meetingroom/del?access_token=ACCESS_TOKEN POST 85004
9 OA > 会议室 > 会议室预定管理 > 查询会议室的预定信息

企业可通过此接口查询相关会议室在指定时间段的预定情况,如是否已被预定,预定者的userid等信息,不支持跨天查询。

MEETINGROOM_GET_BOOKING_INFO /cgi-bin/oa/meetingroom/get_booking_info?access_token=ACCESS_TOKEN POST 85005
9 OA > 会议室 > 会议室预定管理 > 预定会议室

企业可通过此接口预定会议室并自动关联日程。

MEETINGROOM_BOOK /cgi-bin/oa/meetingroom/book?access_token=ACCESS_TOKEN POST 85006
9 OA > 会议室 > 会议室预定管理 > 企业可通过此接口取消会议室的预定

MEETINGROOM_CANCEL_BOOK /cgi-bin/oa/meetingroom/cancel_book?access_token=ACCESS_TOKEN POST 85007
9 OA > 会议室 > 会议室预定管理 > 根据会议ID查询会议室的预定信息

企业可通过此接口按照会议ID查询相关会议室的预定情况

MEETINGROOM_GET_BOOKING_INFO_BY_MEETING_ID /cgi-bin/oa/meetingroom/get_booking_info_by_meeting_id?access_token=ACCESS_TOKEN POST 85008
9 OA > 紧急通知应用 > 发起语音电话

通过此接口发起语音电话,提醒员工查看应用推送的重要消息。

PSTNCC_CALL /cgi-bin/pstncc/call?access_token=ACCESS_TOKEN POST 86001
9 OA > 紧急通知应用 > 获取接听状态

通过此接口,了解员工是否已接听语音电话。

GET_PSTNCC_STATES /cgi-bin/pstncc/getstates?access_token=ACCESS_TOKEN POST 86002
10 效率工具 > 微盘 > 空间管理 > 新建空间

该接口用于在微盘内新建空间,可以指定人创建空间。

WEDRIVE_SPACE_CREATE /cgi-bin/wedrive/space_create?access_token=ACCESS_TOKEN POST 94001
10 效率工具 > 微盘 > 空间管理 > 重命名空间

该接口用于重命名已有空间,接收userid参数,以空间管理员身份来重命名。

WEDRIVE_SPACE_RENAME /cgi-bin/wedrive/space_rename?access_token=ACCESS_TOKEN POST 94002
10 效率工具 > 微盘 > 空间管理 > 解散空间

该接口用于解散已有空间,需要以空间管理员身份来解散。

WEDRIVE_SPACE_DISMISS /cgi-bin/wedrive/space_dismiss?access_token=ACCESS_TOKEN POST 94003
10 效率工具 > 微盘 > 空间管理 > 获取空间信息

该接口用于获取空间成员列表、信息、权限等信息。

WEDRIVE_SPACE_INFO /cgi-bin/wedrive/space_info?access_token=ACCESS_TOKEN POST 94004
10 效率工具 > 微盘 > 空间权限 > 添加成员/部门

该接口用于对指定空间添加成员/部门,可一次性添加多个。

WEDRIVE_SPACE_ACL_ADD /cgi-bin/wedrive/space_acl_add?access_token=ACCESS_TOKEN POST 94005
10 效率工具 > 微盘 > 空间权限 > 移除成员/部门

该接口用于对指定空间移除成员/部门,操作者需要有移除权限。

WEDRIVE_SPACE_ACL_DEL /cgi-bin/wedrive/space_acl_del?access_token=ACCESS_TOKEN POST 94006
10 效率工具 > 微盘 > 空间权限 > 权限管理

该接口用于修改空间权限,需要传入userid,修改权限范围继承传入用户的权限范围。

WEDRIVE_SPACE_SETTING /cgi-bin/wedrive/space_setting?access_token=ACCESS_TOKEN POST 94007
10 效率工具 > 微盘 > 空间权限 > 获取邀请链接

该接口用于获取空间邀请分享链接。

WEDRIVE_SPACE_SHARE /cgi-bin/wedrive/space_share?access_token=ACCESS_TOKEN POST 94008
10 效率工具 > 微盘 > 文件管理 > 获取文件列表

该接口用于获取指定地址下的文件列表。

WEDRIVE_FILE_LIST /cgi-bin/wedrive/file_list?access_token=ACCESS_TOKEN POST 94010
10 效率工具 > 微盘 > 文件管理 > 上传文件

该接口用于向微盘中的指定位置上传文件。

WEDRIVE_FILE_UPLOAD /cgi-bin/wedrive/file_upload?access_token=ACCESS_TOKEN POST 94011
10 效率工具 > 微盘 > 文件管理 > 下载文件

该接口用于下载文件,请求的userid需有下载权限

WEDRIVE_FILE_DOWNLOADD /cgi-bin/wedrive/file_download?access_token=ACCESS_TOKEN POST 94012
10 效率工具 > 微盘 > 文件管理 > 新建文件/微文档

该接口用于在微盘指定位置新建文件、微文档。

WEDRIVE_FILE_CREATE /cgi-bin/wedrive/file_create?access_token=ACCESS_TOKEN POST 94013
10 效率工具 > 微盘 > 文件管理 > 重命名文件

该接口用于对指定文件进行重命名。

WEDRIVE_FILE_RENAME /cgi-bin/wedrive/file_rename?access_token=ACCESS_TOKEN POST 94014
10 效率工具 > 微盘 > 文件管理 > 移动文件

该接口用于将文件移动到指定位置。

WEDRIVE_FILE_MOVE /cgi-bin/wedrive/file_move?access_token=ACCESS_TOKEN POST 94015
10 效率工具 > 微盘 > 文件管理 > 删除文件

该接口用于删除指定文件。

WEDRIVE_FILE_DELETE /cgi-bin/wedrive/file_delete?access_token=ACCESS_TOKEN POST 94016
10 效率工具 > 微盘 > 文件管理 > 文件信息

该接口用于获取指定文件的信息。

WEDRIVE_FILE_INFO /cgi-bin/wedrive/file_info?access_token=ACCESS_TOKEN POST 94017
10 效率工具 > 微盘 > 文件权限 > 新增指定人

该接口用于对指定文件添加指定人/部门。

WEDRIVE_FILE_ACL_ADD /cgi-bin/wedrive/file_acl_add?access_token=ACCESS_TOKEN POST 94021
10 效率工具 > 微盘 > 文件权限 > 删除指定人

该接口用于删除指定文件的指定人/部门。

WEDRIVE_FILE_ACL_DEL /cgi-bin/wedrive/file_acl_del?access_token=ACCESS_TOKEN POST 94022
10 效率工具 > 微盘 > 文件权限 > 分享设置

该接口用于文件的分享设置。

WEDRIVE_FILE_SETTING /cgi-bin/wedrive/file_setting?access_token=ACCESS_TOKEN POST 94023
10 效率工具 > 微盘 > 文件权限 > 获取分享链接

该接口用于获取文件的分享链接

WEDRIVE_FILE_SHARE /cgi-bin/wedrive/file_share?access_token=ACCESS_TOKEN POST 94024
10 效率工具 > 公费电话 > 获取公费电话拨打记录

企业可通过此接口,按时间范围拉取成功接通的公费电话拨打记录。

GET_DIAL_RECORD /cgi-bin/dial/get_dial_record?access_token=ACCESS_TOKEN POST 95001
11 企业支付 > 对外收款 > 收款商户号管理 > 新增商户号

使用该接口时需要开通对外收款能力并绑定第一个商户号。(说明:第一个商户号的绑定需要由企业管理员手动绑定,绑定入口在:手机端工作台-对外收款,或管理后台-应用管理-对外收款-启用)

通过该接口可以导入其他商户号,同一个企业最多绑定5000个商户号。

ADDMERCHANT /cgi-bin/externalpay/addmerchant?access_token=ACCESS_TOKEN POST 114001
11 企业支付 > 对外收款 > 收款商户号管理 > 查询商户号详情

通过该接口可以查询已绑定商户号信息以及商户号使用范围

GETMERCHANT /cgi-bin/externalpay/getmerchant?access_token=ACCESS_TOKEN POST 114002
11 企业支付 > 对外收款 > 收款商户号管理 > 删除商户号

通过该接口可以删除未绑定的商户号

DELMERCHANT /cgi-bin/externalpay/delmerchant?access_token=ACCESS_TOKEN POST 114003
11 企业支付 > 对外收款 > 收款商户号管理 > 设置商户号使用范围

通过该接口可以设置已绑定商户号的使用范围

SET_MCH_USE_SCOPE /cgi-bin/externalpay/set_mch_use_scope?access_token=ACCESS_TOKEN POST 114004
11 企业支付 > 对外收款 > 获取对外收款记录

企业和服务商可通过此接口获取企业的对外收款记录。

GET_BILL_LIST /cgi-bin/externalpay/get_bill_list?access_token=ACCESS_TOKEN POST 114004
12 企业互联 > 获取应用共享信息

上级/上游企业通过该接口可以获取某个应用分享给的所有企业列表。

对于有敏感权限的应用,需要下级/下游企业确认后才能共享成功,若下级/下游企业未确认,则不会存在于该接口的返回列表

CORP_LIST_APP_SHARE_INFO /cgi-bin/corpgroup/corp/list_app_share_info?access_token=ACCESS_TOKEN POST 120001
12 企业互联 > 获取下级/下游企业的access_token

获取应用可见范围内下级/下游企业的access_token,该access_token可用于调用下级/下游企业通讯录的只读接口。

CORP_GETTOKEN /cgi-bin/corpgroup/corp/gettoken?access_token=ACCESS_TOKEN POST 120002
12 企业互联 > 获取下级/下游企业小程序session

上级/上游企业通过该接口转换为下级/下游企业的小程序session

CORP_MINIPROGRAM_TRANSFER_SESSION /cgi-bin/miniprogram/transfer_session?access_token=ACCESS_TOKEN POST 120003
14 会话内容存档 > 获取会话同意情况 > 单聊请求

企业可通过下述接口,获取会话中外部成员的同意情况

MSGAUDIT_CHECK_SINGLE_AGREE /cgi-bin/msgaudit/check_single_agree?access_token=ACCESS_TOKEN POST 140001
14 会话内容存档 > 获取会话同意情况 > 群聊请求

企业可通过下述接口,获取会话中外部成员的同意情况

MSGAUDIT_CHECK_ROOM_AGREE /cgi-bin/msgaudit/check_room_agree?access_token=ACCESS_TOKEN POST 140001
14 会话内容存档 > 获取会话内容存档内部群信息

企业可通过此接口,获取会话内容存档本企业的内部群信息,包括群名称、群主id、公告、群创建时间以及所有群成员的id与加入时间

MSGAUDIT_GROUPCHAT_GET /cgi-bin/msgaudit/groupchat/get?access_token=ACCESS_TOKEN POST 140003