648cb4c2
 tangwang
ES docs
|
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
|
原始文档地址：
https://developer.work.weixin.qq.com/document/path/99110
## 目录
- [如何使用消息推送](#如何使用消息推送)
- [消息类型及数据格式](#消息类型及数据格式)
- [文本类型](#文本类型)
- [markdown类型](#markdown类型)
- [markdown_v2类型](#markdown_v2类型)
- [图片类型](#图片类型)
- [图文类型](#图文类型)
- [文件类型](#文件类型)
- [语音类型](#语音类型)
- [模版卡片类型](#模版卡片类型)
- [文本通知模版卡片](#文本通知模版卡片)
- [图文展示模版卡片](#图文展示模版卡片)
- [消息发送频率限制](#消息发送频率限制)
- [文件上传接口](#文件上传接口)
## 如何使用消息推送
- 创建者可以在创建消息推送页面、创建完成页面、消息推送详情页面，看到该消息推送特有的 webhookurl。开发者可以按以下说明向这个地址发起 HTTP POST 请求，即可实现给该群组发送消息。下面举个简单的例子。
假设 webhook 是：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa`
> 特别特别要注意：一定要**保护好消息推送的 webhook 地址**，避免泄漏！不要分享到 GitHub、博客等可被公开查阅的地方，否则坏人就可以用你的消息推送来发垃圾消息了。
以下是用 curl 工具往群组推送文本消息的示例（注意要将 url 替换成你的消息推送 webhook 地址，content 必须是 utf8 编码）：
```bash
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、markdown_v2）、图片（image）、图文（news）、文件（file）、语音（voice）、模板卡片（template_card）八种消息类型。
- 消息推送的 text/markdown 类型消息支持在 content 中使用 `@userid` 扩展语法来 @群成员（markdown_v2 类型消息不支持该扩展语法）
## 消息类型及数据格式
### 文本类型
```json
{
"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 类型
```json
{
"msgtype": "markdown",
"markdown": {
"content": "实时新增用户反馈<font color=\"warning\">132例</font>，请相关同事注意。\n>类型:<font color=\"comment\">用户反馈</font>\n>普通用户反馈:<font color=\"comment\">117例</font>\n>VIP用户反馈:<font color=\"comment\">15例</font>"
}
}
```
| 参数 | 是否必填 | 说明 |
| --- | --- | --- |
| msgtype | 是 | 消息类型，此时固定为 markdown |
| content | 是 | markdown 内容，最长不超过 4096 个字节，必须是 utf8 编码 |
目前支持的 markdown 语法是如下的子集：
1. 标题（支持 1 至 6 级标题，注意 # 与文字中间要有空格）
```markdown
# 标题一
## 标题二
### 标题三
#### 标题四
##### 标题五
###### 标题六
```
2. 加粗
3. 链接
```markdown
[这是一个链接](https://work.weixin.qq.com/api/doc)
```
4. 行内代码段（暂不支持跨行）
5. 引用
6. 字体颜色（只支持 3 种内置颜色）
```markdown
<font color="info">绿色</font>
<font color="comment">灰色</font>
<font color="warning">橙红色</font>
```
### markdown_v2 类型
```json
{
"msgtype": "markdown_v2",
"markdown_v2": {
"content": "# 一、标题\n## 二级标题\n### 三级标题\n# 二、字体\n*斜体*\n\n**加粗**\n# 三、列表 \n- 无序列表 1 \n- 无序列表 2\n - 无序列表 2.1\n - 无序列表 2.2\n1. 有序列表 1\n2. 有序列表 2\n# 四、引用\n> 一级引用\n>>二级引用\n>>>三级引用\n# 五、链接\n[这是一个链接](https:work.weixin.qq.com\\/api\\/doc)\n\n# 六、分割线\n\n---\n# 七、代码\n`这是行内代码`\n```\n这是独立代码块\n```\n\n# 八、表格\n| 姓名 | 文化衫尺寸 | 收货地址 |\n| :----- | :----: | -------: |\n| 张三 | S | 广州 |\n| 李四 | L | 深圳 |\n"
}
}
```
| 参数 | 是否必填 | 说明 |
| --- | --- | --- |
| msgtype | 是 | 消息类型，此时固定为 markdown_v2。 |
| content | 是 | markdown_v2 内容，最长不超过 4096 个字节，必须是 utf8 编码。<br>特殊的，<br>1. markdown_v2 **不支持字体颜色、@群成员** 的语法，具体支持的语法可参考下面说明<br>2. 消息内容在 **客户端 4.1.36 版本以下（安卓端为 4.1.38 以下）** 消息表现为 **纯文本**，建议使用最新客户端版本体验 |
目前支持的 markdown_v2 语法是如下的子集：
1. 标题（支持 1 至 6 级标题，注意 # 与文字中间要有空格）
```markdown
# 标题一
## 标题二
### 标题三
#### 标题四
##### 标题五
###### 标题六
```
2. 字体
3. 列表
```markdown
- 无序列表 1
- 无序列表 2
- 无序列表 2.1
- 无序列表 2.2
1. 有序列表 1
2. 有序列表 2
```
4. 引用
5. 链接
```markdown
[这是一个链接](https://work.weixin.qq.com/api/doc)
```
6. 分割线
7. 代码
```markdown
`这是行内代码`
```
这是独立代码块
```
```
8. 表格
```markdown
| 姓名 | 文化衫尺寸 | 收货地址 |
| :----- | :----: | -------: |
| 张三 | S | 广州 |
| 李四 | L | 深圳 |
```
### 图片类型
```json
{
"msgtype": "image",
"image": {
"base64": "DATA",
"md5": "MD5"
}
}
```
| 参数 | 是否必填 | 说明 |
| --- | --- | --- |
| msgtype | 是 | 消息类型，此时固定为 image |
| base64 | 是 | 图片内容的 base64 编码 |
| md5 | 是 | 图片内容（base64 编码前）的 md5 值 |
> 注：图片（base64 编码前）最大不能超过 2M，支持 JPG、PNG 格式
### 图文类型
```json
{
"msgtype": "news",
"news": {
"articles" : [
{
"title" : "中秋节礼品领取",
"description" : "今年中秋节公司有豪礼相送",
"url" : "www.qq.com",
"picurl" : "https://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 |
### 文件类型
```json
{
"msgtype": "file",
"file": {
"media_id": "3a8asd892asd8asd"
}
}
```
| 参数 | 是否必填 | 说明 |
| --- | --- | --- |
| msgtype | 是 | 消息类型，此时固定为 file |
| media_id | 是 | 文件 id，通过下文的文件上传接口获取 |
### 语音类型
```json
{
"msgtype": "voice",
"voice": {
"media_id": "MEDIA_ID"
}
}
```
| 参数 | 是否必填 | 说明 |
| --- | --- | --- |
| msgtype | 是 | 语音类型，此时固定为 voice |
| media_id | 是 | 语音文件 id，通过下文的文件上传接口获取 |
### 模版卡片类型
#### 文本通知模版卡片
```json
{
"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 时选填 |
#### 图文展示模版卡片
```json
{
"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 | 是 | 文件类型，分别有语音(voice)和普通文件(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--
```
**返回数据：**
```json
{
"errcode": 0,
"errmsg": "ok",
"type": "file",
"media_id": "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0",
"created_at": "1380000000"
}
```
**参数说明：**
| 参数 | 说明 |
| --- | --- |
| type | 文件类型，分别有语音(voice)和普通文件(file) |
| media_id | 媒体文件上传后获取的唯一标识，3 天内有效 |
| created_at | 媒体文件上传时间戳 |
**上传的文件限制：**
所有类型的文件大小均要求大于 5 个字节
- 普通文件(file)：文件大小不超过 20M
- 语音(voice)：文件大小不超过 2M，播放长度不超过 60s，**仅支持** AMR 格式
|