企业微信 API
企业内部开发第三方应用开发智慧硬件开发
企业内部开发第三方应用开发智慧硬件开发
  1. 企业红包
  • 快速入门
    • 概述
    • 简易教程
  • 开发指南
    • 基本概念介绍
    • 开发前必读
    • 回调配置
      • 回调配置
      • 回调配置-支持Http Get请求验证URL有效性
      • 回调配置-支持Http Post请求接收业务数据
      • 回调配置-获取企业微信服务器的ip段
    • 自建应用与第三方应用的对接
      • userid转换
      • external_userid转换
    • 获取access_token
      GET
    • 获取企业微信API域名IP段
      GET
  • 通讯录管理
    • 概述
    • 通讯录同步接口调整
    • 成员管理
      • 创建成员
      • 读取成员
      • 更新成员
      • 删除成员
      • 批量删除成员
      • 获取部门成员
      • 获取部门成员详情
      • userid与openid互换-userid转openid
      • userid与openid互换-openid转userid
      • 二次验证
      • 邀请成员
      • 获取加入企业二维码
      • 手机号获取userid
      • 邮箱获取userid
      • 获取成员ID列表
    • 部门管理
      • 获取单个部门详情
      • 创建部门
      • 更新部门
      • 删除部门
      • 获取部门列表
      • 获取子部门ID列表
    • 标签管理
      • 创建标签
      • 更新标签名字
      • 删除标签
      • 获取标签成员
      • 增加标签成员
      • 删除标签成员
      • 获取标签列表
    • 异步批量接口
      • 概述
      • 增量更新成员
      • 全量覆盖成员
      • 全量覆盖部门
      • 获取异步任务结果
    • 通讯录回调通知
      • 概述
      • 成员变更通知
      • 部门变更通知
      • 标签变更通知
      • 异步任务完成通知
    • 互联企业
      • 获取应用的可见范围
      • 获取互联企业成员详细信息
      • 获取互联企业部门成员
      • 获取互联企业部门成员详情
      • 获取互联企业部门列表
    • 异步导出接口
      • 概述
      • 导出任务完成通知
      • 导出成员
      • 导出成员详情
      • 导出部门
      • 导出标签成员
      • 获取导出结果
  • 客户联系
    • 概述
    • 企业服务人员管理
      • 结束语定义
      • 附录
      • 获取配置了客户联系功能的成员列表
      • 客户联系「联系我」管理-配置客户联系「联系我」方式
      • 客户联系「联系我」管理-更新企业已配置的「联系我」方式
      • 客户联系「联系我」管理-获取企业已配置的「联系我」方式
      • 客户联系「联系我」管理-获取企业已配置的「联系我」列表
      • 客户联系「联系我」管理-删除企业已配置的「联系我」方式
      • 客户联系「联系我」管理-结束临时会话
    • 客户管理
      • 客户联系规则组管理
        • 客户联系规则组管理-获取规则组列表
        • 客户联系规则组管理-获取规则组详情
        • 客户联系规则组管理-获取规则组管理范围
        • 客户联系规则组管理-创建新的规则组
        • 客户联系规则组管理-编辑规则组及其管理范围
        • 客户联系规则组管理-删除规则组
      • 获取客户列表
      • 获取客户详情
      • 批量获取客户详情
      • 修改客户备注信息
    • 客户标签管理
      • 管理企业标签
        • 说明
        • 管理企业标签-获取企业标签库
        • 管理企业标签-添加企业客户标签
        • 管理企业标签-编辑企业客户标签
        • 管理企业标签-删除企业客户标签
      • 管理企业规则组下的客户标签
        • 管理企业规则组下的客户标签-获取指定规则组下的企业客户标签
        • 管理企业规则组下的客户标签-为指定规则组创建企业客户标签
        • 管理企业规则组下的客户标签-编辑指定规则组下的企业客户标签
        • 管理企业规则组下的客户标签-删除指定规则组下的企业客户标签
      • 编辑客户企业标签
    • 在职继承
      • 分配在职成员的客户
      • 查询客户接替状态
      • 分配在职成员的客户群
    • 离职继承
      • 获取待分配的离职成员列表
      • 分配离职成员的客户
      • 查询客户接替状态
      • 分配离职成员的客户群
    • 客户群管理
      • 获取客户群列表
      • 获取客户群详情
      • 客户群opengid转换
    • 联系我与客户入群方式
      • 客户联系「联系我」管理
        • 权限说明
        • 结束语定义
        • 配置客户联系「联系我」方式
        • 获取企业已配置的「联系我」方式
        • 获取企业已配置的「联系我」列表
        • 更新企业已配置的「联系我」方式
        • 删除企业已配置的「联系我」方式
        • 结束临时会话
      • 客户群「加入群聊」管理
        • 权限说明
        • 配置客户群进群方式
        • 获取客户群进群方式配置
        • 更新客户群进群方式配置
        • 删除客户群进群方式配置
    • 客户朋友圈
      • 概述
      • 企业发表内容到客户的朋友圈
        • 企业发表内容到客户的朋友圈-创建发表任务
        • 企业发表内容到客户的朋友圈-获取任务创建结果
      • 获取客户朋友圈全部的发表记录
        • 获取客户朋友圈全部的发表记录-获取企业全部的发表列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈企业发表的列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表时选择的可见范围
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表后的可见客户列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈的互动数据
      • 客户朋友圈规则组管理
        • 客户朋友圈规则组管理-获取规则组列表
        • 客户朋友圈规则组管理-获取规则组详情
        • 客户朋友圈规则组管理-获取规则组管理范围
        • 客户朋友圈规则组管理-创建新的规则组
        • 客户朋友圈规则组管理-编辑规则组及其管理范围
        • 客户朋友圈规则组管理-删除规则组
      • 停止发表企业朋友圈
    • 消息推送
      • 获取企业的全部群发记录
        • 概述
        • 获取企业的全部群发记录-获取群发记录列表
        • 获取企业的全部群发记录-获取群发成员发送任务列表
        • 获取企业的全部群发记录-获取企业群发成员执行结果
      • 创建企业群发
      • 发送新客户欢迎语
      • 入群欢迎语素材管理-添加
      • 入群欢迎语素材管理-编辑
      • 入群欢迎语素材管理-获取
      • 入群欢迎语素材管理-删除
      • 提醒成员群发
      • 停止企业群发
    • 统计管理
      • 获取「群聊数据统计」数据-按群主聚合的方式
      • 获取「群聊数据统计」数据-按自然日聚合的方式
      • 获取「联系客户统计」数据
    • 变更回调
      • 概述
      • 事件格式
    • 管理商品图册
      • 概述
      • 创建商品图册
      • 获取商品图册
      • 删除商品图册
      • 获取商品图册列表
      • 编辑商品图册
    • 管理聊天敏感词
      • 概述
      • 管理聊天敏感词-新建敏感词规则
      • 管理聊天敏感词-获取敏感词规则列表
      • 管理聊天敏感词-获取敏感词规则详情
      • 管理聊天敏感词-修改敏感词规则
      • 管理聊天敏感词 删除敏感词规则
    • 上传附件资源
      POST
  • 微信客服
    • 概述
    • 回调通知
    • 客服帐号管理
      • 添加客服帐号
      • 删除客服帐号
      • 修改客服帐号
      • 获取客服帐号列表
      • 获取客服帐号链接
    • 接待人员管理
      • 添加接待人员
      • 添加接待人员_v1
      • 删除接待人员
      • 获取接待人员列表
    • 会话分配与消息收发
      • 分配客服会话
        • 概述
        • 分配客服会话-获取会话状态
        • 分配客服会话-变更会话状态
      • 接收消息和事件-读取消息
      • 发送消息
      • 发送事件响应消息
    • 「升级服务」配置
      • 什么是升级服务
      • 「升级服务」配置-获取配置的专员与客户群
      • 「升级服务」配置-为客户升级为专员服务
      • 「升级服务」配置-为客户升级为客户群服务
      • 「升级服务」配置-为客户取消推荐
    • 其他基础信息获取
      • 获取客户基础信息
    • 统计管理
      • 获取「客户数据统计」接待人员明细数据
      • 获取「客户数据统计」企业汇总数据
    • 机器人管理
      • 知识库分组管理
        • 知识库分组管理
        • 添加分组
        • 删除分组
        • 修改分组
        • 获取分组列表
      • 知识库问答管理
        • 知识库问答管理
        • 附录-问答附件类型
        • 添加问答
        • 删除问答
        • 修改问答
        • 获取问答列表
  • 身份验证
    • 网页授权登录
      • 开始开发
      • 构造网页授权链接
      • 获取访问用户身份
      • 获取访问用户敏感信息
    • 扫码授权登录
      • 开始开发
      • 构造扫码登录链接
      • 获取访问用户身份
  • 应用管理
    • 概述
    • 自定义菜单
      • 说明
      • 创建菜单
      • 获取菜单
      • 删除菜单
    • 设置工作台自定义展示
      • 模版类型数据结构
      • 说明
      • 修改设置工作台自定义开关事件推送
      • 设置工作台自定义展示-设置应用在工作台展示的模版
      • 设置工作台自定义展示-获取应用在工作台展示的模版
      • 设置工作台自定义展示-设置应用在用户工作台展示的数据
    • 获取应用-获取指定的应用详情
    • 获取应用-获取access_token对应的应用列表
    • 设置应用
  • 消息推送
    • 概述
    • 接收消息与事件
      • 消息格式
      • 事件格式
      • 被动回复消息格式
      • 概述
        • 概述
        • 概述-验证URL有效性
        • 概述-使用接收消息
        • 概述-获取企业微信服务器的ip段
    • 发送消息到群聊会话
      • 概述
      • 创建群聊会话
      • 修改群聊会话
      • 获取群聊会话
      • 应用推送消息
    • 互联企业消息推送
      • 接受消息与事件
      • 发送应用消息
    • 家校消息推送
      • 发送「学校通知」
    • 发送应用消息
      • 消息类型
      • 发送应用消息
    • 更新模版卡片消息
    • 撤回应用消息
  • 素材管理
    • 概述
    • 异步上传临时素材
      • 回调异步任务结果
      • 查询异步任务结果
      • 生成异步上传任务
    • 上传临时素材
    • 上传图片
    • 获取临时素材
    • 获取高清语音素材
  • OA
    • 打卡
      • 获取企业所有打卡规则
      • 获取员工打卡规则
      • 获取打卡记录数据
      • 获取打卡日报数据
      • 获取打卡月报数据
      • 获取打卡人员排班信息
      • 为打卡人员排班
      • 录入打卡人员人脸信息
      • 获取设备打卡数据
      • 为打卡人员补卡
    • 审批
      • 概述
      • 审批申请状态变化回调通知
      • 审批流程引擎
        • 概述
        • 查询自建应用审批单当前状态
      • 获取审批模板详情
      • 提交审批申请
      • 批量获取审批单号
      • 获取审批申请详情
      • 获取审批数据(旧)
      • 获取企业假期管理配置
      • 获取成员假期余额
      • 修改成员假期余额
      • 创建审批模板
      • 更新审批模板
    • 汇报
      • 概述
      • 导出汇报文档
        • 生成导出任务
        • 查询导出结果
      • 批量获取汇报记录单号
      • 获取汇报记录详情
      • 获取汇报统计数据
    • 自建应用
      • 审批流程引擎
    • 会议室
      • 说明
      • 概述
      • 回调事件
      • 会议室管理
        • 会议室管理-添加会议室
        • 会议室管理-查询会议室
        • 会议室管理-编辑会议室
        • 会议室管理-删除会议室
      • 会议室预订管理
        • 附录
        • 会议室预定管理 查询会议室的预定信息
        • 会议室预定管理 预定会议室
        • 会议室预定管理 取消预定会议室
        • 会议室预定管理 根据会议ID查询会议室的预定信息
    • 紧急通知应用
      • 概述
      • 发起语音电话
      • 获取接听状态
  • 效率工具
    • 日程
      • 概述
      • 回调事件
      • 管理日历
        • 日历接口 创建日历
        • 日历接口 更新日历
        • 日历接口 获取日历详情
        • 日历接口 删除日历
      • 管理日程
        • 更新重复日程
        • 新增日程参与者
        • 删除日程参与者
        • 日程接口 获取日历下的日程列表
        • 日程接口 获取日程详情
        • 日程接口 取消日程
        • 日程接口 创建日程
        • 日程接口更新日程
    • 会议
      • 回调通知
      • 概述
      • 创建预约会议
      • 修改预约会议
      • 取消预约会议
      • 获取成员会议ID列表
      • 获取会议详情
    • 直播
      • 概述
      • 直播回调事件
      • 创建预约直播
      • 修改预约直播
      • 取消预约直播
      • 删除直播回放
      • 在微信中观看直播或直播回放
      • 获取成员直播ID列表
      • 获取直播详情
      • 获取直播观看明细
      • 获取跳转小程序商城的直播观众信息
    • 微盘
      • 概述
      • 管理空间
        • 空间管理 新建空间
        • 空间管理 重命名空间
        • 空间管理 解散空间
        • 空间管理 获取空间信息
      • 管理空间权限
        • 空间权限 添加成员/部门
        • 空间权限 移除成员/部门
        • 空间权限 安全设置
        • 空间权限 获取邀请链接
        • 空间权限 获取空间信息
      • 管理文件
        • 文件管理 获取文件列表
        • 文件管理 上传文件
        • 文件分块上传 分块上传初始化
        • 文件分块上传 分块上传文件
        • 文件分块上传 分块上传完成
        • 文件管理 下载文件
        • 文件管理 新建文件/微文档
        • 文件管理 重命名文件
        • 文件管理 移动文件
        • 文件管理 删除文件
        • 文件管理 文件信息
      • 管理文件权限
        • 文件权限 新增指定人
        • 文件权限 删除指定人
        • 文件权限 分享设置
        • 文件权限 获取分享链接
        • 获取文件权限信息
        • 修改文件安全设置
      • 版本和容量管理
        • 获取盘专业版信息
        • 获取盘容量信息
      • 回调通知
        • 概述
        • 微盘容量不足事件
        • 空间变更事件
        • 文件变更事件
        • 解散空间
        • 修改空间成员
        • 修改空间安全设置
    • 公费电话
      • 获取公费电话拨打记录
    • 邮件
      • 概述
      • 回调通知
      • 发送邮件
        • 发送普通邮件
        • 发送日程邮件
        • 发送会议邮件
      • 获取接收的邮件
        • 获取收件箱邮件列表
        • 获取邮件内容
      • 管理应用邮箱账号
        • 更新应用邮箱帐号
        • 查询应用邮箱帐号
      • 管理邮件群组
        • 创建邮件群组
        • 更新邮件群组
        • 删除邮件群组
        • 获取邮件群组详情
        • 模糊搜索邮件群组
      • 管理业务邮箱
        • 创建业务邮箱
        • 更新业务邮箱
        • 删除业务邮箱
        • 获取业务邮箱详情
        • 模糊搜索业务邮箱
      • 其他邮件客户端登录设置
        • 获取用户功能属性
        • 更改用户功能属性
      • 禁用/启用邮箱帐号
      • 获取邮件未读数
    • 文档
      • 概述
      • 管理文档
        • 新建文档
        • 重命名文档/收集表
        • 删除文档/收集表
        • 获取文档基础信息
        • 分享文档
      • 设置文档权限
        • 获取文档权限信息
        • 修改文档查看规则
        • 修改文档通知范围及权限
        • 修改文档安全设置
      • 管理收集表
        • 创建收集表
        • 编辑收集表
        • 获取收集表信息
        • 读取收集表答案
        • 收集表的统计信息查询
      • 回调通知
        • 概述
        • 修改文档成员事件
        • 删除文档事件
        • 收集表完成事件
  • 企业支付
    • 概述
    • 签名算法
    • 企业红包
      • 发放企业红包
        POST
      • 查询红包记录
        POST
    • 向员工付款
      • 向员工付款
      • 查询付款记录
    • 向员工收款
      • 向员工收款
    • 对外收款
      • 概述
      • 收款商户号管理 新增商户号
      • 收款商户号管理 查询商户号详情
      • 收款商户号管理 删除商户号
      • 收款商户号管理 设置商户号使用范围
      • 获取对外收款记录
      • 获取收款项目的商户单号
  • 企业互联
    • 概述
    • 获取应用共享信息
    • 获取下级企业的access_token
    • 获取下级企业的小程序session
  • 上下游
    • 概述
    • 上下游通讯管理
      • 获取上下游信息
        • 获取上下游列表
        • 获取上下游通讯录分组
        • 获取企业上下游通讯录分组下的企业详情列表
        • 获取企业上下游通讯录下的企业信息
        • 移除企业
      • 提交批量导入上下游联系人任务
      • 获取异步任务结果
    • 基础接口
      • 获取应用共享信息
      • 获取下级/下游企业的access_token
      • 获取下级/下游企业小程序session
      • 上下游企业应用获取微信用户的external_userid
    • 上下游规则
      • 获取对接规则id列表
      • 删除对接规则
      • 获取对接规则详情
      • 新增对接规则
      • 更新对接规则
    • 回调事件
      • 上下游变更回调
      • 异步任务完成通知
  • 会话内容存档
    • 概述
    • 使用前帮助
    • 开发案例演示
    • 常见问题解答
    • 客户同意进行聊天内容存档事件回调
    • 产生会话回调事件
    • 获取会话内容
      • 说明
      • 获取会话内容 获取机器人信息
    • 获取会话内容存档开启成员列表
    • 获取会话同意情况 群聊请求
    • 获取会话同意情况 单聊请求
    • 获取会话内容存档内部群信息
  • 电子发票
    • 概述
    • 查询电子发票
    • 更新发票状态
    • 批量更新发票状态
    • 批量查询电子发票
  • 家校沟通
    • 概述
    • 基础接口
      • 获取「学校通知」二维码
      • 管理「学校通知」的关注模式-设置关注「学校通知」的模式
      • 管理「学校通知」的关注模式-获取关注「学校通知」的模式
      • 发送「学校通知」
      • 外部联系人openid转换
      • 获取可使用的家长范围
    • 网页授权登录
      • 开始开发
      • 构造网页授权链接
      • 获取访问用户身份-企业内部开发
      • 获取家校访问用户身份
    • 学生与家长管理
      • 创建学生
      • 删除学生
      • 更新学生
      • 批量创建学生
      • 批量删除学生
      • 批量更新学生
      • 创建家长
      • 删除家长
      • 更新家长
      • 批量创建家长
      • 批量删除家长
      • 批量更新家长
      • 读取学生或家长
      • 获取部门成员详情
      • 设置家校通讯录自动同步模式
      • 获取部门家长详情
    • 部门管理
      • 标准年级对照表
      • 创建部门
      • 更新部门
      • 删除部门
      • 获取部门列表
      • 修改自动升年级的配置
    • 家校通讯录变更回调
      • 成员变更事件
      • 部门变更事件
  • 家校应用
    • 健康上报
      • 获取健康上报使用统计
      • 获取健康上报任务ID列表
      • 获取健康上报任务详情
      • 获取用户填写答案
    • 复学码
      • 获取老师健康信息
      • 获取学生健康信息
      • 获取师生健康码
    • 上课直播
      • 获取老师直播ID列表
      • 获取直播详情
      • 获取观看直播统计
      • 获取未观看直播统计
      • 删除直播回放
      • 获取观看直播统计V2
      • 获取未观看直播统计V2
    • 班级收款
      • 获取学生付款结果
      • 获取订单详情
  • 政民沟通
    • 配置网格结构
      • 概述
      • 添加网格
      • 编辑网格
      • 删除网格
      • 获取网格列表
      • 获取用户负责及参与的网格列表
    • 配置事件类别
      • 添加事件类别
      • 修改事件类别
      • 删除事件类别
      • 获取事件类别列表
    • 巡查上报
      • 概述
      • 获取配置的网格及网格负责人
      • 获取单位巡查上报数据统计
      • 获取个人巡查上报数据统计
      • 获取上报事件分类统计
      • 获取巡查上报事件列表
      • 获取巡查上报的事件详情信息
    • 居民上报
      • 获取配置的网格及网格负责人
      • 获取单位居民上报数据统计
      • 获取个人居民上报数据统计
      • 获取上报事件分类统计
      • 获取居民上报事件列表
      • 获取居民上报的事件详情信息
    • 防疫场所码
      • 概述
      • 获取场所码列表
      • 获取场所码上报问卷
      • 获取场所码上报明细
  1. 企业红包

发放企业红包

POST
https://api.mch.weixin.qq.com/mmpaymkttransfers/sendworkwxredpack
服务端API企业内部开发

API接口协议#

发放规则:
发送频率限制———默认1800/min
发送个数上限———默认1800/min
场景金额限制———默认红包金额为1-200元,如有需要,可前往商户平台进行设置和申请
其他限制———商户单日出资金额上限—100万元;单用户单日收款金额上限—1000元;单用户可领取红包个数上限—10个
注意事项:
红包金额大于200或者小于1元时,请求参数scene_id必传,参数说明见下文。
根据监管要求,新申请商户号使用现金红包需要满足两个条件:1、入驻时间超过90天 2、连续正常交易30天。
移动应用的appid无法使用红包接口。
当返回错误码为“SYSTEMERROR”时,请不要更换商户订单号,一定要使用原商户订单号重试,否则可能造成重复发放红包等资金风险。
XML具有可扩展性,因此返回参数可能会有新增,而且顺序可能不完全遵循此文档规范,如果在解析回包的时候发生错误,请商户务必不要换单重试,请商户联系客服确认红包发放情况。如果有新回包字段,会更新到此API文档中。
因为错误代码字段err_code的值后续可能会增加,所以商户如果遇到回包返回新的错误码,请商户务必不要换单重试,请商户联系客服确认红包发放情况。如果有新的错误码,会更新到此API文档中。
错误代码描述字段err_code_des只供人工定位问题时做参考,系统实现时请不要依赖这个字段来做自动化处理。
请商户在自身的系统中合理设置发放频次并做好并发控制,防范错付风险。
因商户自身系统设置存在问题导致的资金损失,由商户自行承担。
**是否需要证书:**是
**数据格式:**xml
证书使用详见:https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay.php?chapter=4_3
以下字段在return_code为SUCCESS的时候有返回:
字段名字段必填示例值类型说明
微信支付签名sign是C380BEC2BFD727A4B6845133519F3AD6String(32)微信支付签名
业务结果result_code是SUCCESSString(16)SUCCESS/FAIL
错误代码err_code否SYSTEMERRORString(32)错误码信息
错误代码描述err_code_des否系统错误String(128)结果信息描述
以下字段在return_code 和result_code都为SUCCESS的时候有返回:
字段名字段必填示例值类型说明
商户订单号mch_billno是1E+25String(28)商户订单号(每个订单号必须唯一)组成:mch_id+yyyymmdd+10位一天内不能重复的数字
商户号mch_id是10000098String(32)微信支付分配的商户号
公众账号appidwxappid是wx8888888888888888String(32)商户appid,接口传入的所有appid应该为公众号的appid(在mp.weixin.qq.com申请的),不能为APP的appid(在open.weixin.qq.com申请的)
用户openidre_openid是oxTWIuGaIt6gTKsQRLau2M0yL16EString(32)接受收红包的用户在wxappid下的openid
付款金额total_amount是1000int付款金额,单位分
微信单号send_listid是1E+29String(32)红包订单的微信单号
发送者名称sender_name是XX活动String(128)红包发送者名称(需要utf-8格式)
发送者头像sender_header_media_id是1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0String(128)发送者头像素材id,通过企业微信开放上传素材接口获取
错误码:
错误码错误描述原因解决方式
NO_AUTH发放失败,此请求可能存在风险,已被微信拦截用户账号异常,被拦截请提醒用户检查自身帐号是否异常。使用常用的活跃的微信号可避免这种情况。
SENDNUM_LIMIT该用户今日领取红包个数超过限制该用户今日领取红包个数超过你在微信支付商户平台配置的上限如有需要、请在微信支付商户平台-现金红包-产品设置中重新配置 【每日同一用户领取本商户红包不允许超过的个数】。
SENDAMOUNT_LIMIT您的商户号今日发放金额超过限制,如有需要请登录微信支付商户平台更改API安全配置商户今日发放的总金额超过您在微信支付商户平台配置的上限如有需要,请联系管理员在商户平台-现金红包-产品设置上调整单日发送金额上限。
RCVDAMOUNT_LIMIT该用户今日领取金额超过限制,如有需要请登录微信支付商户平台更改API安全配置该用户今日领取红包总金额超过您在微信支付商户平台配置的上限如有需要,请联系管理员在商户平台-现金红包-产品设置上调整单用户单日领取金额上限。
ILLEGAL_APPID非法appid,请确认是否为公众号的appid,不能为APP的appid错误传入了app的appid接口传入的所有appid应该为公众号的appid(在mp.weixin.qq.com申请的),不能为APP的appid(在open.weixin.qq.com申请的)。
MONEY_LIMIT红包金额发放限制发送红包金额不在限制范围内每个红包金额必须在默认额度内(默认大于1元,小于200元,可在产品设置中自行申请调高额度)
SEND_FAILED红包发放失败,请更换单号再重试该红包已经发放失败如果需要重新发放,请更换单号再发放
FATAL_ERRORopenid和原始单参数不一致更换了openid,但商户单号未更新请商户检查代码实现逻辑
CA_ERRORCA证书出错,请登录微信支付商户平台下载证书请求携带的证书出错到商户平台下载证书,请求带上证书后重试
SIGN_ERROR签名错误;企业微信签名失败1. 没有使用商户平台设置的商户API密钥进行加密(有可能之前设置过密钥,后来被修改了,没有使用新的密钥进行加密)。 2. 加密前没有按照文档进行参数排序(可参考文档)。 3. 把值为空的参数也进行了签名。可到(http://mch.weixin.qq.com/wiki/tools/signverify/ )验证。 4. 如果以上3步都没有问题,把请求串中(post的数据)里面中文都去掉,换成英文,试下,看看是否是编码问题。(post的数据要求是utf8) 5. 没有按照企业微信签名算法进行签名1. 到商户平台重新设置新的密钥后重试; 2. 检查请求参数把空格去掉重试; 3. 中文不需要进行encode,使用CDATA; 4. 按文档要求生成签名后再重试; 5. 检查企业微信支付应用secret是否和企业微信管理端支付应用的secret保持一致;检查参与企业微信签名的字段是否和签名算法里面的字段保持一直。
SYSTEMERROR请求已受理,请稍后使用原单号查询发放结果系统无返回明确发放结果使用原单号调用接口,查询发放结果,如果使用新单号调用接口,视为新发放请求
XML_ERROR输入xml参数格式错误请求的xml格式错误,或者post的数据为空检查请求串,确认无误后重试
FREQ_LIMIT超过频率限制,请稍后再试受频率限制请对请求做频率控制(可联系微信支付wxhongbao@tencent.com申请调高)
NOTENOUGH帐号余额不足,请到商户平台充值后再重试账户余额不足充值后重试
OPENID_ERRORopenid和appid不匹配openid和appid不匹配发红包的openid必须是本appid下的openid
PROCESSING请求已受理,请稍后使用原单号查询发放结果发红包流程正在处理二十分钟后查询,按照查询结果成功失败进行处理
PARAM_ERROR请求参数错误请求携带的字段非法(或者没填)请检查字段后重试;如果是重试请求,请与原单请求的金额保持一致。
NO_COMPETENCE商户号错误该商户号没有开通企业支付该商户号没有开通企业支付,请登录企业微信管理端,进入企业支付应用核对商户号是否正确
API_METHOD_CLOSED您的商户号API发放方式已关闭,请联系管理员在商户平台开启。商户API发放方式处于关闭状态请联系管理员在微信支付商户平台开启。
文档ID: 11543
原文档地址:
https://open.work.weixin.qq.com/api/doc/90000/90135/90275
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mch.weixin.qq.com/mmpaymkttransfers/sendworkwxredpack' \
--header 'Content-Type: application/xml' \
--data-raw '<xml>
    <nonce_str>5K8264ILTKCH16CQ2502SI8ZNMTM67VS</nonce_str>
    <sign>C380BEC2BFD727A4B6845133519F3AD6</sign>
    <mch_billno>123456</mch_billno>
    <mch_id>10000098</mch_id>
    <wxappid>wx8888888888888888</wxappid>
    <sender_name>XX活动</sender_name>
    <sender_header_media_id>1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0</sender_header_media_id>
    <re_openid>oxTWIuGaIt6gTKsQRLau2M0yL16E</re_openid>
    <total_amount>1000</total_amount>
    <wishing>感谢您参加猜灯谜活动,祝您元宵节快乐!</wishing>
    <act_name>猜灯谜抢红包活动</act_name>
    <remark>猜越多得越多,快来抢!</remark>
    <workwx_sign>99BCDAFF065A4B95628E3DB468A874A8</workwx_sign>
</xml>'
响应示例响应示例
<xml>
    <return_code><![CDATA[SUCCESS]]></return_code>
    <return_msg><![CDATA[ok]]></return_msg>
    <sign><![CDATA[C380BEC2BFD727A4B6845133519F3AD6]]></sign>
    <result_code><![CDATA[SUCCESS]]></result_code>
    <mch_billno><![CDATA[123456]]></mch_billno>
    <mch_id><![CDATA[10000098]]></mch_id>
    <wxappid><![CDATA[wx8888888888888888]]></wxappid>
    <re_openid><![CDATA[oxTWIuGaIt6gTKsQRLau2M0yL16E]]></re_openid>
    <total_amount><![CDATA[1000]]></total_amount>
    <send_listid><![CDATA[235785324578098]]></send_listid>
    <sender_name><![CDATA[XX活动]]></sender_name>
    <sender_header_media_id><![CDATA[1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0]]></sender_header_media_id>
</xml>

请求参数

Body 参数application/xml
nonce_str
string 
随机字符串
必需
随机字符串,不长于32位
sign
string 
微信支付签名
必需
参见“签名算法”
mch_billno
string 
商户订单号
必需
商户订单号(每个订单号必须唯一。取值范围:09,az,A~Z).接口根据商户订单号支持重入,如出现超时可再调用。组成参考:mch_id+yyyymmdd+10位一天内不能重复的数字
mch_id
string 
必需
微信支付分配的商户号
wxappid
string 
公众账号appid
必需
微信分配的公众账号ID(企业微信corpid即为此appId)。接口传入的所有appid应该为公众号的appid(在mp.weixin.qq.com申请的),不能为APP的appid(在open.weixin.qq.com申请的)。
sender_name
string 
发送者名称
可选
发送者名称
sender_header_media_id
string 
发送者头像
可选
发送者头像素材id,通过企业微信开放上传素材接口获取
re_openid
string 
必需
接受红包的用户.用户在wxappid下的openid。获取用户openid参见:http://work.weixin.qq.com/api/doc#11279
total_amount
string 
必需
金额,单位分,单笔最小金额默认为1元
wishing
string 
红包祝福语
必需
act_name
string 
项目名称
必需
remark
string 
备注信息
必需
workwx_sign
string 
企业微信签名
必需
scene_id
string 
必需
发放红包使用场景,红包金额大于200或者小于1元时必传 PRODUCT_1:商品促销 PRODUCT_2:抽奖 PRODUCT_3:虚拟物品兑奖 PRODUCT_4:企业内部福利 PRODUCT_5:渠道分润 PRODUCT_6:保险回馈 PRODUCT_7:彩票派奖 PRODUCT_8:税务刮奖
示例

返回响应

🟢200成功
application/xml
Body
return_code
string 
返回状态码
必需
SUCCESS/FAIL 此字段是通信标识,非交易标识,交易是否成功需要查看result_code来判断
return_msg
string 
可选
返回信息,如非空,为错误原因
sign
string 
微信支付签名
必需
result_code
string 
业务结果
必需
SUCCESS/FAIL
mch_billno
string 
必需
商户订单号(每个订单号必须唯一)组成:mch_id+yyyymmdd+10位一天内不能重复的数字
mch_id
string 
必需
微信支付分配的商户号
wxappid
string 
必需
商户appid,接口传入的所有appid应该为公众号的appid(在mp.weixin.qq.com申请的),不能为APP的appid(在open.weixin.qq.com申请的
re_openid
string 
必需
接受收红包的用户在wxappid下的openid
total_amount
string 
付款金额,单位分
必需
send_listid
string 
红包订单的微信单号
必需
sender_name
string 
必需
红包发送者名称(需要utf-8格式)
sender_header_media_id
string 
必需
发送者头像素材id,通过企业微信开放上传素材接口获取

【企业微信】API开发者 微信交流群

用微信扫右侧二维码,加入【企业微信】API开发者 交流群,互助沟通

扫码加入交流群
上一页
签名算法
下一页
查询红包记录
Built with