python wechat --- 企业微信机器人API

wechat — 企业微信机器人

github 源码地址：https://github.com/zly717216/wechat

一、模块介绍

版本号

wechat: V1.1.0

当前版本支持群机器人相关API调用，包括发送文本消息、图片、markdown、文件、模板消息卡片、模板图片卡片。

如何使用

• 1.创建企业微信内部群
• 2.创建机器人，复制 webhook，如：https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxx
• 3.调用机器人API，示例见下文

安装

将 wechat 包复制到 site-pakages 下

二、示例

设置token

方式一：

from wechat import set_token


set_token('xxx')
1
2
3
4

方式二：

from wechat import Robot     # Robot 是一个机器人实例对象


Robot.set_token('xxx')
1
2
3
4

方式三：

from wechat import R        # R 是一个机器人类对象


r = R()
r.set_token('xxx')
1
2
3
4
5

查看token

方式一：

from wechat import Robot


print(Robot.token)
1
2
3
4

方式二：

from wechat import R


r = R()
print(r.token)
1
2
3
4
5

发送文本消息

from wechat import Robot


Robot.send_text('hello word')
# @张三
Robot.send_text('hello word'， mentioned_list=['zhangsan'])
# @所有人
Robot.send_text('hello word'， mentioned_list=['@all'])
1
2
3
4
5
6
7
8

发送图片消息

from wechat import Robot


Robot.send_image(path='D:\\a.png')

# 传入Path路径也可以
from pathlib import Path
Robot.send_image(path=Path('D:\\a.png'))
1
2
3
4
5
6
7
8

发送Markdown消息

from wechat import Robot


Robot.send_markdown(content='**加粗hello world**')
1
2
3
4

发送文件消息

from wechat import Robot


Robot.send_image_text(
    articles=[
        {
            "title": "标题",
            "description": "中秋你快勒马",
            "url": "www.qq.com",
            "picurl": "http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png"
        },
        {
            "title": "标题2",
            "description": "中秋你快勒马 11111111111",
            "url": "www.baidu.com",
            "picurl": "https://inews.gtimg.com/newsapp_ls/0/15237923582_640330/0"
        }
    ]
)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

发送图文消息

from wechat import Robot


Robot.send_file(path='D:\\a.csv')

# 传入Path路径也可以
from pathlib import Path
Robot.send_file(path=Path('D:\\a.csv'))
1
2
3
4
5
6
7
8

发送模板卡片卡片

from wechat import Robot


Robot.send_text_card(
    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"
    }
)
  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

发送模板图片卡片

from wechat import Robot


Robot.send_image_card(
    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"
    }
)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

三、API

wechat 模块API

Robot API

Robot API 参数

set_token 参数：

send_text 参数：

示例：

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

send_markdown 参数：

示例：

{
    "content": "实时新增用户反馈<font color=\"warning\">132例</font>"
}
1
2
3

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

   # 标题一
   ## 标题二
   ### 标题三
   #### 标题四
   ##### 标题五
   ###### 标题六
   1
   2
   3
   4
   5
   6

2. 加粗

   **bold**
   1

3. 链接

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

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

   `code`
   1

5. 引用

   > 引用文字
   1

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

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

send_image 参数：

send_image_text 参数：

articles 字典参数：

• title：描述，不超过512个字节，超过会自动截断
• description：标题，不超过128个字节，超过会自动截断
• url：点击后跳转的链接
• picurl：图文消息的图片链接，支持 JPG、PNG 格式，较好的效果为大图 1068 * 455，小图 150 * 150

示例：

[
    {
        "title" : "中秋节礼品领取",
        "description" : "今年中秋节公司有豪礼相送",
        "url" : "www.qq.com",
        "picurl" : "http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png"
    }
]
1
2
3
4
5
6
7
8

send_file 参数：

send_text_card 参数：

source 字典参数

main_title 字典参数

emphasis_content 字典参数

quote_area 字典参数

horizontal_content_list 嵌套字典参数

jump_list 嵌套字典参数

card_action 嵌套字典参数

示例：

{
    "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"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

send_image_card 参数：

source 字典参数

main_title 字典参数

card_image 字典参数

image_text_area 字典参数

quote_area 字典参数

horizontal_content_list 嵌套字典参数

vertical_content_list 嵌套字典参数

jump_list 嵌套字典参数

card_action 嵌套字典参数

示例：

{
    "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"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

上一篇 python dingding — 钉钉机器人API