Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
企业内部开发
智慧硬件开发第三方应用开发
企业内部开发
智慧硬件开发第三方应用开发
  1. 发送消息到群聊会话
  • 快速入门
    • 概述
  • 开发指南
    • 获取access_token
      GET
  • 通讯录管理
    • 成员管理
      • 获取加入企业二维码
      • 获取企业活跃成员数
    • 互联企业
      • 获取应用的可见范围
      • 获取互联企业成员详细信息
      • 获取互联企业部门成员
      • 获取互联企业部门成员详情
      • 获取互联企业部门列表
  • 客户联系
    • 客户管理
      • 客户联系规则组管理
        • 客户联系规则组管理-获取规则组列表
        • 客户联系规则组管理-获取规则组详情
        • 客户联系规则组管理-获取规则组管理范围
        • 客户联系规则组管理-创建新的规则组
        • 客户联系规则组管理-编辑规则组及其管理范围
        • 客户联系规则组管理-删除规则组
    • 客户标签管理
      • 管理企业规则组下的客户标签
        • 管理企业规则组下的客户标签-获取指定规则组下的企业客户标签
        • 管理企业规则组下的客户标签-为指定规则组创建企业客户标签
        • 管理企业规则组下的客户标签-编辑指定规则组下的企业客户标签
        • 管理企业规则组下的客户标签-删除指定规则组下的企业客户标签
    • 联系我与客户入群方式
      • 客户联系「联系我」管理
        • 更新企业已配置的「联系我」方式
        • 删除企业已配置的「联系我」方式
      • 客户群「加入群聊」管理
        • 配置客户群进群方式
        • 获取客户群进群方式配置
        • 更新客户群进群方式配置
        • 删除客户群进群方式配置
    • 客户朋友圈
      • 客户朋友圈规则组管理
        • 客户朋友圈规则组管理-获取规则组列表
        • 客户朋友圈规则组管理-获取规则组详情
        • 客户朋友圈规则组管理-获取规则组管理范围
        • 客户朋友圈规则组管理-创建新的规则组
        • 客户朋友圈规则组管理-编辑规则组及其管理范围
        • 客户朋友圈规则组管理-删除规则组
  • 微信客服
    • 接待人员管理
      • 添加接待人员_v1
  • 家校沟通
    • 网页授权登录
      • 获取访问用户身份-企业内部开发
  • 应用管理
    • 自定义菜单
      • 创建菜单
      • 获取菜单
      • 删除菜单
    • 设置应用
      POST
  • 消息推送
    • 发送消息到群聊会话
      • 创建群聊会话
        POST
      • 修改群聊会话
        POST
      • 获取群聊会话
        GET
      • 应用推送消息
        POST
    • 互联企业消息推送
      • 发送应用消息
  • OA
    • 打卡
      • 获取企业所有打卡规则
      • 录入打卡人员人脸信息
    • 审批
      • 获取审批数据(旧)
    • 汇报
      • 批量获取汇报记录单号
      • 获取汇报记录详情
      • 获取汇报统计数据
    • 会议室
      • 会议室管理-添加会议室
      • 会议室管理-查询会议室
      • 会议室管理-编辑会议室
      • 会议室管理-删除会议室
      • 会议室预定管理 查询会议室的预定信息
      • 会议室预定管理 预定会议室
      • 会议室预定管理 取消预定会议室
    • 紧急通知应用
      • 发起语音电话
      • 获取接听状态
  • 效率工具
    • 微盘
      • 空间管理 新建空间
      • 空间管理 重命名空间
      • 空间管理 解散空间
      • 空间管理 获取空间信息
      • 空间权限 添加成员/部门
      • 空间权限 移除成员/部门
      • 空间权限 权限管理
      • 空间权限 获取邀请链接
      • 文件管理 获取文件列表
      • 文件管理 上传文件
      • 文件管理 下载文件
      • 文件管理 新建文件/微文档
      • 文件管理 重命名文件
      • 文件管理 移动文件
      • 文件管理 删除文件
      • 文件管理 文件信息
      • 文件权限 新增指定人
      • 文件权限 删除指定人
      • 文件权限 分享设置
      • 文件权限 获取分享链接
    • 公费电话
      • 获取公费电话拨打记录
  • 企业支付
    • 企业红包
      • 发放企业红包
      • 查询红包记录
    • 向员工付款
      • 向员工付款
      • 查询付款记录
    • 对外收款
      • 收款商户号管理 新增商户号
      • 收款商户号管理 查询商户号详情
      • 收款商户号管理 删除商户号
      • 收款商户号管理 设置商户号使用范围
  • 上下游
    • 获取上下游信息
      • 获取上下游列表
      • 获取上下游通讯录分组
      • 获取企业上下游通讯录分组下的企业详情列表
    • 获取下级/下游企业的access_token
    • 获取下级/下游企业小程序session
    • 上下游企业应用获取微信用户的external_userid
  • 会话内容存档
    • 获取会话内容
      • 获取会话内容 获取机器人信息
    • 获取会话内容存档开启成员列表
    • 获取会话同意情况 群聊请求
    • 获取会话同意情况 单聊请求
    • 获取会话内容存档内部群信息
  • 家校应用
    • 健康上报
      • 获取健康上报使用统计
      • 获取健康上报任务ID列表
      • 获取健康上报任务详情
      • 获取用户填写答案
    • 复学码
      • 获取老师健康信息
      • 获取学生健康信息
      • 获取师生健康码
  • 政民沟通
    • 配置网格结构
      • 添加网格
      • 编辑网格
      • 删除网格
      • 获取网格列表
      • 获取用户负责及参与的网格列表
    • 配置事件类别
      • 添加事件类别
      • 修改事件类别
      • 删除事件类别
      • 获取事件类别列表
    • 巡查上报
      • 获取配置的网格及网格负责人
      • 获取单位巡查上报数据统计
      • 获取个人巡查上报数据统计
      • 获取上报事件分类统计
      • 获取巡查上报事件列表
      • 获取巡查上报的事件详情信息
    • 居民上报
      • 获取配置的网格及网格负责人
      • 获取单位居民上报数据统计
      • 获取个人居民上报数据统计
      • 获取上报事件分类统计
      • 获取居民上报事件列表
      • 获取居民上报的事件详情信息
  1. 发送消息到群聊会话

应用推送消息

POST
http://127.0.0.1/cgi-bin/appchat/send
企业内部开发/消息推送/发送消息到群聊会话
最后修改时间:2022-08-30 03:03:35
责任人:未设置
应用支持推送文本、图片、视频、文件、图文等类型。
请求包体:
各个消息类型的具体POST格式参考后面消息类型说明
限制说明:
只允许企业自建应用调用,且应用的可见范围必须是根部门;
chatid所代表的群必须是该应用所创建;
每企业消息发送量不可超过2万人次/分,不可超过30万人次/小时(若群有100人,每发一次消息算100人次);
每个成员在群中收到的应用消息不可超过200条/分,1万条/天,超过会被丢弃(接口不会报错);

消息类型#

文本消息#

请求示例:
{    "chatid": "CHATID",    "msgtype":"text",    "text":{        "content" : "你的快递已到\n请携带工卡前往邮件中心领取"    },    "safe":0}
参数说明:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:text
content是消息内容,最长不超过2048个字节
safe否表示是否是保密消息,0表示否,1表示是,默认0
文本消息展现:
img
特殊说明:
其中text参数的content字段可以支持换行,换行符请用转义过的’\n’。

图片消息#

请求示例:
{    "chatid": "CHATID",    "msgtype":"image",    "image":{        "media_id": "MEDIAID"    },    "safe":0}
请求参数:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:image
media_id是图片媒体文件id,可以调用上传临时素材接口获取
safe否表示是否是保密消息,0表示否,1表示是,默认0
图片消息展现:
img

语音消息#

请求示例:
{   "chatid" : "CHATID",   "msgtype" : "voice",   "voice" : {        "media_id" : "MEDIA_ID"   }}
参数说明:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:voice
media_id是语音文件id,可以调用上传临时素材接口获取
语音消息展现:
img

视频消息#

请求示例:
{   "chatid" : "CHATID",   "msgtype" : "video",   "video" : {       "media_id" : "MEDIA_ID",       "description" : "Description",       "title": "Title"   },   "safe":0}
参数说明:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:video
media_id是视频媒体文件id,可以调用上传临时素材接口获取
title否视频消息的标题,不超过128个字节,超过会自动截断
description否视频消息的描述,不超过512个字节,超过会自动截断
safe否表示是否是保密消息,0表示否,1表示是,默认0
视频消息展现:
img

文件消息#

请求示例:
{   "chatid" : "CHATID",   "msgtype" : "file",   "file" : {        "media_id" : "1Yv-zXfHjSjU-7LH-GwtYqDGS-zz6w22KmWAT5COgP7o"   },   "safe":0}
参数说明:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:file
media_id是文件id,可以调用上传临时素材接口获取
safe否表示是否是保密消息,0表示否,1表示是,默认0
文件消息展现:
img

文本卡片消息#

请求示例:
{    "chatid": "CHATID",    "msgtype":"textcard",    "textcard":{        "title" : "领奖通知",        "description" : "<div class=\"gray\">2016年9月26日</div> <div class=\"normal\"> 恭喜你抽中iPhone 7一台,领奖码:520258</div><div class=\"highlight\">请于2016年10月10日前联系行 政同事领取</div>",        "url":"https://work.weixin.qq.com/",        "btntxt":"更多"    },    "safe":0}
参数说明:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:textcard
title是标题,不超过128个字节,超过会自动截断
description是描述,不超过512个字节,超过会自动截断
url是点击后跳转的链接。
btntxt否按钮文字。 默认为“详情”, 不超过4个文字,超过自动截断。
特殊说明:
卡片消息的展现形式非常灵活,支持使用br标签或者空格来进行换行处理,也支持使用div标签来使用不同的字体颜色,目前内置了3种文字颜色:灰色(gray)、高亮(highlight)、默认黑色(normal),将其作为div标签的class属性即可,具体用法请参考上面的示例。
文本卡片消息展现 :
img

图文消息#

请求示例:
{    "chatid": "CHATID",    "msgtype":"news",    "news":{        "articles" :        [            {                "title" : "中秋节礼品领取",                "description" : "今年中秋节公司有豪礼相送",                "url":"https://work.weixin.qq.com/",                "picurl":"http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png"             }        ]    },    "safe":0}
参数说明:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:news
articles是图文消息,一个图文消息支持1到8条图文
title是标题,不超过128个字节,超过会自动截断
description否描述,不超过512个字节,超过会自动截断
url是点击后跳转的链接。
picurl否图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图1068455,小图150150。
图文消息展现:
img

图文消息(mpnews)#

mpnews类型的图文消息,跟普通的图文消息一致,唯一的差异是图文内容存储在企业微信。
多次发送mpnews,会被认为是不同的图文,阅读、点赞的统计会被分开计算。
请求示例:
{    "chatid": "CHATID",    "msgtype":"mpnews",    "mpnews":{        "articles":[            {                "title": "地球一小时",                "thumb_media_id": "biz_get(image)",                "author": "Author",                "content_source_url": "https://work.weixin.qq.com",                "content": "3月24日20:30-21:30 \n办公区将关闭照明一小时,请各部门同事相互转告",                "digest": "3月24日20:30-21:30 \n办公区将关闭照明一小时"            }         ]    },    "safe":0}
参数说明:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:mpnews
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表示是,默认0
图文消息展现:
img

markdown消息#

目前仅支持markdown语法的子集
微工作台(原企业号)不支持展示markdown消息
请求示例:
{   "chatid": "CHATID",   "msgtype":"markdown",   "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)"   }}
参数说明:
参数是否必须说明
chatid是群聊id
msgtype是消息类型,此时固定为:markdown
content是markdown内容,最长不超过2048个字节,必须是utf8编码
示例效果:
img
文档ID: 13294
原文档地址:
https://open.work.weixin.qq.com/api/doc/90000/90135/90248

请求参数

Query 参数
access_token
string 
调用接口凭证
必需
示例值:
{{accesstoken}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://127.0.0.1/cgi-bin/appchat/send?access_token={{accesstoken}}'

返回响应

🟢200成功
application/json
Body
No schema defined
示例
 {
   "errcode" : 0,
   "errmsg" : "ok",
 }
上一页
获取群聊会话
下一页
发送应用消息
Built with