使用Python开发企业微信群机器人

企业微信的群组支持给群组添加群机器人，添加完群机器人后就可以使用群机器人在群内同步消息。群机器人创建者可以在机器人详情页看到该机器人特有的 webhook url。开发者可以向这个地址发起 HTTP POST 请求，即可实现给该群组发送消息。

启用示例：

示例代码：

import requests
import json

webhook = 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx'

header = {
"Content-Type": "application/json",
"Charset": "UTF-8"
}
data = {

"msgtype": "text",
"text": {
"content": "Hello World!"
}
}
data = json.dumps(data)
info = requests.post(url=webhook, data=data, headers=header)

群机器人发送消息的一些限制：

• 目前暂不支持设置消息回调配置。支持设置机器人主动推送。
• 群聊可添加的机器人数量暂无上限。
• 机器人发消息的频率：每个机器人发送的消息不能超过 20 条/分钟。
• 文件大小在 5B~20M 之间；图文消息的图片链接，支持 JPG、PNG 格式，较好的效果为大图 1068×455，小图 150×150
• 图片（base64 编码前）最大不能超过 2M，支持 JPG,PNG 格式。

群机器人支持的消息类型

当前自定义机器人支持文本（text）、markdown（markdown）、图片（image）、图文（news）、文件（file）、语音（voice）、模板卡片（template_card）七种消息类型。机器人的 text/markdown 类型消息支持在 content 中使用 <@userid> 扩展语法来 @群成员

文件上传接口

素材上传得到 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”

参数说明：

POST 的请求包中，form-data 中媒体文件标识，应包含有filename、filelength、content-type 等信息。filename 标识文件展示的名称。比如，使用该 media_id 发消息时，展示的文件名由该字段控制请求示例：

import requests

def upload_media(file_path, key, media_type):
url = f"https://qyapi.weixin.qq.com/cgi-bin/webhook/upload_media?key={key}&type={media_type}"

# 打开文件并准备上传
with open(file_path, 'rb') as file:
# 准备 multipart/form-data 数据
files = {
'media': (file_path, file, 'application/octet-stream')
}

# 发送 POST 请求
response = requests.post(url, files=files)

# 检查响应状态
if response.status_code == 200:
return response.json()
else:
response.raise_for_status()

返回数据：

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

参数说明：

上传的文件限制：

所有类型的文件大小均要求大于 5 个字节

• 普通文件(file)：文件大小不超过 20M
• 语音(voice)：文件大小不超过 2M，播放长度不超过 60s，仅支持 AMR 格式

文本类型消息

{
"msgtype": "text",
"text": {
"content": "广州今日天气：29 度，大部分多云，降雨概率：60%",
"mentioned_list": ["wangqing", "@all"],
"mentioned_mobile_list": ["13800001111", "@all"]
}
}

Python封装：

import requests
import json


# 发送文本消息
def send_text(webhook, content, mentioned_list=None, mentioned_mobile_list=None):
    header = {
        "Content-Type": "application/json",
        "Charset": "UTF-8"
    }
    data = {
        "msgtype": "text",
        "text": {
            "content": content,
            "mentioned_list": mentioned_list,
            "mentioned_mobile_list": mentioned_mobile_list
        }
    }
    data = json.dumps(data)
    response = requests.post(url=webhook, data=data, headers=header)
    return response

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>"
    }
}

支持的markdown语法

目前支持的markdown语法是如下的子集：

标题（支持1至6级标题，注意#与文字中间要有空格）

# 标题一
## 标题二
### 标题三
#### 标题四
##### 标题五
###### 标题六

加粗

**bold**

链接

[这是一个链接](http://work.weixin.qq.com/api/doc)

行内代码段（暂不支持跨行）

`code`

引用

>引用文字

字体颜色(只支持3种内置颜色)

<font color="info">绿色</font>
<font color="comment">灰色</font>
<font color="warning">橙红色</font>

Python封装：

import requests
import json


# 发送markdown消息
def send_md(webhook, content):
    header = {
        "Content-Type": "application/json",
        "Charset": "UTF-8"
    }
    data = {
        "msgtype": "markdown",
        "markdown": {
            "content": content
        }
    }
    data = json.dumps(data)
    response = requests.post(url=webhook, data=data, headers=header)
    return response

图片类型消息

{
    "msgtype": "image",
    "image": {
        "base64": "DATA",
        "md5": "MD5"
    }
}

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

Python封装：

```python
import requests
import json
import base64
import hashlib


# 发送图片消息
def send_image(webhook, image_path):
    header = {
        "Content-Type": "application/json",
        "Charset": "UTF-8"
    }

    # 读取图片文件并进行base64编码
    with open(image_path, "rb") as image_file:
        image_data = image_file.read()
        base64_data = base64.b64encode(image_data).decode('utf-8')

    # 计算图片的MD5值
    md5_hash = hashlib.md5(image_data).hexdigest()

    data = {
        "msgtype": "image",
        "image": {
            "base64": base64_data,
            "md5": md5_hash
        }
    }
    data = json.dumps(data)
    response = requests.post(url=webhook, data=data, headers=header)
    return response

图文类型消息

{
    "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": "file",
    "file": {
        "media_id": "3a8asd892asd8asd"
    }
}

语音类型消息

{
    "msgtype": "voice",
    "voice": {
        "media_id": "MEDIA_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"
        }
    }
}

请求参数

“`类型

template_card 的参数说明

跳转链接的 url，jump_list.type 是 1 时必填

图文展示模版卡片

{
"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"
}
}
}

请求参数

template_card 的参数说明

card_image.aspect_ratio

卡片跳转类型，1代表跳转url，2代表打开小程序。news_notice模版卡片中该字段取值范围为[1,2]

重复的轮子：

• https://github.com/cosco-chiyz/wegroupchatbot
• https://github.com/GentleCP/corpwechatbot
• https://github.com/codepkgs/wechat-robot

参考链接：

• 如何设置群机器人-帮助中心-企业微信(qq.com)
• 群机器人配置说明-文档-企业微信开发者中心(qq.com)