企业微信 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段
    • 发送消息到群聊会话
      • 概述
      • 创建群聊会话
      • 修改群聊会话
      • 获取群聊会话
      • 应用推送消息
    • 互联企业消息推送
      • 接受消息与事件
      • 发送应用消息
    • 家校消息推送
      • 发送「学校通知」
    • 发送应用消息
      • 消息类型
      • 发送应用消息
    • 更新模版卡片消息
      POST
    • 撤回应用消息
      POST
  • 素材管理
    • 概述
    • 异步上传临时素材
      • 回调异步任务结果
      • 查询异步任务结果
      • 生成异步上传任务
    • 上传临时素材
    • 上传图片
    • 获取临时素材
    • 获取高清语音素材
  • OA
    • 打卡
      • 获取企业所有打卡规则
      • 获取员工打卡规则
      • 获取打卡记录数据
      • 获取打卡日报数据
      • 获取打卡月报数据
      • 获取打卡人员排班信息
      • 为打卡人员排班
      • 录入打卡人员人脸信息
      • 获取设备打卡数据
      • 为打卡人员补卡
    • 审批
      • 概述
      • 审批申请状态变化回调通知
      • 审批流程引擎
        • 概述
        • 查询自建应用审批单当前状态
      • 获取审批模板详情
      • 提交审批申请
      • 批量获取审批单号
      • 获取审批申请详情
      • 获取审批数据(旧)
      • 获取企业假期管理配置
      • 获取成员假期余额
      • 修改成员假期余额
      • 创建审批模板
      • 更新审批模板
    • 汇报
      • 概述
      • 导出汇报文档
        • 生成导出任务
        • 查询导出结果
      • 批量获取汇报记录单号
      • 获取汇报记录详情
      • 获取汇报统计数据
    • 自建应用
      • 审批流程引擎
    • 会议室
      • 说明
      • 概述
      • 回调事件
      • 会议室管理
        • 会议室管理-添加会议室
        • 会议室管理-查询会议室
        • 会议室管理-编辑会议室
        • 会议室管理-删除会议室
      • 会议室预订管理
        • 附录
        • 会议室预定管理 查询会议室的预定信息
        • 会议室预定管理 预定会议室
        • 会议室预定管理 取消预定会议室
        • 会议室预定管理 根据会议ID查询会议室的预定信息
    • 紧急通知应用
      • 概述
      • 发起语音电话
      • 获取接听状态
  • 效率工具
    • 日程
      • 概述
      • 回调事件
      • 管理日历
        • 日历接口 创建日历
        • 日历接口 更新日历
        • 日历接口 获取日历详情
        • 日历接口 删除日历
      • 管理日程
        • 更新重复日程
        • 新增日程参与者
        • 删除日程参与者
        • 日程接口 获取日历下的日程列表
        • 日程接口 获取日程详情
        • 日程接口 取消日程
        • 日程接口 创建日程
        • 日程接口更新日程
    • 会议
      • 回调通知
      • 概述
      • 创建预约会议
      • 修改预约会议
      • 取消预约会议
      • 获取成员会议ID列表
      • 获取会议详情
    • 直播
      • 概述
      • 直播回调事件
      • 创建预约直播
      • 修改预约直播
      • 取消预约直播
      • 删除直播回放
      • 在微信中观看直播或直播回放
      • 获取成员直播ID列表
      • 获取直播详情
      • 获取直播观看明细
      • 获取跳转小程序商城的直播观众信息
    • 微盘
      • 概述
      • 管理空间
        • 空间管理 新建空间
        • 空间管理 重命名空间
        • 空间管理 解散空间
        • 空间管理 获取空间信息
      • 管理空间权限
        • 空间权限 添加成员/部门
        • 空间权限 移除成员/部门
        • 空间权限 安全设置
        • 空间权限 获取邀请链接
        • 空间权限 获取空间信息
      • 管理文件
        • 文件管理 获取文件列表
        • 文件管理 上传文件
        • 文件分块上传 分块上传初始化
        • 文件分块上传 分块上传文件
        • 文件分块上传 分块上传完成
        • 文件管理 下载文件
        • 文件管理 新建文件/微文档
        • 文件管理 重命名文件
        • 文件管理 移动文件
        • 文件管理 删除文件
        • 文件管理 文件信息
      • 管理文件权限
        • 文件权限 新增指定人
        • 文件权限 删除指定人
        • 文件权限 分享设置
        • 文件权限 获取分享链接
        • 获取文件权限信息
        • 修改文件安全设置
      • 版本和容量管理
        • 获取盘专业版信息
        • 获取盘容量信息
      • 回调通知
        • 概述
        • 微盘容量不足事件
        • 空间变更事件
        • 文件变更事件
        • 解散空间
        • 修改空间成员
        • 修改空间安全设置
    • 公费电话
      • 获取公费电话拨打记录
    • 邮件
      • 概述
      • 回调通知
      • 发送邮件
        • 发送普通邮件
        • 发送日程邮件
        • 发送会议邮件
      • 获取接收的邮件
        • 获取收件箱邮件列表
        • 获取邮件内容
      • 管理应用邮箱账号
        • 更新应用邮箱帐号
        • 查询应用邮箱帐号
      • 管理邮件群组
        • 创建邮件群组
        • 更新邮件群组
        • 删除邮件群组
        • 获取邮件群组详情
        • 模糊搜索邮件群组
      • 管理业务邮箱
        • 创建业务邮箱
        • 更新业务邮箱
        • 删除业务邮箱
        • 获取业务邮箱详情
        • 模糊搜索业务邮箱
      • 其他邮件客户端登录设置
        • 获取用户功能属性
        • 更改用户功能属性
      • 禁用/启用邮箱帐号
      • 获取邮件未读数
    • 文档
      • 概述
      • 管理文档
        • 新建文档
        • 重命名文档/收集表
        • 删除文档/收集表
        • 获取文档基础信息
        • 分享文档
      • 设置文档权限
        • 获取文档权限信息
        • 修改文档查看规则
        • 修改文档通知范围及权限
        • 修改文档安全设置
      • 管理收集表
        • 创建收集表
        • 编辑收集表
        • 获取收集表信息
        • 读取收集表答案
        • 收集表的统计信息查询
      • 回调通知
        • 概述
        • 修改文档成员事件
        • 删除文档事件
        • 收集表完成事件
  • 企业支付
    • 概述
    • 签名算法
    • 企业红包
      • 发放企业红包
      • 查询红包记录
    • 向员工付款
      • 向员工付款
      • 查询付款记录
    • 向员工收款
      • 向员工收款
    • 对外收款
      • 概述
      • 收款商户号管理 新增商户号
      • 收款商户号管理 查询商户号详情
      • 收款商户号管理 删除商户号
      • 收款商户号管理 设置商户号使用范围
      • 获取对外收款记录
      • 获取收款项目的商户单号
  • 企业互联
    • 概述
    • 获取应用共享信息
    • 获取下级企业的access_token
    • 获取下级企业的小程序session
  • 上下游
    • 概述
    • 上下游通讯管理
      • 获取上下游信息
        • 获取上下游列表
        • 获取上下游通讯录分组
        • 获取企业上下游通讯录分组下的企业详情列表
        • 获取企业上下游通讯录下的企业信息
        • 移除企业
      • 提交批量导入上下游联系人任务
      • 获取异步任务结果
    • 基础接口
      • 获取应用共享信息
      • 获取下级/下游企业的access_token
      • 获取下级/下游企业小程序session
      • 上下游企业应用获取微信用户的external_userid
    • 上下游规则
      • 获取对接规则id列表
      • 删除对接规则
      • 获取对接规则详情
      • 新增对接规则
      • 更新对接规则
    • 回调事件
      • 上下游变更回调
      • 异步任务完成通知
  • 会话内容存档
    • 概述
    • 使用前帮助
    • 开发案例演示
    • 常见问题解答
    • 客户同意进行聊天内容存档事件回调
    • 产生会话回调事件
    • 获取会话内容
      • 说明
      • 获取会话内容 获取机器人信息
    • 获取会话内容存档开启成员列表
    • 获取会话同意情况 群聊请求
    • 获取会话同意情况 单聊请求
    • 获取会话内容存档内部群信息
  • 电子发票
    • 概述
    • 查询电子发票
    • 更新发票状态
    • 批量更新发票状态
    • 批量查询电子发票
  • 家校沟通
    • 概述
    • 基础接口
      • 获取「学校通知」二维码
      • 管理「学校通知」的关注模式-设置关注「学校通知」的模式
      • 管理「学校通知」的关注模式-获取关注「学校通知」的模式
      • 发送「学校通知」
      • 外部联系人openid转换
      • 获取可使用的家长范围
    • 网页授权登录
      • 开始开发
      • 构造网页授权链接
      • 获取访问用户身份-企业内部开发
      • 获取家校访问用户身份
    • 学生与家长管理
      • 创建学生
      • 删除学生
      • 更新学生
      • 批量创建学生
      • 批量删除学生
      • 批量更新学生
      • 创建家长
      • 删除家长
      • 更新家长
      • 批量创建家长
      • 批量删除家长
      • 批量更新家长
      • 读取学生或家长
      • 获取部门成员详情
      • 设置家校通讯录自动同步模式
      • 获取部门家长详情
    • 部门管理
      • 标准年级对照表
      • 创建部门
      • 更新部门
      • 删除部门
      • 获取部门列表
      • 修改自动升年级的配置
    • 家校通讯录变更回调
      • 成员变更事件
      • 部门变更事件
  • 家校应用
    • 健康上报
      • 获取健康上报使用统计
      • 获取健康上报任务ID列表
      • 获取健康上报任务详情
      • 获取用户填写答案
    • 复学码
      • 获取老师健康信息
      • 获取学生健康信息
      • 获取师生健康码
    • 上课直播
      • 获取老师直播ID列表
      • 获取直播详情
      • 获取观看直播统计
      • 获取未观看直播统计
      • 删除直播回放
      • 获取观看直播统计V2
      • 获取未观看直播统计V2
    • 班级收款
      • 获取学生付款结果
      • 获取订单详情
  • 政民沟通
    • 配置网格结构
      • 概述
      • 添加网格
      • 编辑网格
      • 删除网格
      • 获取网格列表
      • 获取用户负责及参与的网格列表
    • 配置事件类别
      • 添加事件类别
      • 修改事件类别
      • 删除事件类别
      • 获取事件类别列表
    • 巡查上报
      • 概述
      • 获取配置的网格及网格负责人
      • 获取单位巡查上报数据统计
      • 获取个人巡查上报数据统计
      • 获取上报事件分类统计
      • 获取巡查上报事件列表
      • 获取巡查上报的事件详情信息
    • 居民上报
      • 获取配置的网格及网格负责人
      • 获取单位居民上报数据统计
      • 获取个人居民上报数据统计
      • 获取上报事件分类统计
      • 获取居民上报事件列表
      • 获取居民上报的事件详情信息
    • 防疫场所码
      • 概述
      • 获取场所码列表
      • 获取场所码上报问卷
      • 获取场所码上报明细
  1. 消息推送

更新模版卡片消息

POST
/cgi-bin/message/update_template_card
服务端API第三方应用开发企业内部开发
应用可以发送模板卡片消息,发送之后可再通过接口更新可回调的用户任务卡片消息的替换文案信息(仅原卡片为 按钮交互型、投票选择型、多项选择型的卡片以及填写了action_menu字段的文本通知型、图文展示型可以调用本接口更新)。
请注意,当应用调用发送模版卡片消息后,接口会返回一个response_code,通过response_code用户可以调用本接口一次。后续如果有用户点击任务卡片,回调接口也会带上response_code,开发者通过该code也可以调用本接口一次,注意response_code的有效期是24小时,超过24小时后将无法使用。

如果部分指定的用户无权限或不存在,更新仍然执行,但会返回无效的部分(即invaliduser),常见的原因是用户不在应用的可见范围内或者不在消息的接收范围内。#

更新按钮为不可点击状态#

可回调的卡片可以将按钮更新为不可点击状态,并且自定义文案
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "tagids" : [44,55],
    "atall" : 0,
    "agentid" : 1,
    "response_code": "response_code",
    "button":{
        "replace_name": "replace_name"
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
replace_name是需要更新的按钮的文案

更新为新的卡片#

可回调的卡片可以更新成任何一种模板卡片

文本通知型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "agentid" : 1,
    "response_code": "response_code",
    "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"}
            ]
        },
        "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"
        }
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,文本通知型卡片填写 “text_notice”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
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都不填
main_title.desc否标题辅助信息,建议不超过44个字
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个字
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个字
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是跳转事件类型,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时选填

图文展示型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "agentid" : 1,
    "response_code": "response_code",
    "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"}
            ]
        },
        "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"
        }
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,图文展示型卡片此处填写 “news_notice”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
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个字
main_title.desc否标题辅助信息,建议不超过44个字
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个字
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是跳转事件类型,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时选填

按钮交互型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "agentid" : 1,
    "response_code": "response_code",
    "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"
        },
        "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"
            }
        ],
        "replace_text": "已提交"
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,按钮交互型卡片填写”button_interaction”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
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个字
main_title.desc否标题辅助信息,建议不超过44个字
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个字
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个字
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时选填
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时必填
replace_text否按钮替换文案,填写本字段后会展现灰色不可点击按钮
备注:
按钮样式
img

投票选择型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "agentid" : 1,
    "response_code": "response_code",
    "template_card" : {
        "card_type" : "vote_interaction",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信"
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "checkbox": {
            "question_key": "question_key1",
            "option_list": [
                {
                    "id": "option_id1",
                    "text": "选择题选项1",
                    "is_checked": true
                },
                {
                    "id": "option_id2",
                    "text": "选择题选项2",
                    "is_checked": false
                }
            ],
            "disable": false,
            "mode": 1
        },
        "submit_button": {
            "text": "提交",
            "key": "key"
        },
        "replace_text": "已提交"
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,投票选择型卡片填写”vote_interaction”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
main_title.title是一级标题,建议不超过16个字
main_title.desc否二级普通文本,建议不超过160个字
checkbox否选择题样式
checkbox.question_key是选择题key值,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节
checkbox.disable否是否可以选择状态
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字节
replace_text否按钮替换文案,填写本字段后会展现灰色不可点击按钮

多项选择型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "tagids" : [44,55],
    "atall" : 0,
    "agentid" : 1,
    "response_code": "response_code",
    "template_card" : {
        "card_type" : "multiple_interaction",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信"
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "select_list": [
            {
                "question_key": "question_key1",
                "title": "选择器标签1",
                "selected_id": "selection_id1",
                "disable": false,
                "option_list": [
                    {
                        "id": "selection_id1",
                        "text": "选择器选项1"
                    },
                    {
                        "id": "selection_id2",
                        "text": "选择器选项2"
                    }
                ]
            },
            {
                "question_key": "question_key2",
                "title": "选择器标签2",
                "selected_id": "selection_id3",
                "disable": false,
                "option_list": [
                    {
                        "id": "selection_id3",
                        "text": "选择器选项3"
                    },
                    {
                        "id": "selection_id4",
                        "text": "选择器选项4"
                    }
                ]
            }
        ],
        "submit_button": {
            "text": "提交",
            "key": "key"
        },
        "replace_text": "已提交"
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,多项选择型卡片填写 “multiple_interaction”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
main_title.title是一级标题,建议不超过36个字
main_title.desc否标题辅助信息,建议不超过160个字
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.disable否是否可以选择状态
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字节
replace_text否按钮替换文案,填写本字段后会展现灰色不可点击按钮
文档ID: 32086
原文档地址:
https://open.work.weixin.qq.com/api/doc/90001/94945
https://open.work.weixin.qq.com/api/doc/90000/94888
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/message/update_template_card?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "tagids" : [44,55],
    "atall" : 0,
    "agentid" : 1,
    "response_code": "response_code",
    "button":{
        "replace_name": "replace_name"
    }
}'
响应示例响应示例
{
  "errcode": 0,
  "errmsg": "ok",
  "invaliduser": [
    "userid1",
    "userid2"
  ]
}

请求参数

Query 参数
access_token
调用接口凭证
必需
示例值:
{{accesstoken}}
Body 参数application/json
userids
array[string]
必需
partyids
array[integer]
必需
tagids
array[integer]
必需
atall
integer 
必需
agentid
integer 
必需
response_code
string 
必需
button
object 
必需
replace_name
string 
必需
示例

返回响应

🟢200成功
application/json
Body
errcode
integer 
必需
errmsg
string 
必需
invaliduser
array[string]
必需
不区分大小写,返回的列表都统一转为小写

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

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

扫码加入交流群
上一页
发送应用消息
下一页
撤回应用消息
Built with