企业微信 API
企业内部开发第三方应用开发智慧硬件开发
企业内部开发第三方应用开发智慧硬件开发
  1. 发送应用消息
  • 开发指南
    • 开发前必读
    • 基本概念介绍
    • 回调配置
      • 回调配置
      • 回调配置-支持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段
      • 发送应用消息
        • 消息类型
        • 发送应用消息
          POST
      • 更新模版卡片消息
        POST
      • 撤回应用消息
        POST
    • 应用管理
      • 获取应用
        • 获取应用-获取指定的应用详情
        • 获取应用-获取access_token对应的应用列表
      • 设置工作台自定义展示
        • 模版类型数据结构
        • 修改设置工作台自定义开关事件推送
        • 设置工作台自定义展示-设置应用在工作台展示的模版
        • 设置工作台自定义展示-获取应用在工作台展示的模版
        • 设置工作台自定义展示-设置应用在用户工作台展示的数据
    • 素材管理
      • 概述
      • 异步上传临时素材
        • 概述
        • 回调异步任务结果
        • 生成异步上传任务
        • 查询异步任务结果
      • 上传临时素材
      • 上传图片
      • 获取临时素材
      • 获取高清语音素材
    • 电子发票
      • 概述
      • 查询电子发票
      • 更新发票状态
      • 批量更新发票状态
      • 批量查询电子发票
  • 连接微信
    • 客户联系
      • 概述
      • 成员对外信息
      • 企业服务人员管理
        • 获取配置了客户联系功能的成员列表
        • 客户联系「联系我」管理-配置客户联系「联系我」方式
        • 客户联系「联系我」管理-更新企业已配置的「联系我」方式
        • 客户联系「联系我」管理-获取企业已配置的「联系我」方式
        • 客户联系「联系我」管理-获取企业已配置的「联系我」列表
        • 客户联系「联系我」管理-删除企业已配置的「联系我」方式
        • 客户联系「联系我」管理-结束临时会话
      • 客户管理
        • 获取客户列表
        • 获取客户详情
        • 批量获取客户详情
        • 修改客户备注信息
        • 企业主体unionid转换为第三方external_userid
        • 第三方主体unionid转换为第三方external_userid
        • 代开发应用external_userid转换
      • 客户标签管理
        • 管理企业标签
          • 说明
          • 管理企业标签-获取企业标签库
          • 管理企业标签-添加企业客户标签
          • 管理企业标签-编辑企业客户标签
          • 管理企业标签-删除企业客户标签
        • 编辑客户企业标签
      • 在职继承
        • 分配在职成员的客户
        • 查询客户接替状态
        • 分配在职成员的客户群
      • 离职继承
        • 获取待分配的离职成员列表
        • 分配离职成员的客户
        • 查询客户接替状态
        • 分配离职成员的客户群
      • 客户群管理
        • 获取客户群列表
        • 获取客户群详情
        • 客户群opengid转换
      • 联系我与客户入群方式
        • 权限说明
        • 结束语定义
        • 配置客户联系「联系我」方式
        • 获取企业已配置的「联系我」方式
        • 获取企业已配置的「联系我」列表
        • 更新企业已配置的「联系我」方式
        • 删除企业已配置的「联系我」方式
        • 结束临时会话
      • 客户朋友圈
        • 概述
        • 企业发表内容到客户的朋友圈
          • 企业发表内容到客户的朋友圈-创建发表任务
          • 企业发表内容到客户的朋友圈-获取任务创建结果
        • 获取客户朋友圈全部的发表记录
          • 获取客户朋友圈全部的发表记录-获取企业全部的发表列表
          • 获取客户朋友圈全部的发表记录-获取客户朋友圈企业发表的列表
          • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表时选择的可见范围
          • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表后的可见客户列表
          • 获取客户朋友圈全部的发表记录-获取客户朋友圈的互动数据
        • 停止发表企业朋友圈
      • 消息推送
        • 获取企业的全部群发记录
          • 概述
          • 获取企业的全部群发记录-获取群发记录列表
          • 获取企业的全部群发记录-获取群发成员发送任务列表
          • 获取企业的全部群发记录-获取企业群发成员执行结果
        • 创建企业群发
        • 提醒成员群发
        • 停止企业群发
        • 发送新客户欢迎语
        • 入群欢迎语素材管理-添加
        • 入群欢迎语素材管理-编辑
        • 入群欢迎语素材管理-获取
        • 入群欢迎语素材管理-删除
      • 统计管理
        • 获取「联系客户统计」数据
        • 获取「群聊数据统计」数据-按群主聚合的方式
        • 获取「群聊数据统计」数据-按自然日聚合的方式
      • 回调通知
        • 事件格式
      • 管理商品图册
        • 概述
        • 创建商品图册
        • 获取商品图册
        • 删除商品图册
        • 获取商品图册列表
        • 编辑商品图册
      • 管理聊天敏感词
        • 概述
        • 管理聊天敏感词-新建敏感词规则
        • 管理聊天敏感词-获取敏感词规则列表
        • 管理聊天敏感词-获取敏感词规则详情
        • 管理聊天敏感词-修改敏感词规则
        • 管理聊天敏感词 删除敏感词规则
      • 上传附件资源
    • 微信客服
      • 概述
      • 回调通知
      • 客服帐号管理
        • 添加客服帐号
        • 删除客服帐号
        • 修改客服帐号
        • 获取客服帐号列表
        • 获取客服帐号链接
      • 接待人员管理
        • 添加接待人员
        • 删除接待人员
        • 获取接待人员列表
      • 会话分配与消息收发
        • 分配客服会话
          • 概述
          • 分配客服会话-获取会话状态
          • 分配客服会话-变更会话状态
        • 接收消息和事件
          • 概述
          • 消息类型
          • 接收消息和事件-读取消息
        • 发送消息
        • 发送欢迎语等事件响应消息
      • 「升级服务」配置
        • 什么是升级服务
        • 「升级服务」配置-获取配置的专员与客户群
        • 「升级服务」配置-为客户升级为专员服务
        • 「升级服务」配置-为客户升级为客户群服务
        • 「升级服务」配置-为客户取消推荐
      • 其他基础信息获取
        • 获取客户基础信息
        • 获取企业状态信息-获取视频号绑定状态
      • 统计管理
        • 获取「客户数据统计」企业汇总数据
        • 获取「客户数据统计」接待人员明细数据
    • 企业支付
      • 对外收款
        • 概述
        • 获取收款项目的商户单号
        • 获取对外收款记录
    • 家校沟通
      • 概述
      • 接入指引
      • 基础接口
        • 获取「学校通知」二维码
        • 管理「学校通知」的关注模式-设置关注「学校通知」的模式
        • 管理「学校通知」的关注模式-获取关注「学校通知」的模式
        • 发送「学校通知」
        • 获取外部联系人详情
        • 外部联系人openid转换
        • 手机号转外部联系人ID
        • 管理「老师可查看班级」模式-设置「老师可查看班级」的模式
        • 管理「老师可查看班级」模式-获取「老师可查看班级」的模式
        • 获取可使用的家长范围
      • 网页授权登录
        • 开始开发
        • 构造网页授权链接
        • 获取家校访问用户身份
        • 获取访问用户身份
      • 学生与家长管理
        • 创建学生
        • 删除学生
        • 更新学生
        • 批量创建学生
        • 批量删除学生
        • 批量更新学生
        • 创建家长
        • 删除家长
        • 更新家长
        • 批量创建家长
        • 批量删除家长
        • 批量更新家长
        • 读取学生或家长
        • 获取部门成员详情
        • 设置家校通讯录自动同步模式
        • 获取部门家长详情
      • 部门管理
        • 标准年级对照表
        • 创建部门
        • 更新部门
        • 删除部门
        • 获取部门列表
        • 修改自动升年级的配置
      • 家校通讯录变更回调
        • 成员变更事件
        • 部门变更事件
    • 家校应用
      • 上课直播
        • 获取观看直播统计V2
        • 获取未观看直播统计V2
        • 获取老师直播ID列表
        • 获取直播详情
        • 获取观看直播统计
        • 获取未观看直播统计
        • 删除直播回放
      • 班级收款
        • 获取学生付款结果
        • 获取订单详情
  • 办公
    • 邮件
      • 概述
      • 回调通知
      • 发送邮件
        • 发送普通邮件
        • 发送日程邮件
        • 发送会议邮件
      • 获取接收的邮件
        • 获取收件箱邮件列表
        • 获取邮件内容
      • 管理应用邮箱账号
        • 更新应用邮箱帐号
        • 查询应用邮箱帐号
    • 文档
      • 概述
      • 管理文档
        • 新建文档
        • 重命名文档/收集表
        • 删除文档/收集表
        • 获取文档基础信息
        • 分享文档
      • 设置文档权限信息
        • 获取文档权限信息
        • 修改文档查看规则
        • 修改文档通知范围及权限
        • 修改文档安全设置
      • 管理收集表
        • 创建收集表
        • 编辑收集表
        • 收集表的统计信息查询
        • 读取收集表答案
        • 获取收集表信息
      • 回调通知
        • 概述
        • 修改文档成员事件
        • 删除文档事件
        • 收集表完成事件
    • 日程
      • 概述
      • 管理日历
        • 日历接口 创建日历
        • 日历接口 更新日历
        • 日历接口 获取日历详情
        • 日历接口 删除日历
      • 管理日程
        • 更新重复日程
        • 日程接口 创建日程
        • 日程接口更新日程
        • 新增日程参与者
        • 删除日程参与者
        • 日程接口 获取日历下的日程列表
        • 日程接口 获取日程详情
        • 日程接口 取消日程
      • 回调通知
        • 概述
        • 删除日历事件
        • 修改日历事件
        • 修改日程事件
        • 删除日程事件
    • 会议
      • 回调通知
      • 概述
      • 创建预约会议
      • 修改预约会议
      • 取消预约会议
      • 获取成员会议ID列表
      • 获取会议详情
    • 微盘
    • 直播
      • 概述
      • 直播回调事件
      • 创建预约直播
      • 修改预约直播
      • 取消预约直播
      • 删除直播回放
      • 在微信中观看直播或直播回放
      • 获取成员直播ID列表
      • 获取直播详情
      • 获取直播观看明细
      • 获取跳转小程序商城的直播观众信息
    • 打卡
      • 获取员工打卡规则
      • 获取打卡记录数据
      • 获取打卡日报数据
      • 获取打卡月报数据
      • 获取打卡人员排班信息
      • 为打卡人员排班
      • 获取设备打卡数据
    • 审批
      • 审批流程引擎
      • 概述
      • 审批申请状态变化回调通知
      • 复制/更新模板到企业
      • 获取审批模板详情
      • 提交审批申请
      • 批量获取审批单号
      • 获取审批申请详情
      • 获取企业假期管理配置
      • 获取成员假期余额
      • 修改成员假期余额
  • 智慧硬件
    • 概述
    • 接口调用
      • 获取硬件授权结果
      • 获取考勤打卡原始数据
      • 获取温度检测原始数据
      • 获取门禁通行原始数据
      • 读取门禁通行规则
      • 写入门禁通行规则
      • 修改门禁通行规则
      • 删除门禁通行规则
    • 回调通知
      • 设备数据授权变更回调
      • 考勤打卡原始数据回调
      • 门禁通行原始数据回调
      • 体温检测原始数据回调
  1. 发送应用消息

消息类型

文本消息#

请求示例:
参数说明:
参数是否必须说明
touser否指定接收消息的成员,成员ID列表(多个接收者用‘|’分隔,最多支持1000个)。 特殊情况:指定为"@all",则向该企业应用的全部成员发送
toparty否指定接收消息的部门,部门ID列表,多个接收者用‘|’分隔,最多支持100个。 当touser为"@all"时忽略本参数
totag否指定接收消息的标签,标签ID列表,多个接收者用‘|’分隔,最多支持100个。 当touser为"@all"时忽略本参数
msgtype是消息类型,此时固定为:text
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
content是消息内容,最长不超过2048个字节,超过将截断**(支持id转译)**
safe否表示是否是保密消息,0表示可对外分享,1表示不能分享且内容显示水印,默认为0
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0。仅第三方应用需要用到,企业自建应用可以忽略。
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时
touser、toparty、totag不能同时为空,后面不再强调。
文本消息展现:
img
特殊说明:
其中text参数的content字段可以支持换行、以及A标签,即可打开自定义的网页(可参考以上示例代码)(注意:换行符请用转义过的\n)

图片消息#

请求示例:
请求参数:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:image
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
media_id是图片媒体文件id,可以调用上传临时素材接口获取
safe否表示是否是保密消息,0表示可对外分享,1表示不能分享且内容显示水印,默认为0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

语音消息#

请求示例:
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:voice
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
media_id是语音文件id,可以调用上传临时素材接口获取
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

视频消息#

请求示例:
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:video
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
media_id是视频媒体文件id,可以调用上传临时素材接口获取
title否视频消息的标题,不超过128个字节,超过会自动截断
description否视频消息的描述,不超过512个字节,超过会自动截断
safe否表示是否是保密消息,0表示可对外分享,1表示不能分享且内容显示水印,默认为0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时
视频消息展现:
img

文件消息#

请求示例:
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:file
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
media_id是文件id,可以调用上传临时素材接口获取
safe否表示是否是保密消息,0表示可对外分享,1表示不能分享且内容显示水印,默认为0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时
文件消息展现:
img

文本卡片消息#

请求示例:
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:textcard
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
title是标题,不超过128个字节,超过会自动截断**(支持id转译)**
description是描述,不超过512个字节,超过会自动截断**(支持id转译)**
url是点击后跳转的链接。最长2048字节,请确保包含了协议头(http/https)
btntxt否按钮文字。 默认为“详情”, 不超过4个文字,超过自动截断。
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时
文本卡片消息展现 :
img
特殊说明:
卡片消息的展现形式非常灵活,支持使用br标签或者空格来进行换行处理,也支持使用div标签来使用不同的字体颜色,目前内置了3种文字颜色:灰色(gray)、高亮(highlight)、默认黑色(normal),将其作为div标签的class属性即可,具体用法请参考上面的示例。

图文消息#

请求示例:
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:news
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
articles是图文消息,一个图文消息支持1到8条图文
title是标题,不超过128个字节,超过会自动截断**(支持id转译)**
description否描述,不超过512个字节,超过会自动截断**(支持id转译)**
url否点击后跳转的链接。 最长2048字节,请确保包含了协议头(http/https),小程序或者url必须填写一个
picurl否图文消息的图片链接,最长2048字节,支持JPG、PNG格式,较好的效果为大图 1068455,小图150150。
appid否小程序appid,必须是与当前应用关联的小程序,appid和pagepath必须同时填写,填写后会忽略url字段
pagepath否点击消息卡片后的小程序页面,最长128字节,仅限本小程序内的页面。appid和pagepath必须同时填写,填写后会忽略url字段
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时
图文消息展现:
img

图文消息(mpnews)#

mpnews类型的图文消息,跟普通的图文消息一致,唯一的差异是图文内容存储在企业微信。
多次发送mpnews,会被认为是不同的图文,阅读、点赞的统计会被分开计算。
请求示例:
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:mpnews
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
articles是图文消息,一个图文消息支持1到8条图文
title是标题,不超过128个字节,超过会自动截断**(支持id转译)**
thumb_media_id是图文消息缩略图的media_id, 可以通过素材管理接口获得。此处thumb_media_id即上传接口返回的media_id
author否图文消息的作者,不超过64个字节
content_source_url否图文消息点击“阅读原文”之后的页面链接
content是图文消息的内容,支持html标签,不超过666 K个字节**(支持id转译)**
digest否图文消息的描述,不超过512个字节,超过会自动截断**(支持id转译)**
safe否表示是否是保密消息,0表示可对外分享,1表示不能分享且内容显示水印,2表示仅限在企业内分享,默认为0;注意仅mpnews类型的消息支持safe值为2,其他消息类型不支持
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

markdown消息#

目前仅支持markdown语法的子集
微工作台(原企业号)不支持展示markdown消息
请求示例:
示例效果:
img
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:markdown
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
content是markdown内容,最长不超过2048个字节,必须是utf8编码
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

小程序通知消息#

小程序通知消息只允许绑定了小程序的应用发送,之前,消息会通过统一的会话【小程序通知】发送给用户。
从2019年6月28日起,用户收到的小程序通知会出现在各个独立的应用中。
不支持@all全员发送
微工作台(原企业号)不支持展示小程序通知消息
请求示例:
示例效果:
img
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。
msgtype是消息类型,此时固定为:miniprogram_notice
appid是小程序appid,必须是与当前应用关联的小程序
page否点击消息卡片后的小程序页面,最长1024个字节,仅限本小程序内的页面。该字段不填则消息点击后不跳转。
title是消息标题,长度限制4-12个汉字**(支持id转译)**
description否消息描述,长度限制4-12个汉字**(支持id转译)**
emphasis_first_item否是否放大第一个content_item
content_item否消息内容键值对,最多允许10个item
key是长度10个汉字以内
value是长度30个汉字以内**(支持id转译)**
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

模板卡片消息#

投票选择型和多项选择型卡片仅企业微信3.1.12及以上版本支持
文本通知型、图文展示型和按钮交互型三种卡片仅企业微信3.1.6及以上版本支持(但附件下载功能仍需更新至3.1.12)
微工作台(原企业号)不支持展示模板卡片消息
3.1.18版本新增
1.
source字段支持设置字体颜色
2.
horizontal_content_list新增type 3,代表点击跳转成员详情(仅企业微信3.1.18及以上版本支持)
3.
新增action_menu(右上角菜单)(仅企业微信3.1.18及以上版本支持)
4.
quote_area(引用样式)、image_text_area(左图右文样式)、button_selection(按钮型卡片的下拉框样式)等字段
特殊说明
1.
仅有 按钮交互型、投票选择型、多项选择型 以及填写了action_menu字段的文本通知型、图文展示型的卡片支持回调更新或通过接口更新卡片。
2.
支持回调更新的卡片可支持用户点击触发交互事件,需要开发者设置的回调接口来处理回调事件,回调协议可见文档 模板卡片事件推送,注意 没有配置回调接口的应用不可发送支持回调的卡片。
3.
开发者的服务收到回调事件后,需要根据协议返回相应的数据以更新卡片,对应的协议见文档 更新模版卡片消息。
4.
此接口发送支持回调更新的卡片消息之后,返回的参数里会带上response_code,可使用response_code调用更新模版卡片消息接口,response_code 72小时内有效,且只能调用一次接口。

文本通知型#

img
{
    "touser" : "UserID1|UserID2|UserID3",
    "toparty" : "PartyID1 | PartyID2",
    "totag" : "TagID1 | TagID2",
    "msgtype" : "template_card",
    "agentid" : 1,
    "template_card" : {
        "card_type" : "text_notice",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信",
            "desc_color": 1
        },
        "action_menu": {
            "desc": "卡片副交互辅助文本说明",
            "action_list": [
                {"text": "接受推送", "key": "A"},
                {"text": "不再推送", "key": "B"}
            ]
        },
        "task_id": "task_id",
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "quote_area": {
            "type": 1,
            "url": "https://work.weixin.qq.com",
            "title": "企业微信的引用样式",
            "quote_text": "企业微信真好用呀真好用"
        },
        "emphasis_content": {
            "title": "100",
            "desc": "核心数据"
        },
        "sub_title_text" : "下载企业微信还能抢红包!",
        "horizontal_content_list" : [
            {
                "keyname": "邀请人",
                "value": "张三"
            },
            {
                "type": 1,
                "keyname": "企业微信官网",
                "value": "点击访问",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "keyname": "企业微信下载",
                "value": "企业微信.apk",
                "media_id": "文件的media_id"
            },
            {
                "type": 3,
                "keyname": "员工信息",
                "value": "点击查看",
                "userid": "zhangsan"
            }
        ],
        "jump_list" : [
            {
                "type": 1,
                "title": "企业微信官网",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "title": "跳转小程序",
                "appid": "小程序的appid",
                "pagepath": "/index.html"
            }
        ],
        "card_action": {
            "type": 2,
            "url": "https://work.weixin.qq.com",
            "appid": "小程序的appid",
            "pagepath": "/index.html"
        }
    },
    "enable_id_trans": 0,
    "enable_duplicate_check": 0,
    "duplicate_check_interval": 1800
}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:template_card
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
card_type是模板卡片类型,文本通知型卡片填写 "text_notice"
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url,来源图片的尺寸建议为72*72
source.desc否来源图片的描述,建议不超过20个字,(支持id转译)
source.desc_color否来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
action_menu否卡片右上角更多操作按钮
action_menu.desc否更多操作界面的描述
action_menu.action_list是操作列表,列表长度取值范围为 [1, 3]
action_menu.action_list.text是操作的描述文案
action_menu.action_list.key是操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
main_title.title否一级标题,建议不超过36个字,文本通知型卡片本字段非必填,但不可本字段和sub_title_text都不填,(支持id转译)
main_title.desc否标题辅助信息,建议不超过44个字,(支持id转译)
quote_area否引用文献样式
quote_area.type否引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
quote_area.url否点击跳转的url,quote_area.type是1时必填
quote_area.appid否点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
quote_area.pagepath否点击跳转的小程序的pagepath,quote_area.type是2时选填
quote_area.title否引用文献样式的标题
quote_area.quote_text否引用文献样式的引用文案
emphasis_content否关键数据样式
emphasis_content.title否关键数据样式的数据内容,建议不超过14个字
emphasis_content.desc否关键数据样式的数据描述内容,建议不超过22个字
sub_title_text否二级普通文本,建议不超过160个字,(支持id转译)
horizontal_content_list否二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
horizontal_content_list.type否链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
horizontal_content_list.keyname是二级标题,建议不超过5个字
horizontal_content_list.value否二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字,(支持id转译)
horizontal_content_list.url否链接跳转的url,horizontal_content_list.type是1时必填
horizontal_content_list.media_id否附件的media_id,horizontal_content_list.type是2时必填
horizontal_content_list.userid否成员详情的userid,horizontal_content_list.type是3时必填
jump_list否跳转指引样式的列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过3
jump_list.type否跳转链接类型,0或不填代表不是链接,1 代表跳转url,2 代表跳转小程序
jump_list.title是跳转链接样式的文案内容,建议不超过18个字
jump_list.url否跳转链接的url,jump_list.type是1时必填
jump_list.appid否跳转链接的小程序的appid,必须是与当前应用关联的小程序,jump_list.type是2时必填
jump_list.pagepath否跳转链接的小程序的pagepath,jump_list.type是2时选填
card_action是整体卡片的点击跳转事件,text_notice必填本字段
card_action.type是跳转事件类型,1 代表跳转url,2 代表打开小程序。text_notice卡片模版中该字段取值范围为[1,2]
card_action.url否跳转事件的url,card_action.type是1时必填
card_action.appid否跳转事件的小程序的appid,必须是与当前应用关联的小程序,card_action.type是2时必填
card_action.pagepath否跳转事件的小程序的pagepath,card_action.type是2时选填
task_id否任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节,填了action_menu字段的话本字段必填
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

图文展示型#

img
{
    "touser" : "UserID1|UserID2|UserID3",
    "toparty" : "PartyID1 | PartyID2",
    "totag" : "TagID1 | TagID2",
    "msgtype" : "template_card",
    "agentid" : 1,
    "template_card" : {
        "card_type" : "news_notice",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信",
            "desc_color": 1
        },
        "action_menu": {
            "desc": "卡片副交互辅助文本说明",
            "action_list": [
                {"text": "接受推送", "key": "A"},
                {"text": "不再推送", "key": "B"}
            ]
        },
        "task_id": "task_id",
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "quote_area": {
            "type": 1,
            "url": "https://work.weixin.qq.com",
            "title": "企业微信的引用样式",
            "quote_text": "企业微信真好用呀真好用"
        },
        "image_text_area": {
            "type": 1,
            "url": "https://work.weixin.qq.com",
            "title": "企业微信的左图右文样式",
            "desc": "企业微信真好用呀真好用",
            "image_url": "https://img.iplaysoft.com/wp-content/uploads/2019/free-images/free_stock_photo_2x.jpg"
        },
        "card_image": {
            "url": "图片的url",
            "aspect_ratio": 1.3
        },
        "vertical_content_list": [
            {
                "title": "惊喜红包等你来拿",
                "desc": "下载企业微信还能抢红包!"
            }
        ],
        "horizontal_content_list" : [
            {
                "keyname": "邀请人",
                "value": "张三"
            },
            {
                "type": 1,
                "keyname": "企业微信官网",
                "value": "点击访问",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "keyname": "企业微信下载",
                "value": "企业微信.apk",
                "media_id": "文件的media_id"
            },
            {
                "type": 3,
                "keyname": "员工信息",
                "value": "点击查看",
                "userid": "zhangsan"
            }
        ],
        "jump_list" : [
            {
                "type": 1,
                "title": "企业微信官网",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "title": "跳转小程序",
                "appid": "小程序的appid",
                "pagepath": "/index.html"
            }
        ],
        "card_action": {
            "type": 2,
            "url": "https://work.weixin.qq.com",
            "appid": "小程序的appid",
            "pagepath": "/index.html"
        }
    },
    "enable_id_trans": 0,
    "enable_duplicate_check": 0,
    "duplicate_check_interval": 1800
}
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:template_card
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
card_type是模板卡片类型,图文展示型卡片此处填写 "news_notice"
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url,来源图片的尺寸建议为72*72
source.desc否来源图片的描述,建议不超过20个字,(支持id转译)
source.desc_color否来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
action_menu否卡片右上角更多操作按钮
action_menu.desc否更多操作界面的描述
action_menu.action_list是操作列表,列表长度取值范围为 [1, 3]
action_menu.action_list.text是操作的描述文案
action_menu.action_list.key是操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
main_title.title是一级标题,建议不超过36个字,(支持id转译)
main_title.desc否标题辅助信息,建议不超过44个字,(支持id转译)
quote_area否引用文献样式
quote_area.type否引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
quote_area.url否点击跳转的url,quote_area.type是1时必填
quote_area.appid否点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
quote_area.pagepath否点击跳转的小程序的pagepath,quote_area.type是2时选填
quote_area.title否引用文献样式的标题
quote_area.quote_text否引用文献样式的引用文案
image_text_area否左图右文样式,news_notice类型的卡片,card_image和image_text_area两者必填一个字段,不可都不填
image_text_area.type否左图右文样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
image_text_area.url否点击跳转的url,image_text_area.type是1时必填
image_text_area.appid否点击跳转的小程序的appid,必须是与当前应用关联的小程序,image_text_area.type是2时必填
image_text_area.pagepath否点击跳转的小程序的pagepath,image_text_area.type是2时选填
image_text_area.title否左图右文样式的标题
image_text_area.desc否左图右文样式的描述
image_text_area.image_url是左图右文样式的图片url
card_image否图片样式,news_notice类型的卡片,card_image和image_text_area两者必填一个字段,不可都不填
card_image.url是图片的url
card_image.aspect_ratio否图片的宽高比,宽高比要小于2.25,大于1.3,不填该参数默认1.3
vertical_content_list否卡片二级垂直内容,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过4
vertical_content_list.title是卡片二级标题,建议不超过38个字
vertical_content_list.desc否二级普通文本,建议不超过160个字
horizontal_content_list否二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
horizontal_content_list.type否链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
horizontal_content_list.keyname是二级标题,建议不超过5个字
horizontal_content_list.value否二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字,(支持id转译)
horizontal_content_list.url否链接跳转的url,horizontal_content_list.type是1时必填
horizontal_content_list.media_id否附件的media_id,horizontal_content_list.type是2时必填
horizontal_content_list.userid否成员详情的userid,horizontal_content_list.type是3时必填
jump_list否跳转指引样式的列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过3
jump_list.type否跳转链接类型,0或不填代表不是链接,1 代表跳转url,2 代表跳转小程序
jump_list.title是跳转链接样式的文案内容,建议不超过18个字
jump_list.url否跳转链接的url,jump_list.type是1时必填
jump_list.appid否跳转链接的小程序的appid,必须是与当前应用关联的小程序,jump_list.type是2时必填
jump_list.pagepath否跳转链接的小程序的pagepath,jump_list.type是2时选填
card_action是整体卡片的点击跳转事件,news_notice必填本字段
card_action.type是跳转事件类型,1 代表跳转url,2 代表打开小程序。news_notice卡片模版中该字段取值范围为[1,2]
card_action.url否跳转事件的url,card_action.type是1时必填
card_action.appid否跳转事件的小程序的appid,必须是与当前应用关联的小程序,card_action.type是2时必填
card_action.pagepath否跳转事件的小程序的pagepath,card_action.type是2时选填
task_id否任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节,填了action_menu字段的话本字段必填
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

按钮交互型#

img
{
    "touser" : "UserID1|UserID2|UserID3",
    "toparty" : "PartyID1 | PartyID2",
    "totag" : "TagID1 | TagID2",
    "msgtype" : "template_card",
    "agentid" : 1,
    "template_card" : {
        "card_type" : "button_interaction",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信",
            "desc_color": 1
        },
        "action_menu": {
            "desc": "卡片副交互辅助文本说明",
            "action_list": [
                {"text": "接受推送", "key": "A"},
                {"text": "不再推送", "key": "B"}
            ]
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "quote_area": {
            "type": 1,
            "url": "https://work.weixin.qq.com",
            "title": "企业微信的引用样式",
            "quote_text": "企业微信真好用呀真好用"
        },
        "sub_title_text" : "下载企业微信还能抢红包!",
        "horizontal_content_list" : [
            {
                "keyname": "邀请人",
                "value": "张三"
            },
            {
                "type": 1,
                "keyname": "企业微信官网",
                "value": "点击访问",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "keyname": "企业微信下载",
                "value": "企业微信.apk",
                "media_id": "文件的media_id"
            },
            {
                "type": 3,
                "keyname": "员工信息",
                "value": "点击查看",
                "userid": "zhangsan"
            }
        ],
        "card_action": {
            "type": 2,
            "url": "https://work.weixin.qq.com",
            "appid": "小程序的appid",
            "pagepath": "/index.html"
        },
        "task_id": "task_id",
        "button_selection": {
            "question_key": "btn_question_key1",
            "title": "企业微信评分",
            "option_list": [
                {
                    "id": "btn_selection_id1",
                    "text": "100分"
                },
                {
                    "id": "btn_selection_id2",
                    "text": "101分"
                }
            ],
            "selected_id": "btn_selection_id1"
        },
        "button_list": [
            {
                "text": "按钮1",
                "style": 1,
                "key": "button_key_1"
            },
            {
                "text": "按钮2",
                "style": 2,
                "key": "button_key_2"
            }
        ]
    },
    "enable_id_trans": 0,
    "enable_duplicate_check": 0,
    "duplicate_check_interval": 1800
}
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:template_card
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
card_type是模板卡片类型,按钮交互型卡片填写"button_interaction"
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url,来源图片的尺寸建议为72*72
source.desc否来源图片的描述,建议不超过20个字,(支持id转译)
source.desc_color否来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
action_menu否卡片右上角更多操作按钮
action_menu.desc否更多操作界面的描述
action_menu.action_list是操作列表,列表长度取值范围为 [1, 3]
action_menu.action_list.text是操作的描述文案
action_menu.action_list.key是操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
main_title.title是一级标题,建议不超过36个字,(支持id转译)
main_title.desc否标题辅助信息,建议不超过44个字,(支持id转译)
quote_area否引用文献样式
quote_area.type否引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
quote_area.url否点击跳转的url,quote_area.type是1时必填
quote_area.appid否点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
quote_area.pagepath否点击跳转的小程序的pagepath,quote_area.type是2时选填
quote_area.title否引用文献样式的标题
quote_area.quote_text否引用文献样式的引用文案
sub_title_text否二级普通文本,建议不超过160个字,(支持id转译)
horizontal_content_list否二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
horizontal_content_list.type否链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
horizontal_content_list.keyname是二级标题,建议不超过5个字
horizontal_content_list.value否二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字,(支持id转译)
horizontal_content_list.url否链接跳转的url,horizontal_content_list.type是1时必填
horizontal_content_list.media_id否附件的media_id,horizontal_content_list.type是2时必填
horizontal_content_list.userid否成员详情的userid,horizontal_content_list.type是3时必填
card_action否整体卡片的点击跳转事件
card_action.type否跳转事件类型,0或不填代表不是链接,1 代表跳转url,2 代表打开小程序
card_action.url否跳转事件的url,card_action.type是1时必填
card_action.appid否跳转事件的小程序的appid,必须是与当前应用关联的小程序,card_action.type是2时必填
card_action.pagepath否跳转事件的小程序的pagepath,card_action.type是2时选填
task_id是任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节
button_selection.question_key是下拉式的选择器的key,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节
button_selection.title否下拉式的选择器左边的标题
button_selection.option_list是选项列表,下拉选项不超过 10 个,最少1个
button_selection.selected_id否默认选定的id,不填或错填默认第一个
button_selection.option_list.id是下拉式的选择器选项的id,用户提交后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
button_selection.option_list.text是下拉式的选择器选项的文案,建议不超过16个字
button_list是按钮列表,列表长度不超过6
button_list.type否按钮点击事件类型,0 或不填代表回调点击事件,1 代表跳转url
button_list.text是按钮文案,建议不超过10个字
button_list.style否按钮样式,目前可填1~4,不填或错填默认1
button_list.key否按钮key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复,button_list.type是0时必填
button_list.url否跳转事件的url,button_list.type是1时必填
备注:
按钮样式
img

投票选择型#

img
{
    "touser" : "UserID1|UserID2|UserID3",
    "toparty" : "PartyID1 | PartyID2",
    "totag" : "TagID1 | TagID2",
    "msgtype" : "template_card",
    "agentid" : 1,
    "template_card" : {
        "card_type" : "vote_interaction",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信"
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "task_id": "task_id",
        "checkbox": {
            "question_key": "question_key1",
            "option_list": [
                {
                    "id": "option_id1",
                    "text": "选择题选项1",
                    "is_checked": true
                },
                {
                    "id": "option_id2",
                    "text": "选择题选项2",
                    "is_checked": false
                }
            ],
            "mode": 1
        },
        "submit_button": {
            "text": "提交",
            "key": "key"
        }
    },
    "enable_id_trans": 0,
    "enable_duplicate_check": 0,
    "duplicate_check_interval": 1800
}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:template_card
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
card_type是模板卡片类型,投票选择型卡片填写"vote_interaction"
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url,来源图片的尺寸建议为72*72
source.desc否来源图片的描述,建议不超过20个字,(支持id转译)
main_title.title是一级标题,建议不超过16个字,(支持id转译)
main_title.desc否二级普通文本,建议不超过160个字,(支持id转译)
task_id是任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节
checkbox否选择题样式
checkbox.question_key是选择题key值,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节
checkbox.mode否选择题模式,单选:0,多选:1,不填默认0
checkbox.option_list是选项list,选项个数不超过 20 个,最少1个
checkbox.option_list.id是选项id,用户提交选项后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
checkbox.option_list.text是选项文案描述,建议不超过17个字
checkbox.option_list.is_checked是该选项是否要默认选中
submit_button否提交按钮样式
submit_button.text是按钮文案,建议不超过10个字,不填默认为提交
submit_button.key是提交按钮的key,会产生回调事件将本参数作为EventKey返回,最长支持1024字节
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

多项选择型#

img
{
    "touser" : "UserID1|UserID2|UserID3",
    "toparty" : "PartyID1 | PartyID2",
    "totag" : "TagID1 | TagID2",
    "msgtype" : "template_card",
    "agentid" : 1,
    "template_card" : {
        "card_type" : "multiple_interaction",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信"
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "task_id": "task_id",
        "select_list": [
            {
                "question_key": "question_key1",
                "title": "选择器标签1",
                "selected_id": "selection_id1",
                "option_list": [
                    {
                        "id": "selection_id1",
                        "text": "选择器选项1"
                    },
                    {
                        "id": "selection_id2",
                        "text": "选择器选项2"
                    }
                ]
            },
            {
                "question_key": "question_key2",
                "title": "选择器标签2",
                "selected_id": "selection_id3",
                "option_list": [
                    {
                        "id": "selection_id3",
                        "text": "选择器选项3"
                    },
                    {
                        "id": "selection_id4",
                        "text": "选择器选项4"
                    }
                ]
            }
        ],
        "submit_button": {
            "text": "提交",
            "key": "key"
        }
    },
    "enable_id_trans": 0,
    "enable_duplicate_check": 0,
    "duplicate_check_interval": 1800
}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
toparty否部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
totag否标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
msgtype是消息类型,此时固定为:template_card
agentid是企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
card_type是模板卡片类型,多项选择型卡片填写 "multiple_interaction"
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url,来源图片的尺寸建议为72*72
source.desc否来源图片的描述,建议不超过20个字,(支持id转译)
main_title.title是一级标题,建议不超过36个字,(支持id转译)
main_title.desc否标题辅助信息,建议不超过160个字,(支持id转译)
task_id是任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节
select_list是下拉式的选择器列表,multiple_interaction类型的卡片该字段不可为空,一个消息最多支持 3 个选择器
select_list.question_key是下拉式的选择器题目的key,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节,不可重复
select_list.title否下拉式的选择器上面的title
select_list.option_list是选项列表,下拉选项不超过 10 个,最少1个
select_list.selected_id否默认选定的id,不填或错填默认第一个
select_list.option_list.id是下拉式的选择器选项的id,用户提交选项后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
select_list.option_list.text是下拉式的选择器选项的文案,建议不超过16个字
submit_button是提交按钮样式
submit_button.text是按钮文案,建议不超过10个字,不填默认为提交
submit_button.key是提交按钮的key,会产生回调事件将本参数作为EventKey返回,最长支持1024字节
enable_id_trans否表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check否表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval否表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

附录#

支持的markdown语法#

目前应用消息中支持的markdown语法是如下的子集:
1.
标题 (支持1至6级标题,注意#与文字中间要有空格)
2.
加粗
3.
链接
4.
行内代码段(暂不支持跨行)
5.
引用
6.
字体颜色(只支持3种内置颜色)

id转译说明#

1.支持的消息类型和对应的字段
消息类型支持字段
文本(text)content
文本卡片(textcard)title、description
图文(news)title、description
图文(mpnews)title、digest、content
小程序通知(miniprogram_notice)title、description、content_item.value
模版消息(template_msg)value
模板卡片消息(template_card)source.desc、main_title.title、main_title.desc、sub_title_text、horizontal_content_list.value
2.id转译模版语法
其中 DEPARTMENT_ID 是数字类型的部门id,USERID 是成员帐号。
譬如,
将$departmentName=1$替换成部门id为1对应的部门名,如“企业微信部”;
将$userName=lisi007$替换成userid为lisi007对应的用户姓名,如“李四”;
将$userAlias=lisi007$替换成userid为lisi007对应的用户别名,如“lisi”;
若输入的模板不符合语法、不在权限范围内或无效的userid或者部门ID,则不替换该项内容,保留原样
转译userAlias时,如果用户没有别名,则不替换该项内容,保留原样

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

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

扫码加入交流群
上一页
概述-获取企业微信服务器的ip段
下一页
发送应用消息
Built with