http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E
请求说明
Https请求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=ACCESS_TOKEN
消息型应用支持文本、图片、语音、视频、文件、图文等消息类型。主页型应用只支持文本消息类型，且文本长度不超过20个字。
参数说明
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
权限说明
收件人必须处于应用的可见范围内，并且管理组对应用有使用权限、对收件人有查看权限，否则本次调用失败。
返回结果
如果无权限或收件人不存在，则本次发送失败，返回无效的userid列表（注：由于userid不区分大小写，返回的列表都统一转为小写）；如果未关注，发送仍然执行。
{
"errcode": 0,
"errmsg": "ok",
"invaliduser": "UserID1",
"invalidparty":"PartyID1",
"invalidtag":"TagID1"
}
http://qydev.weixin.qq.com/wiki/index.php?title=%E6%B6%88%E6%81%AF%E7%B1%BB%E5%9E%8B%E5%8F%8A%E6%95%B0%E6%8D%AE%E6%A0%BC%E5%BC%8F
目录
1 text消息
2 p_w_picpath消息
3 voice消息
4 video消息
5 file消息
6 news消息
7 mpnews消息
text消息
{
"touser": "UserID1|UserID2|UserID3",
"toparty": " PartyID1 | PartyID2 ",
"totag": " TagID1 | TagID2 ",
"msgtype": "text",
"agentid": 1,
"text": {
"content": "Holiday Request For Pony(http://xxxxx)"
},
"safe":0
}
| 参数 | 必须 | 说明 |
|---|---|---|
| touser | 否 | 成员ID列表（消息接收者，多个接收者用‘|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送 |
| toparty | 否 | 部门ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| totag | 否 | 标签ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| msgtype | 是 | 消息类型，此时固定为：text （支持消息型应用跟主页型应用） |
| agentid | 是 | 企业应用的id，整型。可在应用的设置页面查看 |
| content | 是 | 消息内容，最长不超过2048个字节，注意：主页型应用推送的文本消息在微信端最多只显示20个字（包含中英文） |
| safe | 否 | 表示是否是保密消息，0表示否，1表示是，默认0 |
p_w_picpath消息
{
"touser": "UserID1|UserID2|UserID3",
"toparty": " PartyID1 | PartyID2 ",
"totag": " TagID1 | TagID2 ",
"msgtype": "p_w_picpath",
"agentid": 1,
"p_w_picpath": {
"media_id": "MEDIA_ID"
},
"safe":0
}
| 参数 | 必须 | 说明 |
|---|---|---|
| touser | 否 | 成员ID列表（消息接收者，多个接收者用‘|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送 |
| toparty | 否 | 部门ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| totag | 否 | 标签ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| msgtype | 是 | 消息类型，此时固定为：p_w_picpath（不支持主页型应用） |
| agentid | 是 | 企业应用的id，整型。可在应用的设置页面查看 |
| media_id | 是 | 图片媒体文件id，可以调用上传临时素材或者永久素材接口获取,永久素材media_id必须由发消息的应用创建 |
| safe | 否 | 表示是否是保密消息，0表示否，1表示是，默认0 |
voice消息
{
"touser": "UserID1|UserID2|UserID3",
"toparty": " PartyID1 | PartyID2 ",
"totag": " TagID1 | TagID2 ",
"msgtype": "voice",
"agentid": 1,
"voice": {
"media_id": "MEDIA_ID"
},
"safe":0
}
| 参数 | 必须 | 说明 |
|---|---|---|
| touser | 否 | 成员ID列表（消息接收者，多个接收者用‘|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送 |
| toparty | 否 | 部门ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| totag | 否 | 标签ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| msgtype | 是 | 消息类型，此时固定为：voice （不支持主页型应用） |
| agentid | 是 | 企业应用的id，整型。可在应用的设置页面查看 |
| media_id | 是 | 语音文件id，可以调用上传临时素材或者永久素材接口获取 |
| safe | 否 | 表示是否是保密消息，0表示否，1表示是，默认0 |
video消息
{
"touser": "UserID1|UserID2|UserID3",
"toparty": " PartyID1 | PartyID2 ",
"totag": " TagID1 | TagID2 ",
"msgtype": "video",
"agentid": 1,
"video": {
"media_id": "MEDIA_ID",
"title": "Title",
"description": "Description"
},
"safe":0
}
| 参数 | 必须 | 说明 |
|---|---|---|
| touser | 否 | 成员ID列表（消息接收者，多个接收者用‘|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送 |
| toparty | 否 | 部门ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| totag | 否 | 标签ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| msgtype | 是 | 消息类型，此时固定为：video （不支持主页型应用） |
| agentid | 是 | 企业应用的id，整型。可在应用的设置页面查看 |
| media_id | 是 | 视频媒体文件id，可以调用上传临时素材或者永久素材接口获取 |
| title | 否 | 视频消息的标题，不超过128个字节，超过会自动截断 |
| description | 否 | 视频消息的描述，不超过512个字节，超过会自动截断 |
| safe | 否 | 表示是否是保密消息，0表示否，1表示是，默认0 |
file消息
{
"touser": "UserID1|UserID2|UserID3",
"toparty": " PartyID1 | PartyID2 ",
"totag": " TagID1 | TagID2 ",
"msgtype": "file",
"agentid": 1,
"file": {
"media_id": "MEDIA_ID"
},
"safe":"0"
}
| 参数 | 必须 | 说明 |
|---|---|---|
| touser | 否 | 成员ID列表（消息接收者，多个接收者用‘|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送 |
| toparty | 否 | 部门ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| totag | 否 | 标签ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| msgtype | 是 | 消息类型，此时固定为：file （不支持主页型应用） |
| agentid | 是 | 企业应用的id，整型。可在应用的设置页面查看 |
| media_id | 是 | 媒体文件id，可以调用上传临时素材或者永久素材接口获取 |
| safe | 否 | 表示是否是保密消息，0表示否，1表示是，默认0 |
news消息
{
"touser": "UserID1|UserID2|UserID3",
"toparty": " PartyID1 | PartyID2 ",
"totag": " TagID1 | TagID2 ",
"msgtype": "news",
"agentid": 1,
"news": {
"articles":[
{
"title": "Title",
"description": "Description",
"url": "URL",
"picurl": "PIC_URL"
},
{
"title": "Title",
"description": "Description",
"url": "URL",
"picurl": "PIC_URL"
}
]
}
}
| 参数 | 必须 | 说明 |
|---|---|---|
| touser | 否 | 成员ID列表（消息接收者，多个接收者用‘|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送 |
| toparty | 否 | 部门ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| totag | 否 | 标签ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| msgtype | 是 | 消息类型，此时固定为：news （不支持主页型应用） |
| agentid | 是 | 企业应用的id，整型。可在应用的设置页面查看 |
| articles | 是 | 图文消息，一个图文消息支持1到8条图文 |
| title | 否 | 标题，不超过128个字节，超过会自动截断 |
| description | 否 | 描述，不超过512个字节，超过会自动截断 |
| url | 否 | 点击后跳转的链接。 |
| picurl | 否 | 图文消息的图片链接，支持JPG、PNG格式，较好的效果为大图640*320，小图80*80。如不填，在客户端不显示图片 |
mpnews消息
注：mpnews消息与news消息类似，不同的是图文消息内容存储在微信后台，并且支持保密选项。每个应用每天最多可以发送100次。
a)发送时直接带上mpnews内容：
{
"touser": "UserID1|UserID2|UserID3",
"toparty": " PartyID1 | PartyID2 ",
"totag": " TagID1 | TagID2 ",
"msgtype": "mpnews",
"agentid": 1,
"mpnews": {
"articles":[
{
"title": "Title",
"thumb_media_id": "id",
"author": "Author",
"content_source_url": "URL",
"content": "Content",
"digest": "Digest description",
"show_cover_pic": "0"
},
{
"title": "Title",
"thumb_media_id": "id",
"author": "Author",
"content_source_url": "URL",
"content": "Content",
"digest": "Digest description",
"show_cover_pic": "0"
}
]
},
"safe":0
}
| 参数 | 必须 | 说明 |
|---|---|---|
| touser | 否 | 成员ID列表（消息接收者，多个接收者用‘|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送 |
| toparty | 否 | 部门ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| totag | 否 | 标签ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| msgtype | 是 | 消息类型，此时固定为：mpnews （不支持主页型应用） |
| agentid | 是 | 企业应用的id，整型。可在应用的设置页面查看 |
| 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个字节，超过会自动截断 |
| show_cover_pic | 否 | 是否显示封面，1为显示，0为不显示 |
| safe | 否 | 表示是否是保密消息，0表示否，1表示是，默认0 |
b)发送时使用永久图文素材ID：
{
"touser": "UserI1|UserID2|UserID3",
"toparty": " PartyID1 | PartyID2 ",
"msgtype": "mpnews",
"agentid": 1,
"mpnews": {
"media_id": "MEDIA_ID"
},
"safe": 0
}
| 参数 | 必须 | 说明 |
|---|---|---|
| touser | 否 | 成员ID列表（消息接收者，多个接收者用‘|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送 |
| toparty | 否 | 部门ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| totag | 否 | 标签ID列表，多个接收者用‘|’分隔，最多支持100个。当touser为@all时忽略本参数 |
| msgtype | 是 | 消息类型，此时固定为：mpnews （不支持主页型应用） |
| agentid | 是 | 企业应用的id，整型。可在应用的设置页面查看 |
| media_id | 是 | 素材资源标识ID，通过上传永久图文素材接口获得。注：必须是在该agent下创建的。 |
| safe | 否 | 表示是否是保密消息，0表示否，1表示是，默认0 |