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