开发者中心
首页
教程
接口
社区
工具
服务商代开发
快速入门 服务端API 客户端API 附录 更新日志 联系我们
服务商代开发
企业内部开发 第三方应用开发 服务商代开发 智慧硬件开发
服务商代开发
附录
全局错误码
上一篇访问频率限制
下一篇企业规模与行业信息
关于腾讯用户协议帮助中心© 1998 - 2025 Tencent Inc. All Rights Reserved
    本节内容
快速入门
概述
代开发流程
服务端API
开发指南
开发前必读
基本概念介绍
与自建应用接口的差异
代开发应用权限说明
回调配置
获取企业微信接口IP段
获取企业微信回调IP段
基础
应用授权
代开发流程
接口调用
获取服务商凭证
获取代开发应用模板凭证
代开发授权应用secret的获取
代开发授权应用access_token的获取
获取企业授权信息
获取带参授权链接
获取应用权限详情
获取应用管理员列表
回调通知
概述
推送suite_ticket
授权通知事件
重置永久授权码通知
获客助手权限变更通知
接口调用许可
概述与指引
订单管理
下单购买账号
下单续期账号
获取订单列表
获取订单详情
获取订单中的账号列表
取消订单
下单购买多企业账号
获取多企业订单详情
使用余额支付订单
账号管理
激活账号
获取激活码详情
获取企业的账号列表
获取成员的激活详情
账号继承
分配激活码给下游/下级企业
应用管理
获取应用的接口许可状态
回调通知
接口许可失效通知
支付成功通知
退款结果通知
自动激活回调通知
自动激活设置
设置企业的许可自动激活状态
查询企业的许可自动激活状态
民生优惠条件查询
充值账户余额查询
收银台
功能概述
概述
商户号开通
代开发应用支付接入
订单收款工具
企业客户购买
收款工具
创建收款订单
取消收款订单
获取收款订单列表
获取收款订单详情
签名算法
发票管理
获取发票列表
标记开票状态
应用版本回调
下单成功通知
改单通知
支付成功通知
退款通知
取消订单通知
账号ID
概述
安全性升级说明
代开发应用安全性升级
ID转换接口
corpid的转换
userid的转换
external_userid的转换
unionid与external_userid的关联
客户标签ID的转换
微信客服ID的转换
tmp_external_userid的转换
ID迁移完成状态的设置
群ID的升级转换
获取接口大批量调用凭据
通讯录管理
概述
成员管理
成员扩展属性
读取成员
获取部门成员
获取部门成员详情
userid与openid互换
手机号获取userid
邮箱获取userid
获取成员ID列表
部门管理
获取部门列表
获取子部门ID列表
获取单个部门详情
标签管理
创建标签
更新标签名字
删除标签
获取标签成员
增加标签成员
删除标签成员
获取标签列表
异步导出接口
概述
导出成员
导出成员详情
导出部门
导出标签成员
获取导出结果
导出任务完成通知
通讯录回调通知
概述
成员变更通知
部门变更通知
标签变更通知
异步任务完成通知
身份验证
网页授权登录
开始开发
构造网页授权链接
获取访问用户身份
获取访问用户敏感信息
企业微信Web登录
开始开发
Web登录组件
获取用户登录身份
企业互联
概述
获取应用共享信息
获取下级/下游企业的access_token
获取下级/下游企业小程序session
上下游
基础接口
获取应用共享信息
获取下级/下游企业的access_token
获取下级/下游企业小程序session
上下游关联客户信息-已添加客户
上下游关联客户信息-未添加客户
上下游通讯录管理
获取上下游信息
消息推送
概述
发送应用消息
更新模版卡片消息
撤回应用消息
接收消息与事件
概述
消息格式
事件格式
被动回复消息格式
应用管理
获取应用
设置工作台自定义展示
自建应用迁移成代开发应用
素材管理
概述
上传临时素材
上传图片
获取临时素材
获取高清语音素材
异步上传临时素材
电子发票
概述
查询电子发票
更新发票状态
批量更新发票状态
批量查询电子发票
会话内容存档
概述
收费方案
会话展示组件
基础接口
获取授权存档的成员列表
设置公钥
获取会话记录
获取内部群信息
获取会话同意情况
会话组件敏感信息隐藏设置
会话搜索
会话名称搜索
会话消息搜索
关键词规则管理
关键词规则管理
获取命中关键词规则的会话记录
会话内容分析与导出
会话内容分析
会话内容导出
回调通知
会话存档接口权限授权通知
客户同意进行聊天内容存档事件回调
产生会话回调事件
命中关键词规则通知
数据与智能专区
概述
基本概念介绍
接入指引
收费方案
专区程序开发指引
专区程序示例
专区程序SDK和示例下载
镜像文件配置指引
会话展示组件
基础接口
设置公钥
获取授权存档的成员列表
设置专区接收回调事件
会话组件敏感信息隐藏设置
设置日志打印级别
上传临时文件到专区
获取数据与智能专区授权信息
应用调用专区程序
概述
应用同步调用专区程序
应用异步调用专区程序
专区程序调用sdk
概述
获取会话记录
获取会话同意情况
获取内部群信息
会话名称搜索
会话消息搜索
员工或客户名称搜索
关键词规则管理
获取命中关键词规则的会话记录
管理企业知识集
通用模型
话术推荐模型
客户标签模型
会话摘要模型
情感分析模型
自有模型分析
会话反垃圾分析
会话内容导出
异步调用自有分析程序
上报异步任务结果
专区通知应用
专区程序接收事件通知
概述
客户同意进行聊天内容存档事件回调
产生会话回调通知
命中关键词规则通知
知识集管理回调
会话内容导出完成通知
应用接收专区通知
应用接收专区通知
专区调试模式
调试说明
开启专区调试模式
关闭专区调试模式
获取专区调试模式状态
订单管理接口
概述
下单购买
取消订单
使用余额支付订单
获取订单列表
获取订单详情
获取企业已购信息
订单管理回调
支付成功通知
退款结果通知
取消订单通知
接口不足通知
接口购买到期通知
接口试用到期通知
常见问题
连接微信
客户联系
概述
成员对外信息
企业服务人员管理
获取配置了客户联系功能的成员列表
检查用户是否配置了客户联系功能使用权限
客户管理
获取客户列表
获取客户详情
批量获取客户详情
修改客户备注信息
客户联系规则组管理
客户标签管理
管理企业标签
编辑客户企业标签
管理企业规则组下的客户标签
在职继承
分配在职成员的客户
查询客户接替状态
分配在职成员的客户群
离职继承
获取待分配的离职成员列表
分配离职成员的客户
查询客户接替状态
分配离职成员的客户群
客户群管理
获取客户群列表
获取客户群详情
客户群opengid转换
联系我与客户入群方式
客户联系「联系我」管理
客户群「加入群聊」管理
客户朋友圈
概述
企业发表内容到客户的朋友圈
停止发表企业朋友圈
获取客户朋友圈全部的发表记录
客户朋友圈规则组管理
获客助手
获客链接管理
获取由获客链接添加的客户信息
获客助手额度管理与使用统计
提升广告有效率
获取成员多次收消息详情
消息推送
创建企业群发
提醒成员群发
停止企业群发
获取企业的全部群发记录
发送新客户欢迎语
入群欢迎语素材管理
统计管理
获取「群聊数据统计」数据
获取「联系客户统计」数据
变更回调
概述
事件格式
获客助手事件通知
管理商品图册
管理聊天敏感词
上传附件资源
微信客服
概述
客服账号管理
添加客服账号
删除客服账号
修改客服账号
获取客服账号列表
获取客服账号链接
接待人员管理
添加接待人员
删除接待人员
获取接待人员列表
会话分配与消息收发
分配客服会话
接收消息和事件
发送消息
发送欢迎语等事件响应消息
「升级服务」配置
其他基础信息获取
获取客户基础信息
统计管理
获取「客户数据统计」企业汇总数据
获取「客户数据统计」接待人员明细数据
回调通知
企业支付
对外收款
概述
获取对外收款记录
获取收款项目的商户单号
签名算法
家校沟通
概述
基础接口
获取「学校通知」二维码
发送「学校通知」
发送「学校通知」小程序消息
外部联系人openid转换
在微信中填写学生资料
获取可使用的家长范围
网页授权登录
开始开发
构造网页授权链接
获取访问用户身份
获取家校访问用户身份
学生与家长管理
创建学生
删除学生
更新学生
批量创建学生
批量删除学生
批量更新学生
创建家长
删除家长
更新家长
批量创建家长
批量删除家长
批量更新家长
读取学生或家长
获取部门学生详情
设置家校通讯录自动同步模式
获取部门家长详情
部门管理
创建部门
更新部门
删除部门
获取部门列表
标准年级对照表
修改自动升年级的配置
家校通讯录变更回调
成员变更事件
部门变更事件
家校应用
上课直播
获取老师直播ID列表
获取直播详情
获取观看直播统计
获取未观看直播统计
删除直播回放
获取观看直播统计V2
获取未观看直播统计V2
班级收款
政民沟通
配置网格结构
概述
添加网格
编辑网格
删除网格
获取网格列表
获取用户负责及参与的网格列表
配置事件类别
添加事件类别
修改事件类别
删除事件类别
获取事件类别列表
巡查上报
概述
获取配置的网格及网格负责人
获取单位巡查上报数据统计
获取个人巡查上报数据统计
获取上报事件分类统计
获取巡查上报事件列表
获取巡查上报的事件详情信息
居民上报
概述
获取配置的网格及网格负责人
获取单位居民上报数据统计
获取个人居民上报数据统计
获取上报事件分类统计
获取居民上报事件列表
获取居民上报的事件详情信息
办公
邮件
概述
发送邮件
发送普通邮件
发送日程邮件
发送会议邮件
获取接收的邮件
获取收件箱邮件列表
获取邮件内容
回调通知
文档
概述
管理文档
新建文档
重命名文档
删除文档
获取文档基础信息
分享文档
编辑文档
编辑文档内容
编辑表格内容
编辑智能表格内容
添加子表
删除子表
更新子表
添加视图
删除视图
更新视图
添加字段
删除字段
更新字段
添加记录
删除记录
更新记录
获取文档数据
获取文档数据
获取表格行列信息
获取表格数据
获取智能表格数据
查询子表
查询视图
查询字段
查询记录
设置文档权限
获取文档权限信息
修改文档查看规则
修改文档通知范围及权限
修改文档安全设置
管理智能表格内容权限
管理收集表
创建收集表
编辑收集表
获取收集表信息
收集表的统计信息查询
读取收集表答案
回调通知
概述
修改文档成员事件
删除文档事件
收集表完成事件
删除收集表事件
修改收集表设置事件
日程
概述
管理日历
创建日历
更新日历
获取日历详情
删除日历
管理日程
创建日程
更新日程
更新重复日程
新增日程参与者
删除日程参与者
获取日历下的日程列表
获取日程详情
取消日程
回调通知
概述
删除日历事件
修改日历事件
修改日程事件
删除日程事件
日程回执事件
会议
概述
创建预约会议
修改预约会议
取消预约会议
获取成员会议ID列表
回调通知
微盘
概述
管理空间
新建空间
重命名空间
解散空间
获取空间信息
管理空间权限
添加成员/部门
移除成员/部门
安全设置
获取邀请链接
获取空间信息
管理文件
获取文件列表
上传文件
文件分块上传
下载文件
新建文件夹/文档
重命名文件
移动文件
删除文件
获取文件信息
管理文件权限
新增成员
删除成员
分享设置
获取分享链接
获取文件权限信息
修改文件安全设置
版本和容量管理
回调通知
概述
微盘容量不足事件
空间变更事件
文件变更事件
解散空间
修改空间成员
修改空间安全设置
直播
概述
创建预约直播
修改预约直播
取消预约直播
删除直播回放
在微信中观看直播或直播回放
获取成员直播ID列表
获取直播详情
获取直播观看明细
直播回调事件
获取跳转小程序商城的直播观众信息
打卡
获取打卡记录数据
获取打卡日报数据
获取打卡月报数据
获取打卡人员排班信息
为打卡人员排班
获取设备打卡数据
管理打卡规则
获取员工打卡规则
获取企业所有打卡规则
审批
概述
获取审批模板详情
提交审批申请
审批申请状态变化回调通知
批量获取审批单号
获取审批申请详情
获取企业假期管理配置
获取成员假期余额
修改成员假期余额
审批流程引擎
创建审批模板
更新审批模板
紧急通知应用
发起语音电话
获取接听状态
客户端API
小程序
开发指南
开发前须知
开发者工具插件支持
小程序关联到代开发应用
小程序体验版配置
微信小程序API支持情况
微信小程序组件支持情况
基础
登录
小程序登录流程
wx.qy.login
code2Session
wx.qy.checkSession
基础接口
wx.getSystemInfo
wx.getSystemInfoSync
wx.qy.getSystemInfo
wx.qy.canIUse
wx.qy.getContext
企业通讯录
wx.qy.selectEnterpriseContact
wx.qy.openUserProfile
wx.qy.getEnterpriseUserInfo
wx.qy.getAvatar
wx.qy.getQrCode
wx.qy.getMobile
wx.qy.getEmail
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
更多
小程序发送通知
语音转文字接口
转发成功回调
打开webview接口
从会话选择文件
连接微信
客户联系
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
微信客服
客服工具栏接口
微信小程序打开微信客服
wx.qy.navigateToKfChat
对外收款
发起对外收款
发起退款
家校沟通
发起班级收款
微信小程序进入填写学生资料页面
政民沟通
微信进入居民上报小程序
办公
文档
创建文档
选择文档
日程
查看日程闲忙状态
会议
创建快速会议
进入会议
微盘
选择目录位置
选择文件
选择可下载的文件
直播
创建立即直播
进入直播
观看直播回放
下载直播回放
智慧硬件
添加设备
查看设备
视频会议
无线投屏
WECOM-JSSDK
开发指南
基础接口
ww.register
ww.getSignature
ww.checkJsApi
ww.getContext
企业通讯录
选择通讯录成员
调起个人信息页面
企业互联/上下游选人接口
认领老师班级
上下游
获取上下游联系人ID
获取上下游互联群ID
会话
打开会话
变更群成员
打开已有群聊并发送消息
聊天附件栏接口
分享消息到当前会话
私密消息
创建企业互联/上下游会话
变更企业互联/上下游群成员
分享
监听「转发」按钮点击
监听「微信」按钮点击
监听「朋友圈」按钮点击
自定义转发到会话
自定义转发到微信
界面
监听页面返回
隐藏右上角菜单
显示右上角菜单
关闭当前窗口
批量隐藏功能按钮
批量显示功能按钮
隐藏非基础按钮
显示非基础按钮
打开默认浏览器
监听截屏事件
系统界面
调起扫一扫
调起电子发票
跳转认证界面
调起应用管理界面
图像
选择图片
预览图片
上传图片
下载图片
获取本地图片
音频
开始录音
停止录音
监听录音自动停止
播放语音
暂停播放
停止播放
监听播放完毕
上传语音
下载语音
语音转文字
开放接口
创建企业微信登录面板
文件
预览文件
Wi-Fi
初始化 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
开发指南
概述
使用说明
基础
基础接口
wx.agentConfig
wx.checkJsApi
获取进入页面的环境
企业通讯录
选人接口
打开个人信息页接口
企业互联/上下游选人接口
认领老师班级
上下游
聊天工具栏接口
会话
打开会话
变更群成员
创建群聊并发送消息
打开已有群聊并发送消息
聊天附件栏接口
分享消息到当前会话
打开个人聊天窗口schema
私密消息
创建企业互联/上下游会话
变更企业互联/上下游群成员
应用管理
打开应用管理页面
界面
分享接口
界面操作
企业微信扫一扫
电子发票
跳转到小程序
保持屏幕常亮
媒体
图像接口
音频接口
文件接口
从会话选择文件
设备
Wi-Fi
蓝牙
iBeacon
剪贴板
网络状态
地理位置
连接微信
客户联系
外部联系人选人接口
打开个人信息页接口
聊天工具栏接口
获取当前外部联系人userid
获取当前客户群的群ID
分享消息到当前会话
群发消息给客户
群发消息到客户群
进入添加客户界面
发表内容到客户朋友圈
设置朋友圈封面与签名
微信客服
客服工具栏接口
进入微信客服消息界面
对外收款
发起对外收款
发起退款
家校沟通
发起班级收款
微信H5页面唤起填写学生资料页面
政民沟通
微信进入居民上报小程序
办公
文档
创建文档
选择文档
文件/文档标题展示组件
日程
查看日程闲忙状态
会议
创建快速会议
进入会议
微盘
选择目录位置
选择文件
选择可下载的文件
文件/文档标题展示组件
直播
创建立即直播
进入直播
观看直播回放
下载直播回放
审批
应用发起审批
审批控件中的外部选项
智慧硬件
获取设备数据授权
添加设备
查看设备
视频会议
无线投屏
附录
JS-SDK使用权限签名算法
所有菜单项列表
常见错误及解决方法
附录
加解密方案说明
访问频率限制
全局错误码
企业规模与行业信息
常见问题 - FAQ
深色模式适配指南
更新日志
更新日志
联系我们
联系我们