程序员经验分享-hwhale

企业微信群机器人开发

2023-11-13

准备工作

  • 已经注册了有效的企业微信账号，并且在客户端上已经登录
  • 现有或者新建有效的包含多名企业微信成员的群聊

创建群聊机器人

右键群聊->管理聊天信息->添加群机器人

 

使用群机器人 

在终端某个群组添加机器人之后，创建者可以在机器人详情页看的该机器人特有的webhookurl。开发者可以按以下说明向这个地址发起HTTP POST 请求，即可实现给该群组发送消息。下面举个简单的例子.
假设webhook是：https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693a91f6-……

特别特别要注意：一定要保护好机器人的webhook地址，避免泄漏！不要分享到github、博客等可被公开查阅的地方，否则坏人就可以用你的机器人来发垃圾消息了。

以下是用curl工具往群组推送文本消息的示例（注意要将url替换成你的机器人webhook地址，content必须是utf8编码）：

curl 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693axxx6-7aoc-4bc4-97a0-0ec2sifa5aaa' \
   -H 'Content-Type: application/json' \
   -d '
   {
    	"msgtype": "text",
    	"text": {
        	"content": "hello world"
    	}
   }'
  • 自定义机器人支持文本（text）、markdown（markdown）、图片（image）、图文（news）四种消息类型。
  • 机器人的text/markdown类型消息支持在content中使用<@userid>扩展语法来@群成员。

消息类型及数据格式

文本类型

{
    "msgtype": "text",
    "text": {
        "content": "广州今日天气：29度，大部分多云，降雨概率：60%",
		"mentioned_list":["wangqing","@all"],
		"mentioned_mobile_list":["13800001111","@all"]
    }
}
参数 是否必填 说明
msgtype 是 消息类型，此时固定为text
content 是 文本内容，最长不超过2048个字节，必须是utf8编码
mentioned_list 否 userid的列表，提醒群中的指定成员(@某个成员)，@all表示提醒所有人，如果开发者获取不到userid，可以使用mentioned_mobile_list
mentioned_mobile_list 否 手机号列表，提醒手机号对应的群成员(@某个成员)，@all表示提醒所有人

markdown类型

{
    "msgtype": "markdown",
    "markdown": {
        "content": "实时新增用户反馈<font color=\"warning\">132例</font>，请相关同事注意。\n
         >类型:<font color=\"comment\">用户反馈</font>
         >普通用户反馈:<font color=\"comment\">117例</font>
         >VIP用户反馈:<font color=\"comment\">15例</font>"
    }
}
参数 是否必填 说明
msgtype 是 消息类型，此时固定为markdown
content 是 markdown内容，最长不超过4096个字节，必须是utf8编码

图片类型

{
    "msgtype": "image",
    "image": {
        "base64": "DATA",
		"md5": "MD5"
    }
}
参数 是否必填 说明
msgtype 是 消息类型，此时固定为image
base64 是 图片内容的base64编码
md5 是 图片内容（base64编码前）的md5值

注：图片（base64编码前）最大不能超过2M，支持JPG,PNG格式 

图文类型 

{
    "msgtype": "news",
    "news": {
       "articles" : [
           {
               "title" : "中秋节礼品领取",
               "description" : "今年中秋节公司有豪礼相送",
               "url" : "www.qq.com",
               "picurl" : "http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png"
           }
        ]
    }
}
参数 是否必填 说明
msgtype 是 消息类型，此时固定为news
articles 是 图文消息，一个图文消息支持1到8条图文
title 是 标题，不超过128个字节，超过会自动截断
description 否 描述，不超过512个字节，超过会自动截断
url 是 点击后跳转的链接。
picurl 否 图文消息的图片链接，支持JPG、PNG格式，较好的效果为大图 1068*455，小图150*150。

 

文件类型

{
    "msgtype": "file",
    "file": {
 		"media_id": "3a8asd892asd8asd"
    }
}
参数 是否必填 说明
msgtype 是 消息类型，此时固定为file
media_id 是 文件id，通过下文的文件上传接口获取

 

模版卡片类型

文本通知模版卡片
{
    "msgtype":"template_card",
    "template_card":{
        "card_type":"text_notice",
        "source":{
            "icon_url":"https://wework.qpic.cn/wwpic/252813_jOfDHtcISzuodLa_1629280209/0",
            "desc":"企业微信",
            "desc_color":0
        },
        "main_title":{
            "title":"欢迎使用企业微信",
            "desc":"您的好友正在邀请您加入企业微信"
        },
        "emphasis_content":{
            "title":"100",
            "desc":"数据含义"
        },
        "quote_area":{
            "type":1,
            "url":"https://work.weixin.qq.com/?from=openApi",
            "appid":"APPID",
            "pagepath":"PAGEPATH",
            "title":"引用文本标题",
            "quote_text":"Jack：企业微信真的很好用~\nBalian：超级好的一款软件！"
        },
        "sub_title_text":"下载企业微信还能抢红包！",
        "horizontal_content_list":[
            {
                "keyname":"邀请人",
                "value":"张三"
            },
            {
                "keyname":"企微官网",
                "value":"点击访问",
                "type":1,
                "url":"https://work.weixin.qq.com/?from=openApi"
            },
            {
                "keyname":"企微下载",
                "value":"企业微信.apk",
                "type":2,
                "media_id":"MEDIAID"
            }
        ],
        "jump_list":[
            {
                "type":1,
                "url":"https://work.weixin.qq.com/?from=openApi",
                "title":"企业微信官网"
            },
            {
                "type":2,
                "appid":"APPID",
                "pagepath":"PAGEPATH",
                "title":"跳转小程序"
            }
        ],
        "card_action":{
            "type":1,
            "url":"https://work.weixin.qq.com/?from=openApi",
            "appid":"APPID",
            "pagepath":"PAGEPATH"
        }
    }
}

请求参数

参数 类型 必须 说明
msgtype String 是 消息类型，此时的消息类型固定为template_card
template_card Object 是 具体的模版卡片参数

template_card的参数说明

参数 类型 必须 说明
card_type String 是 模版卡片的模版类型，文本通知模版卡片的类型为text_notice
source Object 否 卡片来源样式信息，不需要来源样式可不填写
source.icon_url String 否 来源图片的url
source.desc String 否 来源图片的描述，建议不超过13个字
source.desc_color Int 否 来源文字的颜色，目前支持：0(默认) 灰色，1 黑色，2 红色，3 绿色
main_title Object 是 模版卡片的主要内容，包括一级标题和标题辅助信息
main_title.title String 否 一级标题，建议不超过26个字。模版卡片主要内容的一级标题main_title.title和二级普通文本sub_title_text必须有一项填写
main_title.desc String 否 标题辅助信息，建议不超过30个字
emphasis_content Object 否 关键数据样式
emphasis_content.title String 否 关键数据样式的数据内容，建议不超过10个字
emphasis_content.desc String 否 关键数据样式的数据描述内容，建议不超过15个字
quote_area Object 否 引用文献样式，建议不与关键数据共用
quote_area.type Int 否 引用文献样式区域点击事件，0或不填代表没有点击事件，1 代表跳转url，2 代表跳转小程序
quote_area.url String 否 点击跳转的url，quote_area.type是1时必填
quote_area.appid String 否 点击跳转的小程序的appid，quote_area.type是2时必填
quote_area.pagepath String 否 点击跳转的小程序的pagepath，quote_area.type是2时选填
quote_area.title String 否 引用文献样式的标题
quote_area.quote_text String 否 引用文献样式的引用文案
sub_title_text String 否 二级普通文本，建议不超过112个字。模版卡片主要内容的一级标题main_title.title和二级普通文本sub_title_text必须有一项填写
horizontal_content_list Object[] 否 二级标题+文本列表，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过6
horizontal_content_list.type Int 否 模版卡片的二级标题信息内容支持的类型，1是url，2是文件附件，3 代表点击跳转成员详情
horizontal_content_list.keyname String 是 二级标题，建议不超过5个字
horizontal_content_list.value String 否 二级文本，如果horizontal_content_list.type是2，该字段代表文件名称（要包含文件类型），建议不超过26个字
horizontal_content_list.url String 否 链接跳转的url，horizontal_content_list.type是1时必填
horizontal_content_list.media_id String 否 附件的media_id，horizontal_content_list.type是2时必填
horizontal_content_list.userid String 否 成员详情的userid，horizontal_content_list.type是3时必填
jump_list Object[] 否 跳转指引样式的列表，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过3
jump_list.type Int 否 跳转链接类型，0或不填代表不是链接，1 代表跳转url，2 代表跳转小程序
jump_list.title String 是 跳转链接样式的文案内容，建议不超过13个字
jump_list.url String 否 跳转链接的url，jump_list.type是1时必填
jump_list.appid String 否 跳转链接的小程序的appid，jump_list.type是2时必填
jump_list.pagepath String 否 跳转链接的小程序的pagepath，jump_list.type是2时选填
card_action Object 是 整体卡片的点击跳转事件，text_notice模版卡片中该字段为必填项
card_action.type Int 是 卡片跳转类型，1 代表跳转url，2 代表打开小程序。text_notice模版卡片中该字段取值范围为[1,2]
card_action.url String 否 跳转事件的url，card_action.type是1时必填
card_action.appid String 否 跳转事件的小程序的appid，card_action.type是2时必填
card_action.pagepath String 否 跳转事件的小程序的pagepath，card_action.type是2时选填

图文展示模版卡片
{
    "msgtype":"template_card",
    "template_card":{
        "card_type":"news_notice",
        "source":{
            "icon_url":"https://wework.qpic.cn/wwpic/252813_jOfDHtcISzuodLa_1629280209/0",
            "desc":"企业微信",
            "desc_color":0
        },
        "main_title":{
            "title":"欢迎使用企业微信",
            "desc":"您的好友正在邀请您加入企业微信"
        },
        "card_image":{
            "url":"https://wework.qpic.cn/wwpic/354393_4zpkKXd7SrGMvfg_1629280616/0",
            "aspect_ratio":2.25
        },
        "image_text_area":{
            "type":1,
            "url":"https://work.weixin.qq.com",
            "title":"欢迎使用企业微信",
            "desc":"您的好友正在邀请您加入企业微信",
            "image_url":"https://wework.qpic.cn/wwpic/354393_4zpkKXd7SrGMvfg_1629280616/0"
        },
        "quote_area":{
            "type":1,
            "url":"https://work.weixin.qq.com/?from=openApi",
            "appid":"APPID",
            "pagepath":"PAGEPATH",
            "title":"引用文本标题",
            "quote_text":"Jack：企业微信真的很好用~\nBalian：超级好的一款软件！"
        },
        "vertical_content_list":[
            {
                "title":"惊喜红包等你来拿",
                "desc":"下载企业微信还能抢红包！"
            }
        ],
        "horizontal_content_list":[
            {
                "keyname":"邀请人",
                "value":"张三"
            },
            {
                "keyname":"企微官网",
                "value":"点击访问",
                "type":1,
                "url":"https://work.weixin.qq.com/?from=openApi"
            },
            {
                "keyname":"企微下载",
                "value":"企业微信.apk",
                "type":2,
                "media_id":"MEDIAID"
            }
        ],
        "jump_list":[
            {
                "type":1,
                "url":"https://work.weixin.qq.com/?from=openApi",
                "title":"企业微信官网"
            },
            {
                "type":2,
                "appid":"APPID",
                "pagepath":"PAGEPATH",
                "title":"跳转小程序"
            }
        ],
        "card_action":{
            "type":1,
            "url":"https://work.weixin.qq.com/?from=openApi",
            "appid":"APPID",
            "pagepath":"PAGEPATH"
        }
    }
}

请求参数

参数 类型 必须 说明
msgtype String 是 模版卡片的消息类型为template_card
template_card Object 是 具体的模版卡片参数

template_card的参数说明

参数 类型 必须 说明
card_type String 是 模版卡片的模版类型，图文展示模版卡片的类型为news_notice
source Object 否 卡片来源样式信息，不需要来源样式可不填写
source.icon_url String 否 来源图片的url
source.desc String 否 来源图片的描述，建议不超过13个字
source.desc_color Int 否 来源文字的颜色，目前支持：0(默认) 灰色，1 黑色，2 红色，3 绿色
main_title Object 是 模版卡片的主要内容，包括一级标题和标题辅助信息
main_title.title String 是 一级标题，建议不超过26个字
main_title.desc String 否 标题辅助信息，建议不超过30个字
card_image Object 是 图片样式
card_image.url String 是 图片的url
card_image.aspect_ratio Float 否 图片的宽高比，宽高比要小于2.25，大于1.3，不填该参数默认1.3
image_text_area Object 否 左图右文样式
image_text_area.type Int 否 左图右文样式区域点击事件，0或不填代表没有点击事件，1 代表跳转url，2 代表跳转小程序
image_text_area.url String 否 点击跳转的url，image_text_area.type是1时必填
image_text_area.appid String 否 点击跳转的小程序的appid，必须是与当前应用关联的小程序，image_text_area.type是2时必填
image_text_area.pagepath String 否 点击跳转的小程序的pagepath，image_text_area.type是2时选填
image_text_area.title String 否 左图右文样式的标题
image_text_area.desc String 否 左图右文样式的描述
image_text_area.image_url String 是 左图右文样式的图片url
quote_area Object 否 引用文献样式，建议不与关键数据共用
quote_area.type Int 否 引用文献样式区域点击事件，0或不填代表没有点击事件，1 代表跳转url，2 代表跳转小程序
quote_area.url String 否 点击跳转的url，quote_area.type是1时必填
quote_area.appid String 否 点击跳转的小程序的appid，quote_area.type是2时必填
quote_area.pagepath String 否 点击跳转的小程序的pagepath，quote_area.type是2时选填
quote_area.title String 否 引用文献样式的标题
quote_area.quote_text String 否 引用文献样式的引用文案
vertical_content_list Object[] 否 卡片二级垂直内容，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过4
vertical_content_list.title String 是 卡片二级标题，建议不超过26个字
vertical_content_list.desc String 否 二级普通文本，建议不超过112个字
horizontal_content_list Object[] 否 二级标题+文本列表，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过6
horizontal_content_list.type Int 否 模版卡片的二级标题信息内容支持的类型，1是url，2是文件附件，3 代表点击跳转成员详情
horizontal_content_list.keyname String 是 二级标题，建议不超过5个字
horizontal_content_list.value String 否 二级文本，如果horizontal_content_list.type是2，该字段代表文件名称（要包含文件类型），建议不超过26个字
horizontal_content_list.url String 否 链接跳转的url，horizontal_content_list.type是1时必填
horizontal_content_list.media_id String 否 附件的media_id，horizontal_content_list.type是2时必填
horizontal_content_list.userid String 否 成员详情的userid，horizontal_content_list.type是3时必填
jump_list Object[] 否 跳转指引样式的列表，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过3
jump_list.type Int 否 跳转链接类型，0或不填代表不是链接，1 代表跳转url，2 代表跳转小程序
jump_list.title String 是 跳转链接样式的文案内容，建议不超过13个字
jump_list.url String 否 跳转链接的url，jump_list.type是1时必填
jump_list.appid String 否 跳转链接的小程序的appid，jump_list.type是2时必填
jump_list.pagepath String 否 跳转链接的小程序的pagepath，jump_list.type是2时选填
card_action Object 是 整体卡片的点击跳转事件，news_notice模版卡片中该字段为必填项
card_action.type Int 是 卡片跳转类型，1 代表跳转url，2 代表打开小程序。news_notice模版卡片中该字段取值范围为[1,2]
card_action.url String 否 跳转事件的url，card_action.type是1时必填
card_action.appid String 否 跳转事件的小程序的appid，card_action.type是2时必填
card_action.pagepath String 否 跳转事件的小程序的pagepath，card_action.type是2时选填

消息发送频率限制

每个机器人发送的消息不能超过20条/分钟。

文件上传接口

素材上传得到media_id，该media_id仅三天内有效
media_id只能是对应上传文件的机器人可以使用

请求方式：POST（HTTPS）
请求地址：https://qyapi.weixin.qq.com/cgi-bin/webhook/upload_media?key=KEY&type=TYPE

使用multipart/form-data POST上传文件， 文件标识名为"media"
参数说明：

参数 必须 说明
key 是 调用接口凭证, 机器人webhookurl中的key参数
type 是 固定传file

POST的请求包中，form-data中媒体文件标识，应包含有 filename、filelength、content-type等信息

filename标识文件展示的名称。比如，使用该media_id发消息时，展示的文件名由该字段控制

请求示例：

POST https://qyapi.weixin.qq.com/cgi-bin/webhook/upload_media?key=693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa&type=file HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------------------acebdf13572468
Content-Length: 220

---------------------------acebdf13572468
Content-Disposition: form-data; name="media";filename="wework.txt"; filelength=6
Content-Type: application/octet-stream

mytext
---------------------------acebdf13572468--

 返回数据：

{
   "errcode": 0,
   "errmsg": "ok",
   "type": "file",
   "media_id": "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0",
   "created_at": "1380000000"
}

参数说明：

参数 说明
type 媒体文件类型，分别有图片（image）、语音（voice）、视频（video），普通文件(file)
media_id 媒体文件上传后获取的唯一标识，3天内有效
created_at 媒体文件上传时间戳

上传的文件限制：

  • 要求文件大小在5B~20M之间
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

AI

企业微信

企业微信群机器人开发 的相关文章

随机推荐

  • Unity—常用API（续Time类）

    今天整理了Time类 一张很有意思的理解API的图 此图灵感来源于 如何理解API API 是如何工作的 仁杰兄的博客 CSDN博客 api 目录 Time 练习 使用Text制作倒计时预制体 在Update每帧执行的方法中 个别语句实现指

  • ubuntu学习（四）----文件写入操作编程

    1 write函数的详解 ssize t write int fd const void buf size t count 参数说明 fd 是文件描述符 write所对应的是写 即就是1 buf 通常是一个字符串 需要写入的字符串 coun

  • 浅析芝麻信用分征信体系

    在互联网大佬中 能将未雨绸缪之功力炼至极致的非马云莫属了 其所扔下的每一个棋子都会前思三招 后推九步 每一步商业布局都像是一枚运气极佳的的种子总能找到温润肥沃的土壤而后破土而发 十年遮风 百年纳凉 马老板曾苦心孤诣费尽心机地想把淘宝由一家广

  • 教你自己搭建一个ip池(绝对超好用！！！！)

    随着我们爬虫的速度越来越快 很多时候 有人发现 数据爬不了啦 打印出来一看 不返回数据 而且还甩一句话 是不是很熟悉啊 要想想看 人是怎么访问网站的 发请求 对 那么就会带有 request headers 那么当你疯狂请求别人的网站时候

  • .NET/C#下html转PDF，PDF加水印，PDF转图片

    一 添加OpenHtmlToPdf iTextSharp O2S Components PDFRender4NET引用 1 OpenHtmlToPdf 是一个 NET库 开源的 用于将HTML文档呈现为PDF格式 github地址 http

  • hibernate derby 配置文件

    hibernate cfg xml

  • Python数据分析——上海市二手房价格分析

    自学数据分析与机器学习已有两月 近期房价问题引人深思 即兴做个上海市房价的数据分析小项目 上网一查上海市新楼盘价格 高的不忍直视 索性退而求其次 分析上海二手房的价格 一 数据收集 常规做法是编写网络爬虫程序 爬取相关网站的数据信息 捷径是

  • 如何把glb格式模型gltf格式模型导入3dmax和C4D，U3D，UE4这些主流软件中

    咱有时候去glbxz com添加链接描述 官网下载免费glb格式模型 gltf模型下载时候是没有通用格式 例如fbx obj 这个时候3dmax和C4D直接打开导入是不行的 也可以制作glb模型 扣扣 424081801 这个时候 咱们用

  • AI工具汇总

    大家好 我是可夫小子 关注AIGC 读书和自媒体 ChatGPT已经火了这么久 我也写不了少玩ChatGPT的方法 昨天OpenAI又推出了苹果手机的APP 我也介绍下载和安装的攻略 但根据读者反馈 仍然还是有许多同学没能用上 今天我就把我

  • VS2015远程编译Linux项目

    用VS2015开发Linux程序详细教程 配置篇 crazytea的博客 CSDN博客 linux 程序开发VS2015推出了跨平台开发 其中包括了对Linux程序开发的支持 最近刚好需要开发Linux程序 对其进行了一些研究 首先介绍下涉

  • redis的安装与配置

    第一章 redis 1 1redis的概述 1 2关系型数据库与非关系数据库 1 3关系型数据库和非关系型数据库区别 1 4redis优点与缺点 第二章redis的安装 2 1 YUM安装 2 2下载编译安装 2 2 1关闭防火墙 2 2

  • element左侧导航栏el-menu，菜单栏文字超出不折行问题

    在CSS样式中加上这些样式就可以了 el submenu title display flex align items center el submenu title span white space normal word break b

  • C# 面向对象05 StringBuilder的用法

    好处 相比普通的 string处理 提高了字符串的处理速度 注意点 使用时需要使用对象的方式 StringBuilder world new StringBuilder using System using System Diagnosti

  • SimpleDateFormat模式字符串格式

    SimpleDateFormat模式字符串 new SimpleDateFormat String parm parm为一个字符串 表示格式 时间模式 字母 时间元素 表示 示例 y 年 Year 1996 96 M 年中的月份 Month

  • PyTorch基础之模型保存与重载模块、可视化模块讲解（附源码）

    训练模型时 在众多训练好的模型中会有几个较好的模型 我们希望储存这些模型对应的参数值 避免后续难以训练出更好的结果 同时也方便我们复现这些模型 用于之后的研究 PyTorch提供了模型的保存与重载模块 包括torch save 和torch

  • jvm内存模型与垃圾回收（下）

    上篇地址 jvm内存模型与垃圾回收 上 1 垃圾回收相关算法 标记清除 标记整理 复制 这三个看上面的文章 1 1 分代收集算法 将不同生命周期的对象采用不同的收集方式 以便提高回收效率 一般是将Java堆分为新生代和老年代 这样可以根据各

  • 接口与实现

    public interface Computable 接口体包含常量和抽象方法 没有普通方法 int MAX 46 常量 int f int x 抽象方法 默认权限friendly public class China implement

  • 【C++】使用Windows操作系统的API在控制台输出绿色的文本

    2023年8月21日 周一下午 include

  • linux桌面远程控制,在LINUX下远程控制WIN桌面

    rdesktop 是个在veket下访问视窗系统 远程桌面的客户端程式 当前 rdesktop 所支持的 视窗系统 系列版本包括 NT 2000 XP 和2003 通过使用 rdesktop 所实现的远程桌面协议 RDP 你能在veket系

  • 企业微信群机器人开发

    准备工作 已经注册了有效的企业微信账号 并且在客户端上已经登录 现有或者新建有效的包含多名企业微信成员的群聊 创建群聊机器人 右键群聊 gt 管理聊天信息 gt 添加群机器人 使用群机器人 在终端某个群组添加机器人之后 创建者可以在机器人详

热门标签