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

发送应用消息

POST
/cgi-bin/linkedcorp/message/send
服务端API企业内部开发
接口概述:互联企业是企业微信提供的满足集团与子公司、企业与上下游供应商进行连接的功能,企业可以共享通讯录以及应用给互联企业,如需要,你可以前往管理后台-通讯录创建互联企业,之后你可以在自建应用的可见范围设置互联企业的通讯录;此接口主要满足开发者给互联企业成员推送消息的诉求。
如果部分接收人无权限或不存在,发送仍然执行,但会返回无效的部分(即invaliduser或invalidparty),常见的原因是接收人不在应用的可见范围内。
各个消息类型的具体POST格式参考以下文档。

消息类型#

文本消息#

请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],    "toall" : 0,    "msgtype" : "text",   "agentid" : 1,   "text" : {       "content" : "你的快递已到,请携带工卡前往邮件中心领取。\n出发前可查看<a href=\"http://work.weixin.qq.com\">邮件中心视频实况</a>,聪明避开排队。"   },   "safe":0}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中,corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:text
agentid是企业应用的id,整型。可在应用的设置页面查看
content是消息内容,最长不超过2048个字节
safe否表示是否是保密消息,0表示否,1表示是,默认0
注意:linked_id为互联ID,此ID可以在管理后台-通讯录-互联企业-详情里查看
img

图片消息#

请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],    "toall" : 0,   "msgtype" : "image",   "agentid" : 1,   "image" : {        "media_id" : "MEDIA_ID"   },   "safe":0}
请求参数:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中, corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:image
agentid是企业应用的id,整型。可在应用的设置页面查看
media_id是图片媒体文件id,可以调用上传临时素材接口获取
safe否表示是否是保密消息,0表示否,1表示是,默认0

语音消息#

请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],    "toall" : 0,   "msgtype" : "voice",   "agentid" : 1,   "voice" : {        "media_id" : "MEDIA_ID"   }}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中, corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:voice
agentid是企业应用的id,整型。可在应用的设置页面查看
media_id是语音文件id,可以调用上传临时素材接口获取

视频消息#

请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],    "toall" : 0,   "msgtype" : "video",   "agentid" : 1,   "video" : {        "media_id" : "MEDIA_ID",        "title" : "Title",       "description" : "Description"   },   "safe":0}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中, corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:video
agentid是企业应用的id,整型。可在应用的设置页面查看
media_id是视频媒体文件id,可以调用上传临时素材接口获取
title否视频消息的标题,不超过128个字节,超过会自动截断
description否视频消息的描述,不超过512个字节,超过会自动截断
safe否表示是否是保密消息,0表示否,1表示是,默认0

文件消息#

请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],    "toall" : 0,   "msgtype" : "file",   "agentid" : 1,   "file" : {        "media_id" : "1Yv-zXfHjSjU-7LH-GwtYqDGS-zz6w22KmWAT5COgP7o"   },   "safe":0}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中, corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:file
agentid是企业应用的id,整型。可在应用的设置页面查看
media_id是文件id,可以调用上传临时素材接口获取
safe否表示是否是保密消息,0表示否,1表示是,默认0
文件消息展现:
img

文本卡片消息#

请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],    "toall" : 0,   "msgtype" : "textcard",   "agentid" : 1,   "textcard" : {            "title" : "领奖通知",            "description" : "<div class=\"gray\">2016年9月26日</div> <div class=\"normal\">恭喜你抽中iPhone 7一台,领奖码:xxxx</div><div class=\"highlight\">请于2016年10月10日前联系行政同事领取</div>",            "url" : "URL",            "btntxt":"更多"   }}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中, corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:textcard
agentid是企业应用的id,整型。可在应用的设置页面查看
title是标题,不超过128个字节,超过会自动截断
description是描述,不超过512个字节,超过会自动截断
url是点击后跳转的链接。
btntxt否按钮文字。 默认为“详情”, 不超过4个文字,超过自动截断。
文本卡片消息展现 :
img
特殊说明:
卡片消息的展现形式非常灵活,支持使用br标签或者空格来进行换行处理,也支持使用div标签来使用不同的字体颜色,目前内置了3种文字颜色:灰色(gray)、高亮(highlight)、默认黑色(normal),将其作为div标签的class属性即可,具体用法请参考上面的示例。

图文消息#

请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],    "toall" : 0,   "msgtype" : "news",   "agentid" : 1,   "news" : {       "articles" : [           {               "title" : "中秋节礼品领取",               "description" : "今年中秋节公司有豪礼相送",               "url" : "URL",               "picurl" : "http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png",               "btntxt":"更多"           }        ]   }}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中,corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:news
agentid是企业应用的id,整型。可在应用的设置页面查看
articles是图文消息,一个图文消息支持1到8条图文
title是标题,不超过128个字节,超过会自动截断
description否描述,不超过512个字节,超过会自动截断
url是点击后跳转的链接。
picurl否图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图 640x320,小图80x80。
btntxt否按钮文字,仅在图文数为1条时才生效。 默认为“阅读全文”, 不超过4个文字,超过自动截断。该设置只在企业微信上生效,微工作台(原企业号)上不生效。
图文消息展现:
img

图文消息(mpnews)#

mpnews类型的图文消息,跟普通的图文消息一致,唯一的差异是图文内容存储在企业微信。
多次发送mpnews,会被认为是不同的图文,阅读、点赞的统计会被分开计算。
请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],    "toall" : 0,   "msgtype" : "mpnews",   "agentid" : 1,   "mpnews" : {       "articles":[           {               "title": "Title",                "thumb_media_id": "MEDIA_ID",               "author": "Author",               "content_source_url": "URL",               "content": "Content",               "digest": "Digest description"            }       ]   },   "safe":0}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中, corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:mpnews
agentid是企业应用的id,整型。可在应用的设置页面查看
articles是图文消息,一个图文消息支持1到8条图文
title是标题,不超过128个字节,超过会自动截断
thumb_media_id是图文消息缩略图的media_id, 可以通过素材管理接口获得。此处thumb_media_id即上传接口返回的media_id
author否图文消息的作者,不超过64个字节
content_source_url否图文消息点击“阅读原文”之后的页面链接
content是图文消息的内容,支持html标签,不超过666 K个字节
digest否图文消息的描述,不超过512个字节,超过会自动截断
safe否表示是否是保密消息,0表示可对外分享,1表示不能分享且内容显示水印,2表示仅限在企业内分享,默认为0;注意仅mpnews类型的消息支持safe值为2,其他消息类型不支持

markdown消息#

目前仅支持markdown语法的子集
微工作台(原企业号)不支持展示markdown消息
请求示例:
{   "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],   "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],   "totag" : ["tagid1","tagid2"],   "toall" : 0,   "msgtype" : "markdown",   "agentid" : 1,   "markdown": {        "content": "您的会议室已经预定,稍后会同步到`邮箱`                >**事项详情**                >事 项:<font color=\"info\">开会</font>                >组织者:@miglioguan                >参与者:@miglioguan、@kunliu、@jamdeezhou、@kanexiong、@kisonwang                >                >会议室:<font color=\"info\">广州TIT 1楼 301</font>                >日 期:<font color=\"warning\">2018年5月18日</font>                >时 间:<font color=\"comment\">上午9:00-11:00</font>                >                >请准时参加会议。                >                >如需修改会议信息,请点击:[修改会议信息](https://work.weixin.qq.com)"   }}
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中,corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
toall否1表示发送给应用可见范围内的所有人(包括互联企业的成员),默认为0
msgtype是消息类型,此时固定为:markdown
agentid是企业应用的id,整型。可在应用的设置页面查看
content是markdown内容,最长不超过2048个字节,必须是utf8编码
示例效果:
img

小程序通知消息#

小程序通知消息只允许小程序应用发送,消息会通过【小程序通知】发送给用户。
小程序应用仅支持发送小程序通知消息,暂不支持文本、图片、语音、视频、图文等其他类型的消息。
不支持toall参数,即不支持全员发送
请求示例:
{    "touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],    "toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],    "totag" : ["tagid1","tagid2"],   "msgtype" : "miniprogram_notice",   "miniprogram_notice" : {        "appid": "wx123123123123123",        "page": "pages/index?userid=zhangsan&orderid=123123123",        "title": "会议室预订成功通知",        "description": "4月27日 16:16",        "emphasis_first_item": true,        "content_item": [            {                "key": "会议室",                "value": "402"            },            {                "key": "会议地点",                "value": "广州TIT-402会议室"            },            {                "key": "会议时间",                "value": "2018年8月1日 09:00-09:30"            },            {                "key": "参与人员",                "value": "周剑轩"            }        ]    }}
示例效果:
img
参数说明:
参数是否必须说明
touser否成员ID列表(消息接收者,最多支持1000个)。每个元素的格式为: corpid/userid,其中, corpid为该互联成员所属的企业,userid为该互联成员所属企业中的帐号。如果是本企业的成员,则直接传userid即可
toparty否部门ID列表,最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型,格式为:linked_id/party_id,其中linked_id是互联id,party_id是在互联圈子中的部门id。如果是本企业的部门,则直接传party_id即可。
totag否本企业的标签ID列表,最多支持100个。
msgtype是消息类型,此时固定为:miniprogram_notice
appid是小程序appid,必须是与当前小程序应用关联的小程序
page否点击消息卡片后的小程序页面,仅限本小程序内的页面。该字段不填则消息点击后不跳转。
title是消息标题,长度限制4-12个汉字
description否消息描述,长度限制4-12个汉字
emphasis_first_item否是否放大第一个content_item
content_item否消息内容键值对,最多允许10个item
key是长度10个汉字以内
value是长度30个汉字以内
文档ID: 14689
原文档地址:
https://open.work.weixin.qq.com/api/doc/90000/90135/90250
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/message/send?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{}'
响应示例响应示例
{
  "errcode": 0,
  "errmsg": "ok",
  "invaliduser": [
    "userid1",
    "userid2",
    "CorpId1/userid1",
    "CorpId2/userid2"
  ],
  "invalidparty": [
    "partyid1",
    "partyid2",
    "LinkedId1/partyid1",
    "LinkedId2/partyid2"
  ],
  "invalidtag": [
    "tagid1",
    "tagid2"
  ]
}

请求参数

Query 参数
access_token
调用接口凭证
必需
示例值:
{{accesstoken}}
Body 参数application/json
object {0}
示例

返回响应

🟢200成功
application/json
Body
errcode
integer 
必需
errmsg
string 
必需
invaliduser
array[string]
必需
invalidparty
array[string]
必需
invalidtag
array[string]
必需

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

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

扫码加入交流群
上一页
接受消息与事件
下一页
发送「学校通知」
Built with