企业微信 API
企业内部开发
第三方应用开发
智慧硬件开发
企业内部开发
第三方应用开发
智慧硬件开发
官方API文档
功能概述
复制页面
开发指南
开发前必读
基本概念介绍
回调配置
回调配置
回调配置-支持Http Get请求验证URL有效性
回调配置-支持Http Post请求接收业务数据
回调配置-获取企业微信服务器的ip段
企业微信账号ID安全性全面升级
概述
FAQ
一、企业corpid的升级方案
1.1 升级前后对比 - 1.3 历史已授权企业的方案
1.4 corpid转换
二、企业员工userid的升级方案
2.1 升级前后对比 - 2.3历史已授权企业的方案
2.4 userid的转换
三、企业员工external_userid的升级方案
3.1 升级前后对比 - 3.3 历史已授权企业的方案
同意 授权转换external_userid事件
转换external_userid
转换客户群成员external_userid
设置迁移完成
四、企业客户微信unionid的升级方案
概述
4.1 升级之后的接口变化
4.2 unionid查询external_userid
代开发应用安全性升级
说明
四、企业客户微信unionid的升级方案
六、成员敏感信息权限升级
七、本次升级对第三方服务商的影响及建议兼容方案
FAQ
一、企业corpid的升级方案
1.1 升级前后对比-1.3 历史已授权代开发应用方案
1.4 corpid转换
二、企业员工userid的升级方案
2.1 升级前后对比-2.3 历史已授权代开发应用的方案
2.4 userid的转换
三、企业客户external_userid的升级方案
3.1 升级前后对比-3.2 升级之后的接口变化
3.2.1 转换external_userid
3.2.2 转换客户群成员external_userid
五、代开发应用迁移状态
5.1 代开发应用设置迁移完成
5.2 代开发应用查询迁移状态
ID转换接口
ID转换接口
corpid的转换
userid的转换
external_userid的转换-转换客户external_userid
external_userid的转换-转换客户群成员external_userid
unionid与external_userid的关联
unionid与external_userid的关联
unionid转换为第三方external_userid
external_userid查询pending_id
获取服务商凭证
POST
基础
应用授权
企业授权应用
成员授权应用
自建应用代开发
通讯录权限体系
接口调用
获取应用二维码
明文corpid转换为加密corpid
获取第三方应用凭证
获取预授权码
设置授权配置
获取企业永久授权码
获取企业授权信息
获取企业凭证
获取应用的管理员列表
回调接口
概述
共享应用事件回调
授权组织架构权限通知
推送suite_ticket
授权通知事件-授权成功通知
授权通知事件 变更授权通知
授权通知事件 取消授权通知
成员通知事件 新增成员事件
成员通知事件 更新成员事件
成员通知事件 删除成员事件
部门通知事件 新增部门事件
部门通知事件 更新部门事件
部门通知事件 删除部门事件
标签通知事件 标签成员变更事件
重置永久授权码通知
应用管理员变更通知
接口调用许可
概述与指引
订单管理
下单购买帐号
下单续期帐号-创建续期任务
下单续期帐号-提交续期订单
获取订单列表
获取订单详情
获取订单中的帐号列表
取消订单
账号管理
激活帐号-激活帐号
激活帐号-批量激活帐号
获取激活码详情-获取激活码详情
获取激活码详情-批量获取激活码详情
获取企业的帐号列表
获取成员的激活详情
帐号继承
分配激活 码给下游企业
应用管理
获取应用的接口许可状态
回调通知
接口许可失效通知
支付成功通知
退款结果通知
自动激活回调通知
自动激活设置
设置企业的许可自动激活状态
查询企业的许可自动激活状态
民生减免条件查询
收银台
接入指引
功能概述
概述
商户号开通
定价策略配置
企业客户购买
订单收款工具
接口调用
获取订单详情
获取订单列表
获取企业永久授权码
获取企业授权信息
延长试用期
回调通知
应用版本变更通知
下单成功通知
改单通知
支付成功通知
退款通知
推广二维码
接入指引
调用接口
获取注册码
查询注册状态
设置授权应用可见范围
设置通讯录同步完成
回调通知
注册完成回调事件
账号ID
概述
安全性升级说明
代开发应用安 全性升级
说明
四、企业客户微信unionid的升级方案
6.1. 升级后的变化
七、本次升级对第三方服务商的影响及建议兼容方案
FAQ
一、企业corpid的升级方案
1.1 升级前后对比-1.3 历史已授权代开发应用方案
1.4 corpid转换
二、企业员工userid的升级方案
2.1 升级前后对比-2.3 历史已授权代开发应用的方案
2.4 userid的转换
三、企业客户external_userid的升级方案
3.1 升级前后对比-3.2 升级之后的接口变化
3.2.1 转换external_userid
3.2.2 转换客户群成员external_userid
五、代开发应用迁移状态
5.1 代开发应用设置迁移完成
5.2 代开发应用查询迁移状态
企业微信帐号ID安全性全面升级
一、企业corpid的升级方案
1.1 升级前后对比-1.3 历史已授权企业的方案
1.4 corpid转换
二、企业员工userid的升级方案
2.1 升级前后对比-2.3 历史已授权企业的方案
2.4 userid的转换
三、企业客户external_userid的升级方案
3.1 升级前后对比-3.3 历史已授权企业的方案
同意授权转换external_userid事件
转换external_userid
转换客户群成员external_userid
设置迁移完成
四、企业客户微信unionid的升级方案
4.1 升级之后的接口变化
FAQ
4.2 unionid查询external_userid
ID转换接口
unionid与external_userid的关联
unionid与external_userid的关联
unionid转换为第三方external_userid
external_userid查询pending_id
corpid的转换
userid的转换
external_userid的转换-转换客户external_userid
external_userid的转换-转换客户群成 员external_userid
客户标签ID的转换
微信客服ID的转换
通讯录管理
概述
通讯录展示组件
第三方通讯录编辑授权
成员管理
创建成员
读取成员
更新成员
删除成员
批量删除成员
获取部门成员
获取部门成员详情
userid与openid互换-userid转openid
userid与openid互换-openid转userid
二次验证
邀请成员
手机号获取userid
邮箱获取userid
获取成员授权列表
查询成员用户是否已授权
获取选人ticket对应的用户
获取成员ID列表
部门管理
获取单个部门详情
创建部门
更新部门
删除部门
获取部门列表
获取子部门ID列表
标签管理
创建标签
更新标签名字
删除标签
获取标签成员
增加标签成员
删除标签成员
获取标签列表
异步批量接口
概述
增量更新成员
全量覆盖成员
全量覆盖部门
获取异步任务结果
异步导出接口
导出任务完成通知
概述
导出成员
导出成员详情
导出部门
导出标签成员
获取导出结果
通讯录回调通知
异步任务完成通知
成员通知事件-更新成员事件
成员通知事件-删除成员事件
部门通知事件-新增部门事件
部门通知事件-更新部门事件
部门通知事件-删除部门事件
标签通知事件
成员通知事件-新增成员事件
通讯录搜索
通讯录搜索-通讯录单个搜索
通讯录搜索-通讯录批量搜索
通讯录ID转译
概述
上传需要转译的文件
异步通讯录id转译
获取异步任务结果
异步任务回调通知
通讯录userid排序
身份验证
网页授权登录
开始开发
构造网页授权链接
获取访问用户身份
获取访问用户敏感信息
扫码授权登录
接入指引
获取登录用户信息
企业互联
概述
获取下级企业付费版本信息
获取应用共享信息
上下游
获取应用共享信息
消息推送
概述
发送应用模板消息
接收消息与事件
消息格式
事件格式
被动回复消息格式
概述
概述
概述-验证URL有效性
概述-使用接收消息
概述-获取企业微信服务器的ip段
发送应用消息
消息类型
发送应用消息
更新模版卡片消息
撤回应用消息
应用管理
获取应用
获取应用-获取指定的应用详情
获取应用-获取access_token对应的应用列表
设置工作台自定义展示
模版类型数据结构
修改设置工作台自定义开关事件推送
设置工作台自定义展示-设置应用在工作台展示的模版
设置工作台自定义展示-获取应用在工作台展示的模版
设置工作台自定义展示-设置应用在用户工作台展示的数据
素材管理
概述
异步上传临时素材
概述
回调异步任务结果
生成异步上传任务
查询异步任务结果
上传临时素材
上传图片
获取临时素材
获取高清语音素材
电子发票
概述
查询电子发票
更新发票状态
批量更新发票状态
批量查询电子发票
连接微信
客户联系
概述
成员对外信息
企业服务人员管理
获取配置了客户联系功能的成员列表
客户联系「联系我」管理-配置客户联系「联系我」方式
客户联系「联系我」管理-更新企业已配置的「联系我」方式
客户联系「联系我」管理-获取企业已配置的「联系我」方式
客户联系「联系我」管理-获取企业已配置的「联系我」列表
客户联系「联系我」管理-删除企业已配置的「联系我」方式
客户联系「联系我」管理-结束临时会话
客户管理
获取客户列表
获取客户详情
批量获取客户详情
修改客户备注信息
企业主体unionid转换为第三方external_userid
第三方主体unionid转换为第三方external_userid
代开发应用external_userid转换
客户标签管理
管理企业标签
说明
管理企业标签-获取企业标签库
管理企业标签-添加企业客户标签
管理企业标签-编辑企业客户标签
管理企业标签-删除企业客户标签
编辑客户企业标签
在职继承
分配在职成员的客户
查询客户接替状态
分配在职成员的客户群
离职继承
获取待分配的离职成员列表
分配离职成员的客户
查询客户接替状态
分配离职成员的客户群
客户群管理
获取客户群列表
获取客户群详情
客户群opengid转换
联系我与客户入群方式
权限说明
结束语定义
配置客户联系「联系我」方式
获取企业已配置的「联系我」方式
获取企业已配置的「联系我」列表
更新企业已配置的「联系我」方式
删除企业已配置的「联系我」方式
结束临时会话
客户朋友圈
概述
企业发表内容到客户的朋友圈
企业发表内容到客户的朋友圈-创建发表任务
企业发表内容到客户的朋友圈-获取任务创建结果
获取客户朋友圈全部的发表记录
获取客户朋友圈全部的发表记录-获取企业全部的发表列表
获取客户朋友圈全部的发表记录-获取客户朋友圈企业发表的列表
获取客户朋友圈全部的发表记录-获取客户朋友圈发表时选择的可见范围
获取客户朋友圈全部的发表记录-获取客户朋友圈发表后的可见客户列表
获取客户朋友圈全部的发表记录-获取客户朋友圈的互动数据
停止发表企业朋友圈
消息推送
获取企业的全部群发记录
概述
获取企业的全部群发记录-获取群发记录列表
获取企业的全部群发记录-获取群发成员发送任务列表
获取企业的全部群发记录-获取企业群发成员执行结果
创建企业群发
提醒成员群发
停止企业群发
发送新客户欢迎语
入群欢迎语素材管理-添加
入群欢迎语素材管理-编辑
入群欢迎语素材管理-获取
入群欢迎语素材管理-删除
统计管理
获取「联系客户统计」数据
获取「群聊数据统计」数据-按群主聚合的方式
获取「群聊数据统计」数据-按自然日聚合的方式
回调通知
事件格式
管理商品图册
概述
创建商品图册
获取商品图册
删除商品图册
获取商品图册列表
编辑商品图册
管理聊天敏感词
概述
管理聊天敏感词-新建敏感词规则
管理聊天敏感词-获取敏感词规则列表
管理聊天敏感词-获取敏感词规则详情
管理聊天敏感词-修改敏感词规则
管理聊天敏感词 删除敏感词规则
上传附件资源
微信客服
概述
回调通知
客服帐号管理
添加客服帐号
删除客服帐号
修改客服帐号
获取客服帐号列表
获取客服帐号链接
接待人员管理
添加接待人员
删除接待人员
获取接待人员列表
会话分配与消息收发
分配客服会话
概述
分配客服会话-获取会话状态
分配客服会话-变更会话状态
接收消息和事件
概述
消息类型
接收消息和事件-读取消息
发送消息
发送欢迎语等事件响应消息
「升级服务」配置
什么是升级服务
「升级服务」配置-获取配置的专员与客户群
「升级服务」配置-为客户升级为专员服务
「升级服务」配置-为客户升级为客户群服务
「升级服务」配置-为客户取消推荐
其他基础信息获取
获取客户基础信息
获取企业状态信息-获取视频号绑定状态
统计管理
获取「客户数据统计」企业汇总数据
获取「客户数据统计」接待人员明细数据
企业支付
对外收款
概述
获取收款项目的商户单号
获取对外收款记录
家校沟通
概述
接入指引
基础接口
获取「学校通知」二维码
管理「学校通知」的关注模式-设置关注「学校通知」的模式
管理「学校通知」的关注模式-获取关注「学校通知」的模式
发送「学校通知」
获取外部联系人详情
外部联系人openid转换
手机号转外部联系人ID
管理「老师可查看班级」模式-设置「老师可查看班级」的模式
管理「老师可查看班级」模式-获取「老师可查看班级」的模式
获取可使用的家长范围
网页授权登录
开始开发
构造网页授权链接
获取家校访问用户身份
获取 访问用户身份
学生与家长管理
创建学生
删除学生
更新学生
批量创建学生
批量删除学生
批量更新学生
创建家长
删除家长
更新家长
批量创建家长
批量删除家长
批量更新家长
读取学生或家长
获取部门成员详情
设置家校通讯录自动同步模式
获取部门家长详情
部门管理
标准年级对照表
创建部门
更新部门
删除部门
获取部门列表
修改自动升年级的配置
家校通讯录变更回调
成员变更事件
部门变更事件
家校应用
上课直播
获取观看直播统计V2
获取未观看直播统计V2
获取老师直播ID列表
获取直播详情
获取观看直播统计
获取未观看直播统计
删除直播回放
班级收款
获取学生付款结果
获取订单详情
办公
邮件
概述
回调通知
发送邮件
发送普通邮件
发送日程邮件
发送会议邮件
获取接收的邮件
获取收件箱邮件列表
获取邮件内容
管理应用邮箱账号
更新应用邮箱帐号
查询应用邮箱帐号
文档
概述
管理文档
新建文档
重命名文档/收集表
删除文档/收集表
获取文档基础信息
分享文档
设置文档权限信息
获取文档权限信息
修改文档查看规则
修改文档通知范围及权限
修改文档安全设置
管理收集表
创建收集表
编辑收集表
收集表的统计信息查询
读取收集表答 案
获取收集表信息
回调通知
概述
修改文档成员事件
删除文档事件
收集表完成事件
日程
概述
管理日历
日历接口 创建日历
日历接口 更新日历
日历接口 获取日历详情
日历接口 删除日历
管理日程
更新重复日程
日程接口 创建日程
日程接口更新日程
新增日程参与者
删除日程参与者
日程接口 获取日历下的日程列表
日程接口 获取日程详情
日程接口 取消日程
回调通知
概述
删除日历事件
修改日历事件
修改日程事件
删除日程事件
会议
回调通知
概述
创建预约会议
修改预约会议
取消预约会议
获取成员会议ID列表
获取会议详情
微盘
直播
概述
直播回调事件
创建预约直播
修改预约直播
取消预约直播
删除直播回放
在微信中观看直播或直播回放
获取成员直播ID列表
获取直播详情
获取直播观看明细
获取跳转小程序商城的直播观众信息
打卡
获取员工打卡规则
获取打卡记录数据
获取打卡日报数据
获取打卡月报数据
获取打卡人员排班信息
为打卡人员排班
获取设备打卡数据
审批
审批流程引擎
概述
审批申请状态变化回调通知
复制/更新模板到企业
获取审批模板详情
提交审批申请
批量获取审批单号
获取审批申请详情
获取企业假期管理配置
获取成员假期余额
修改成员假期余额
智慧硬件
概述
接口调用
获取硬件授权结果
获取考勤打卡原始数据
获取温度检测原始数据
获取门禁通行原始数据
读取门禁通行规则
写入门禁通行规则
修改门禁通行规则
删除门禁通行规则
回调通知
设备数据授权变更回调
考勤打卡原始数据回调
门禁通行原始数据回调
体温检测原始数据回调
功能概述
复制页面
概述
概述
#
企业微信在桌面端「服务商助手」及「服务商后台」中向服务商提供了「收银台」功能,帮助服务商更加便捷的进行应用的销售,及相关订单和收入的管理。
服务商可开通商户号,实现企业客户购买应用的收款。资金T+12(包括10天企业退款冻结期)即可提现到服务商银行账户。
商户号
#
服务商需要在企业微信平台,分别开通微信支付、商企付两个商户号(微信支付和商企付商户号的支付服务均由财付通提供)。
其中微信支付商户号用于收款企业客户通过微信支付的资金,商企付商户号用于收款企业通过网银B2B转账的资金。两个商户号的开通、收款、退款、提现完全独立。
服务商在企业微信平台开通的商户号,是企业微信平台的子商户号。若服务商之前已在微信支付或商企付开通过其他商户号,与在企业微信平台开通的商户号并不冲突,是完全独立的,不支持之前开通的商户号与在企业微信平台开通的商户号合并。
收银台
#
企业微信服务商助手-收银台,提供给服务商管理所有客户订单、进行收益提现等功能。包含如下几个功能模块:
收款:创建收款订单并管理所有待付款订单。
订单管理:查看并管理服务商的所有客户订单。包括第三方应用订单、代开发应用订单、行业方案订单。
退款管理:处理客户的退款申请。
发票管理:处理客户的开票申请。
商户号管理:开通并管理用于收款的商户号。
收入数据:查看商户号收入统计与明细。
提现:提现到银行账户。
1、收款
#
创建收款订单
#
1.
服务商帮助客户选择所需要购买的第三方应用/代开发应用/行业方案。
2.
配置购买的人数和时长。(可选,非必须配置)
3.
创建订单并获取支付链接/二维码,可发送给客户进行支付。
管理待付款订单
#
展示所有已创建的待支付订单,区分客户下单/服务商创建两个列表。
服务商可点击查看订单详情并可获取支付二维码/链接发送给客户进行支付。
针对客户下单的订单,服务商可进行改价,最低折扣为原价的7折。
2、订单管理
#
订单列表
#
展示服务商的所有客户订单(测试授权订单除外),可进行搜索和筛选。
导出订单:导出当前筛选条件下的所有订单。
测试授权订单
#
展示所有服务商的测试授权订单
订单状态
#
1.
待支付状态
待支付状态下,用户支付完成,订单状态变为:已支付。
待支付状态订单支付有效期为10天,订单创建时间10天后未支付,自动取消。取消后订单状态变为:交易关闭-支付过期。
待支付状态下,用户可主动操作取消订单,取消后订单状态变为:交易关闭-订单取消。
订单来源为“服务商创建”时:服务商可操作取消订单、获取订单支付链接/二维码。
订单来源为“客户创建”时:服务商可操作改价、获取订单支付链接/二维码
1.
已支付状态
用户付款后订单进入已支付状态,此时用户的款项处于冻结期。
冻结期默认为10天,冻结期过后款项经过分账,属于服务商收入的部分进入服务商商户号。
冻结期内用户可以发起退款申请,只能发起一次。
1.
交易关闭-支付过期
订单创建时间10天后未支付,自动取消。取消后订单状态变为:交易关闭-支付过期。
交易关闭-支付过期状态为最终状态,不可操作。
1.
交易关闭-订单取消
待支付状态下,用户可主动操作取消订单,取消后订单状态变为:交易关闭-订单取消。
交易关闭-订单取消状态为最终状态,不可操作。
1.
退款申请中状态
已支付的订单,用户可以在10天内发起退款申请。
用户发起退款申请后,服务商需要在5天内处理完成,否则系统自动同意退款。
服务商只可操作“同意退款”,如该笔订单不需要退款,可与客户协商让客户侧取消退款。
1.
交易关闭-已退款状态
同意退款/超时自动退款后,订单流转为交易关闭-已退款的状态。
同意退款/超时自动退款后,用户支付的款项通过原支付渠道返回给用户。
详情页面展示退款申请及退款审核信息。
1.
交易完成状态
订单款项过了冻结期进入服务商商户号时,该笔订单流转为“交易完成”状态。
交易完成状态的订单详情页展示收入到账的明细信息。
3、退款管理
#
退款申请列表
#
列表展示所有“退款申请中”状态的客户订单,可进行搜索。
可进入具体订单详情页面进行退款处理。
退款处理记录
#
展示所有已处理的订单退款申请,可进行退款状态的筛选。
4、发票管理
#
待开票列表
#
交易完成状态的订单,用户可以发起开票申请。发起申请后进入待开票列表。
可查看对应订单详情及发票信息。
开票完成后需要“标记为已开票”并录入开票信息,标记后进入已开票列表
已开票列表
#
可查看已开票订单的订单详情、发票信息。
可查看开票信息,包括开票备注、操作人、操作时间。
5、商户号管理
#
可查看交易手续费说明及已开通的商户号信息。
可在线修改微信支付商户的银行账户。
可联系客服修改商企付商户的银行账户。
6、收入数据
#
可查看商户号的收入统计数据及收入明细数据。
收入统计数据包括服务商商户号昨日、当日、本周、本月的到账金额。同时提供周维度的收入趋势图供查看。
收入明细数据呈现了每笔订单的收入到账数据,可筛选及导出。默认展示当月的收入明细。
7、提现管理
#
提现管理包括商户金额总览及提现记录两个模块。
商户金额总览模块包括可提现金额(已经解冻并进入服务商商户号内的金额)及冻结中的金额。
提现记录模块呈现了从商户号中提现到银行卡的每一笔提现明细。可筛选及导出。
【企业微信】API开发者 微信交流群
用微信扫右侧二维码,加入【企业微信】API开发者 交流群,互助沟通
扫码加入交流群
修改于
2022-12-05 07:51:27
上一页
接入指引
下一页
商户号开通