开发者工具 - 文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

登录

企业内部开发

快速入门服务端API 客户端API 工具与资源附录更新日志联系我们

企业内部开发

企业内部开发

企业内部开发

工具与资源

开发者工具

开发者工具

最后更新：2024/07/18

接口调试工具

若调用接口返回错误码，可参考全局错误码，文档有相关排查解决方案

常见问题FAQ 也提供了一些问题的解决方案

JSSDK调试工具

用于校验jsapi签名的调试工具：签名校验工具

jsapi demo演示地址(企业微信里面访问)：https://open.work.weixin.qq.com/api/jsapidemo

(可用企业微信扫一扫以下二维码)
联系我们

联系我们

上一篇群机器人配置说明

下一篇样式库 WeUI for Work

关于腾讯用户协议帮助中心© 1998 - 2024 Tencent Inc. All Rights Reserved

本节内容

快速入门

服务端API

开发指南

开发前必读

基本概念介绍

获取access_token

获取企业微信接口IP段

获取企业微信回调IP段

基础

账号ID

自建应用与第三方应用的对接

tmp_external_userid的转换

通讯录管理

成员管理

成员扩展属性

批量删除成员

获取部门成员

获取部门成员详情

userid与openid互换

登录二次验证

获取加入企业二维码

手机号获取userid

邮箱获取userid

获取成员ID列表

部门管理

获取部门列表

获取子部门ID列表

获取单个部门详情

标签管理

更新标签名字

获取标签成员

增加标签成员

删除标签成员

获取标签列表

异步导入接口

增量更新成员

全量覆盖成员

全量覆盖部门

获取异步任务结果

异步导出接口

导出成员详情

导出标签成员

获取导出结果

导出任务完成通知

通讯录回调通知

成员变更通知

部门变更通知

标签变更通知

异步任务完成通知

通讯录同步接口调整

身份验证

网页授权登录

构造网页授权链接

获取访问用户身份

获取访问用户敏感信息

企业微信Web登录

Web登录组件

获取用户登录身份

二次验证

获取用户二次验证信息

登录二次验证

使用二次验证

企业互联

获取应用共享信息

获取下级/下游企业的access_token

获取下级/下游企业小程序session

安全管理

文件防泄漏

截屏/录屏管理

高级功能账号管理

分配高级功能账号

取消高级功能账号

获取高级功能账号列表

操作日志

获取成员操作记录

获取管理端操作日志

获取企业微信域名IP信息

消息推送

发送应用消息

更新模版卡片消息

撤回应用消息

接收消息与事件

被动回复消息格式

应用发送消息到群聊会话

创建群聊会话

修改群聊会话

获取群聊会话

应用推送消息

互联企业消息推送

发送应用消息

接收消息与事件

家校消息推送

发送「学校通知」

群机器人

群机器人配置说明

应用管理

自定义菜单

设置工作台自定义展示

素材管理

上传临时素材

获取临时素材

获取高清语音素材

异步上传临时素材

电子发票

查询电子发票

更新发票状态

批量更新发票状态

批量查询电子发票

连接微信

客户联系

成员对外信息

企业服务人员管理

获取配置了客户联系功能的成员列表

客户管理

获取客户列表

获取客户详情

批量获取客户详情

修改客户备注信息

客户联系规则组管理

客户标签管理

管理企业标签

管理企业规则组下的客户标签

编辑客户企业标签

在职继承

分配在职成员的客户

查询客户接替状态

分配在职成员的客户群

离职继承

获取待分配的离职成员列表

分配离职成员的客户

查询客户接替状态

分配离职成员的客户群

客户群管理

获取客户群列表

获取客户群详情

客户群opengid转换

联系我与客户入群方式

客户联系「联系我」管理

客户群「加入群聊」管理

客户朋友圈

企业发表内容到客户的朋友圈

停止发表企业朋友圈

获取客户朋友圈全部的发表记录

客户朋友圈规则组管理

获客助手

获客链接管理

获取由获客链接添加的客户信息

获客助手额度管理与使用统计

提升广告有效率

获取成员多次收消息详情

消息推送

创建企业群发

提醒成员群发

停止企业群发

获取企业的全部群发记录

发送新客户欢迎语

入群欢迎语素材管理

统计管理

获取「联系客户统计」数据

获取「群聊数据统计」数据

回调通知

获客助手事件通知

管理商品图册

管理聊天敏感词

上传附件资源

获取已服务的外部联系人

微信客服

客服账号管理

添加客服账号

删除客服账号

修改客服账号

获取客服账号列表

获取客服账号链接

接待人员管理

添加接待人员

删除接待人员

获取接待人员列表

会话分配与消息收发

分配客服会话

接收消息和事件

发送欢迎语等事件响应消息

「升级服务」配置

其他基础信息获取

获取客户基础信息

统计管理

获取「客户数据统计」企业汇总数据

获取「客户数据统计」接待人员明细数据

机器人管理

知识库分组管理

知识库问答管理

企业支付

企业红包

发放企业红包

查询红包记录

向员工付款

向员工付款

查询付款记录

向员工收款

对外收款

收款商户号管理

获取对外收款记录

获取收款项目的商户单号

获取资金流水

创建对外收款账户

提交创建对外收款账户的申请单

查询申请单状态

小程序接入对外收款

普通支付

小程序下单

获取支付签名

退款

回调通知

账单

交易账单申请

会话内容存档

使用前帮助

获取会话内容

开发案例演示

常见问题解答

获取会话内容存档开启成员列表

获取会话同意情况

客户同意进行聊天内容存档事件回调

获取会话内容存档内部群信息

产生会话回调事件

家校沟通

基础接口

获取「学校通知」二维码

管理「学校通知」的关注模式

发送「学校通知」

管理「班级群创建方式」

外部联系人openid转换

获取可使用的家长范围

网页授权登录

构造网页授权链接

获取访问用户身份

获取家校访问用户身份

学生与家长管理

批量创建学生

批量删除学生

批量更新学生

批量创建家长

批量删除家长

批量更新家长

读取学生或家长

获取部门学生详情

设置家校通讯录自动同步模式

获取部门家长详情

部门管理

获取部门列表

标准年级对照表

修改自动升年级的配置

家校通讯录变更回调

成员变更事件

部门变更事件

家校应用

健康上报

获取健康上报使用统计

获取健康上报任务ID列表

获取健康上报任务详情

获取用户填写答案

复学码

获取老师健康信息

获取学生健康信息

获取师生健康码

上课直播

获取老师直播ID列表

获取直播详情

获取观看直播统计

获取未观看直播统计

删除直播回放

获取观看直播统计V2

获取未观看直播统计V2

班级收款

获取学生付款结果

获取订单详情

办公

邮件

发送邮件

发送普通邮件

发送日程邮件

发送会议邮件

获取接收的邮件

获取收件箱邮件列表

获取邮件内容

管理应用邮箱账号

更新应用邮箱账号

查询应用邮箱账号

管理邮件群组

创建邮件群组

更新邮件群组

删除邮件群组

获取邮件群组详情

模糊搜索邮件群组

管理公共邮箱

创建公共邮箱

更新公共邮箱

删除公共邮箱

获取公共邮箱详情

模糊搜索公共邮箱

获取客户端专用密码列表

删除客户端专用密码

高级功能账号管理

分配高级功能账号

取消高级功能账号

获取高级功能账号列表

禁用/启用邮箱账号

其他邮件客户端登录设置

获取用户功能属性

更改用户功能属性

获取邮件未读数

文档

管理文档

重命名文档

获取文档基础信息

编辑文档

编辑文档内容

编辑表格内容

编辑智能表格内容

获取文档数据

获取文档数据

获取表格行列信息

获取表格数据

获取智能表格数据

设置文档权限

获取文档权限信息

修改文档查看规则

修改文档通知范围及权限

修改文档安全设置

管理智能表格内容权限

管理收集表

创建收集表

编辑收集表

获取收集表信息

收集表的统计信息查询

读取收集表答案

回调通知

修改文档成员事件

删除文档事件

收集表完成事件

删除收集表事件

修改收集表设置事件

高级功能账号管理

分配高级功能账号

取消高级功能账号

获取高级功能账号列表

素材管理

上传文档图片

日程

管理日历

获取日历详情

管理日程

更新重复日程

新增日程参与者

删除日程参与者

获取日历下的日程列表

获取日程详情

回调通知

删除日历事件

修改日历事件

修改日程事件

删除日程事件

日程回执事件

会议

预约会议基础管理

创建预约会议

修改预约会议

取消预约会议

获取会议详情

获取成员会议ID列表

会议统计管理

获取会议发起记录

会中控制管理

管理会中设置

管理联席主持人

关闭或开启成员视频

关闭成员屏幕共享

修改成员在会中显示的昵称

管理等候室成员

创建会议投票主题

修改会议投票主题

获取会议投票列表

获取会议投票主题信息

获取会议投票详情

删除会议投票

发起会议投票

结束会议投票

网络研讨会 (Webinar) 管理

创建网络研讨会

修改网络研讨会

取消网络研讨会

获取网络研讨会详情

获取网络研讨会嘉宾列表

更新网络研讨会嘉宾列表

管理网络研讨会暖场配置

修改网络研讨会报名配置

获取网络研讨会报名配置

获取网络研讨会成员报名 ID

获取网络研讨会报名信息

审批网络研讨会报名信息

导入网络研讨会报名信息

删除网络研讨会报名信息

电话入会（PSTN）管理

获取会议的外呼状态

获取电话入会的成员ID

Rooms会议室管理

预定Rooms会议室

释放Rooms会议室

获取Rooms会议室列表

获取Rooms会议室详情

获取Rooms会议室配置项

获取Rooms会议室下的会议列表

获取设备列表

获取控制器列表

获取Rooms会议室资源

呼叫Rooms会议室

取消呼叫Rooms会议室

获取Rooms会议室应答状态

会议室连接器（MRA）管理

获取 MRA 状态信息

切换 MRA 默认布局

设置 MRA 举手或手放下

挂断 MRA 呼叫

会议布局和背景管理

获取布局模板列表

添加会议基础布局

添加会议高级布局

修改会议基础布局

修改会议高级布局

设置会议默认布局

设置高级布局

获取会议布局列表

获取用户布局

批量删除布局

添加会议背景

设置会议默认背景

获取会议背景列表

删除会议背景

批量删除会议背景

录制管理

获取会议录制列表

获取录制文件访问统计

修改会议录制共享设置

删除会议录制

删除单个录制文件

高级功能账号管理

分配高级功能账号

取消高级功能账号

获取高级功能账号列表

直播

创建预约直播

修改预约直播

取消预约直播

删除直播回放

在微信中观看直播或直播回放

获取成员直播ID列表

获取直播详情

获取直播观看明细

直播回调事件

获取跳转小程序商城的直播观众信息

公费电话

获取公费电话拨打记录

打卡

获取企业所有打卡规则

获取员工打卡规则

获取打卡记录数据

获取打卡日报数据

获取打卡月报数据

获取打卡人员排班信息

为打卡人员排班

为打卡人员补卡

添加打卡记录

录入打卡人员人脸信息

获取设备打卡数据

管理打卡规则

审批

获取审批模板详情

提交审批申请

审批申请状态变化回调通知

批量获取审批单号

获取审批申请详情

获取审批数据（旧）

获取企业假期管理配置

获取成员假期余额

修改成员假期余额

审批流程引擎

创建审批模板

更新审批模板

汇报

批量获取汇报记录单号

获取汇报记录详情

获取汇报统计数据

下载微盘文件

人事助手

花名册

获取员工字段配置

获取员工花名册信息

更新员工花名册信息

会议室

会议室管理

会议室预定管理

高级功能

成员申请的提交回调

成员申请的终止回调

设置审批单审批信息

批量获取申请单ID

获取申请单详细信息

紧急通知应用

发起语音电话

获取接听状态

客户端API

小程序

开发指南

开发前须知

开发者工具插件支持

小程序关联到企业微信

小程序体验版配置

微信小程序API支持情况

微信小程序组件支持情况

基础

登录

小程序登录流程

wx.qy.checkSession

基础接口

wx.getSystemInfo

wx.getSystemInfoSync

wx.qy.getSystemInfo

wx.qy.getContext

企业通讯录

wx.qy.selectEnterpriseContact

wx.qy.openUserProfile

wx.qy.getEnterpriseUserInfo

wx.qy.getAvatar

wx.qy.getQrCode

wx.qy.getMobile

wx.qy.selectCorpGroupContact

wx.qy.claimClassAdmin

上下游

聊天工具栏接口

会话

wx.qy.openEnterpriseChat

wx.qy.updateEnterpriseChat

wx.qy.sendChatMessage

wx.qy.createCorpGroupChat

wx.qy.updateCorpGroupChat

应用管理

打开应用管理页面

NFC接口

wx.qy.getNFCReaderState

wx.qy.startNFCReader

wx.qy.stopNFCReader

onNFCReadMessage

更多

小程序发送通知

语音转文字接口

转发成功回调

从会话选择文件

连接微信

客户联系

wx.qy.selectExternalContact

wx.qy.openUserProfile

wx.qy.getCurExternalContact

wx.qy.getCurExternalChat

wx.qy.sendChatMessage

wx.qy.shareToExternalContact

wx.qy.shareToExternalChat

wx.qy.navigateToAddCustomer

「联系我」插件

在小程序中加入群聊

wx.qy.shareToExternalMoments

wx.qy.updateMomentsSetting

微信客服

客服工具栏接口

微信小程序打开微信客服

对外收款

发起对外收款

家校沟通

发起班级收款

微信小程序进入填写学生资料页面

政民沟通

微信进入居民上报小程序

办公

文档

日程

查看日程闲忙状态

会议

创建快速会议

微盘

选择目录位置

直播

创建立即直播

观看直播回放

下载直播回放

WECOM-JSSDK

基础接口

ww.getSignature

企业通讯录

选择通讯录成员

调起个人信息页面

企业互联/上下游选人接口

认领老师班级

上下游

获取上下游联系人ID

获取上下游互联群ID

会话

变更群成员

打开已有群聊并发送消息

聊天附件栏接口

分享消息到当前会话

创建企业互联/上下游会话

变更企业互联/上下游群成员

分享

监听「转发」按钮点击

监听「微信」按钮点击

监听「朋友圈」按钮点击

自定义转发到会话

自定义转发到微信

界面

监听页面返回

隐藏右上角菜单

显示右上角菜单

关闭当前窗口

批量隐藏功能按钮

批量显示功能按钮

隐藏非基础按钮

显示非基础按钮

打开默认浏览器

监听截屏事件

系统界面

调起扫一扫

调起电子发票

跳转认证界面

调起应用管理界面

图像

获取本地图片

音频

监听录音自动停止

监听播放完毕

语音转文字

开放接口

创建企业微信登录面板

文件

Wi-Fi

初始化 Wi-Fi 模块

关闭 Wi-Fi 模块

获取 Wi-Fi 列表

监听 Wi-Fi 列表更新

监听 Wi-Fi 连接成功

获取已连接中的 Wi-Fi 信息

蓝牙

初始化蓝牙模块

关闭蓝牙模块

获取本机蓝牙状态

监听蓝牙状态变化

开始搜寻附近的蓝牙外围设备

停止搜寻蓝牙外围设备

获取已发现的蓝牙设备

监听寻找到新设备

获取已连接状态的设备

蓝牙（BLE）

连接BLE设备

断开设备连接

监听BLE设备连接状态

获取BLE设备所有服务

获取BLE设备特征值

读取BLE设备特征值数据

写入BLE设备特征值数据

启用BLE设备特征值订阅

监听BLE设备特征值变化

iBeacon

搜索附近设备

停止搜索设备

获取已搜索到的设备

监听设备更新

监听设备服务状态

剪贴板

设置剪贴板内容

获取剪贴板内容

网络

获取网络状态

监听网络状态

地理位置

打开内置地图

获取地理位置

打开持续定位

停止持续定位

监听地理位置

客户联系

调起外部联系人列表

调起个人信息页面

获取当前外部联系人 userId

获取当前客户群的群ID

分享消息到当前会话

群发消息给客户

群发消息到客户群

调起添加客户界面

发表内容到客户朋友圈

设置朋友圈封面与签名

微信客服

向当前会话发送消息

调起微信客服消息界面

对外收款

发起对外收款

家校沟通

发起班级收款

日程

查看日程闲忙

会议

创建会议并调起会议室页面

直播

创建直播并调起直播页面

调起直播间回放

调起直播回放下载页面

审批

应用发起审批

JS-SDK

开发指南

基础

基础接口

获取进入H5页面的入口环境

企业通讯录

打开个人信息页接口

企业互联/上下游选人接口

认领老师班级

上下游

聊天工具栏接口

会话

变更群成员

打开已有群聊并发送消息

聊天附件栏接口

分享消息到当前会话

打开个人聊天窗口schema

创建企业互联/上下游会话

变更企业互联/上下游群成员

应用管理

打开应用管理页面

界面

企业微信扫一扫

快速跳转到认证界面

跳转到小程序

保持屏幕常亮

媒体

从会话选择文件

设备

连接微信

客户联系

外部联系人选人接口

打开个人信息页接口

聊天工具栏接口

获取当前外部联系人userid

获取当前客户群的群ID

分享消息到当前会话

群发消息给客户

群发消息到客户群

进入添加客户界面

发表内容到客户朋友圈

设置朋友圈封面与签名

微信客服

客服工具栏接口

进入微信客服消息界面

对外收款

发起对外收款

家校沟通

发起班级收款

微信H5页面唤起填写学生资料页面

政民沟通

微信进入居民上报小程序

办公

文档

文件/文档标题展示组件

日程

查看日程闲忙状态

会议

创建快速会议

微盘

选择目录位置

文件/文档标题展示组件

直播

创建立即直播

观看直播回放

下载直播回放

审批

应用发起审批

审批控件中的外部选项

附录

JS-SDK使用权限签名算法

所有菜单项列表

常见错误及解决方法

移动端SDK

企业微信登录

企业微信分享

App跳转微信客服

群机器人

群机器人配置说明

工具与资源

开发者工具

样式库 WeUI for Work

设计资源下载

加解密库下载与返回码

接口代码参考示例

移动端SDK资源下载

企业微信应用深色模式色值表

附录

加解密方案说明

访问频率限制

全局错误码

企业规模与行业信息

常见问题 - FAQ

与企业号接口差异

深色模式适配指南

更新日志

联系我们