微信企業(yè)號開發(fā)之如何發(fā)送消息
企業(yè)可以主動發(fā)消息給員工,消息量不受限制。
調(diào)用接口時,使用Https協(xié)議、JSON數(shù)據(jù)包格式,數(shù)據(jù)包不需做加密處理。
目前支持文本、圖片、語音、視頻、文件、圖文等消息類型。除了news類型,其它類型的消息可在發(fā)送時加上保密選項,保密消息會被打上水印,并且只有接收者才能閱讀。
一、發(fā)送接口說明
- 請求說明
Https請求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=ACCESS_TOKEN
- 參數(shù)說明
參數(shù) | 必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
- 權(quán)限要求
需要管理員對應(yīng)用有使用權(quán)限,對收件人touser、toparty、totag有查看權(quán)限,否則本次調(diào)用失敗。
- 返回結(jié)果
如果對應(yīng)用或收件人、部門、標(biāo)簽任何一個無權(quán)限,則本次發(fā)送失?。蝗绻占?、部門或標(biāo)簽不存在,發(fā)送仍然執(zhí)行,但返回?zé)o效的部分。
- {
- "errcode": 0,
- "errmsg": "ok",
- "invaliduser": "UserID1",
- "invalidparty":"PartyID1",
- "invalidtag":"TagID1"
- }
二、消息類型及數(shù)據(jù)格式
- 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"
- }
參數(shù) | 必須 | 說明 |
---|---|---|
touser | 否 | UserID列表(消息接收者,多個接收者用‘|’分隔)。特殊情況:指定為@all,則向關(guān)注該企業(yè)應(yīng)用的全部成員發(fā)送 |
toparty | 否 | PartyID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
totag | 否 | TagID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
msgtype | 是 | 消息類型,此時固定為:text |
agentid | 是 | 企業(yè)應(yīng)用的id,整型??稍趹?yīng)用的設(shè)置頁面查看 |
content | 是 | 消息內(nèi)容 |
safe | 否 | 表示是否是保密消息,0表示否,1表示是,默認(rèn)0 |
- image消息
- {
- "touser": "UserID1|UserID2|UserID3",
- "toparty": " PartyID1 | PartyID2 ",
- "msgtype": "image",
- "agentid": "1",
- "image": {
- "media_id": "MEDIA_ID"
- },
- "safe":"0"
- }
參數(shù) | 必須 | 說明 |
---|---|---|
touser | 否 | UserID列表(消息接收者,多個接收者用‘|’分隔)。特殊情況:指定為@all,則向關(guān)注該企業(yè)應(yīng)用的全部成員發(fā)送 |
toparty | 否 | PartyID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
totag | 否 | TagID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
msgtype | 是 | 消息類型,此時固定為:image |
agentid | 是 | 企業(yè)應(yīng)用的id,整型??稍趹?yīng)用的設(shè)置頁面查看 |
media_id | 是 | 媒體資源文件ID |
safe | 否 | 表示是否是保密消息,0表示否,1表示是,默認(rèn)0 |
- voice消息
- {
- "touser": "UserID1|UserID2|UserID3",
- "toparty": " PartyID1 | PartyID2 ",
- "totag": " TagID1 | TagID2 ",
- "msgtype": "voice",
- "agentid": "1",
- "voice": {
- "media_id": "MEDIA_ID"
- },
- "safe":"0"
- }
參數(shù) | 必須 | 說明 |
---|---|---|
touser | 否 | UserID列表(消息接收者,多個接收者用‘|’分隔)。特殊情況:指定為@all,則向關(guān)注該企業(yè)應(yīng)用的全部成員發(fā)送 |
toparty | 否 | PartyID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
totag | 否 | TagID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
msgtype | 是 | 消息類型,此時固定為:voice |
agentid | 是 | 企業(yè)應(yīng)用的id,整型??稍趹?yīng)用的設(shè)置頁面查看 |
media_id | 是 | 媒體資源文件ID |
safe | 否 | 表示是否是保密消息,0表示否,1表示是,默認(rèn)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"
- }
參數(shù) | 必須 | 說明 |
---|---|---|
touser | 否 | UserID列表(消息接收者,多個接收者用‘|’分隔)。特殊情況:指定為@all,則向關(guān)注該企業(yè)應(yīng)用的全部成員發(fā)送 |
toparty | 否 | PartyID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
totag | 否 | TagID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
msgtype | 是 | 消息類型,此時固定為:video |
agentid | 是 | 企業(yè)應(yīng)用的id,整型??稍趹?yīng)用的設(shè)置頁面查看 |
media_id | 是 | 媒體資源文件ID |
title | 否 | 視頻消息的標(biāo)題 |
description | 否 | 視頻消息的描述 |
safe | 否 | 表示是否是保密消息,0表示否,1表示是,默認(rèn)0 |
- file消息
- {
- "touser": "UserID1|UserID2|UserID3",
- "toparty": " PartyID1 | PartyID2 ",
- "totag": " TagID1 | TagID2 ",
- "msgtype": "file",
- "agentid": "1",
- "file": {
- "media_id": "MEDIA_ID"
- },
- "safe":"0"
- }
參數(shù) | 必須 | 說明 |
---|---|---|
touser | 否 | UserID列表(消息接收者,多個接收者用‘|’分隔)。特殊情況:指定為@all,則向關(guān)注該企業(yè)應(yīng)用的全部成員發(fā)送 |
toparty | 否 | PartyID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
totag | 否 | TagID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
msgtype | 是 | 消息類型,此時固定為:file |
agentid | 是 | 企業(yè)應(yīng)用的id,整型??稍趹?yīng)用的設(shè)置頁面查看 |
media_id | 是 | 文件ID |
safe | 否 | 表示是否是保密消息,0表示否,1表示是,默認(rèn)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",
- }
- ]
- }
- }
參數(shù) | 必須 | 說明 |
---|---|---|
touser | 否 | UserID列表(消息接收者,多個接收者用‘|’分隔)。特殊情況:指定為@all,則向關(guān)注該企業(yè)應(yīng)用的全部成員發(fā)送 |
toparty | 否 | PartyID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
totag | 否 | TagID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
msgtype | 是 | 消息類型,此時固定為:news |
agentid | 是 | 企業(yè)應(yīng)用的id,整型??稍趹?yīng)用的設(shè)置頁面查看 |
title | 否 | 標(biāo)題 |
description | 否 | 描述 |
url | 否 | 點擊后跳轉(zhuǎn)的鏈接。企業(yè)可根據(jù)url里面帶的code參數(shù)校驗員工的真實身份。具體參考“9 微信頁面跳轉(zhuǎn)員工身份查詢” |
picurl | 否 | 圖文消息的圖片鏈接,支持JPG、PNG格式,較好的效果為大圖640*320,小圖80*80。如不填,在客戶端不顯示圖片 |
- mpnews消息
注:mpnews消息與news消息類似,不同的是圖文消息內(nèi)容存儲在微信后臺,并且支持保密選項。
- {
- "touser": "UserID1|UserID2|UserID3",
- "toparty": " PartyID1 | PartyID2 ",
- "totag": " TagID1 | TagID2 ",
- "msgtype": "mpnews",
- "agentid": "1",
- "mpnews": {
- "articles":[
- {
- "thumb_media_id": "id",
- "author": "Author",
- "content_source_url": "URL",
- "content": "Content"
- "digest": "Digest description",
- "show_cover_pic": "0"
- },
- {
- "thumb_media_id": "id",
- "author": "Author",
- "content_source_url": "URL",
- "content": "Content"
- "digest": "Digest description",
- "show_cover_pic": "0"
- }
- ]
- "media_id": "id"
- }
- "safe":"0"
- }
參數(shù) | 必須 | 說明 |
---|---|---|
touser | 否 | UserID列表(消息接收者,多個接收者用‘|’分隔)。特殊情況:指定為@all,則向關(guān)注該企業(yè)應(yīng)用的全部成員發(fā)送 |
toparty | 否 | PartyID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
totag | 否 | TagID列表,多個接受者用‘|’分隔。當(dāng)touser為@all時忽略本參數(shù) |
msgtype | 是 | 消息類型,此時固定為:mpnews |
agentid | 是 | 企業(yè)應(yīng)用的id,整型??稍趹?yīng)用的設(shè)置頁面查看 |
articles | 是 | 圖文消息,一個圖文消息支持1到10個圖文 |
thumb_media_id | 是 | 圖文消息縮略圖的media_id, 可以在上傳多媒體文件接口中獲得。此處thumb_media_id即上傳接口返回的media_id |
title | 是 | 圖文消息的標(biāo)題 |
author | 否 | 圖文消息的作者 |
content_source_url | 否 | 圖文消息點擊“閱讀原文”之后的頁面鏈接 |
content | 是 | 圖文消息的內(nèi)容,支持html標(biāo)簽 |
digest | 否 | 圖文消息的描述 |
show_cover_pic | 否 | 是否顯示封面,1為顯示,0為不顯示 |
safe | 否 | 表示是否是保密消息,0表示否,1表示是,默認(rèn)0 |