模板消息接口
模板消息接口
模板消息僅用于公眾號向用戶發(fā)送重要的服務(wù)通知,只能用于符合其要求的服務(wù)場景中,如信用卡刷卡通知,商品購買成功通知等。不支持廣告等營銷類消息以及其它所有可能對用戶造成騷擾的消息。
關(guān)于使用規(guī)則,請注意:
1、所有服務(wù)號都可以在功能->添加功能插件處看到申請模板消息功能的入口,但只有認(rèn)證后的服務(wù)號才可以申請模板消息的使用權(quán)限并獲得該權(quán)限; 2、需要選擇公眾賬號服務(wù)所處的2個(gè)行業(yè),每月可更改1次所選行業(yè); 3、在所選擇行業(yè)的模板庫中選用已有的模板進(jìn)行調(diào)用; 4、每個(gè)賬號可以同時(shí)使用25個(gè)模板。 5、當(dāng)前每個(gè)賬號的模板消息的日調(diào)用上限為10萬次,單個(gè)模板沒有特殊限制?!?014年11月18日將接口調(diào)用頻率從默認(rèn)的日1萬次提升為日10萬次,可在MP登錄后的開發(fā)者中心查看】。當(dāng)賬號粉絲數(shù)超過10W/100W/1000W時(shí),模板消息的日調(diào)用上限會(huì)相應(yīng)提升,以公眾號MP后臺開發(fā)者中心頁面中標(biāo)明的數(shù)字為準(zhǔn)。
關(guān)于接口文檔,請注意:
1、模板消息調(diào)用時(shí)主要需要模板ID和模板中各參數(shù)的賦值內(nèi)容; 2、模板中參數(shù)內(nèi)容必須以".DATA"結(jié)尾,否則視為保留字; 3、模板保留符號"{{ }}"。
設(shè)置所屬行業(yè)
設(shè)置行業(yè)可在MP中完成,每月可修改行業(yè)1次,賬號僅可使用所屬行業(yè)中相關(guān)的模板,為方便第三方開發(fā)者,提供通過接口調(diào)用的方式來修改賬號所屬行業(yè),具體如下:
接口調(diào)用請求說明
http請求方式: POST https://api.weixin.qq.com/cgi-bin/template/api_set_industry?access_token=ACCESS_TOKEN
POST數(shù)據(jù)說明
POST數(shù)據(jù)示例如下:
{ "industry_id1":"1", "industry_id2":"4" }
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 接口調(diào)用憑證 |
industry_id1 | 是 | 公眾號模板消息所屬行業(yè)編號 |
industry_id2 | 是 | 公眾號模板消息所屬行業(yè)編號 |
行業(yè)代碼查詢
主行業(yè) | 副行業(yè) | 代碼 |
---|---|---|
IT科技 | 互聯(lián)網(wǎng)/電子商務(wù) | 1 |
IT科技 | IT軟件與服務(wù) | 2 |
IT科技 | IT硬件與設(shè)備 | 3 |
IT科技 | 電子技術(shù) | 4 |
IT科技 | 通信與運(yùn)營商 | 5 |
IT科技 | 網(wǎng)絡(luò)游戲 | 6 |
金融業(yè) | 銀行 | 7 |
金融業(yè) | 基金|理財(cái)|信托 | 8 |
金融業(yè) | 保險(xiǎn) | 9 |
餐飲 | 餐飲 | 10 |
酒店旅游 | 酒店 | 11 |
酒店旅游 | 旅游 | 12 |
運(yùn)輸與倉儲 | 快遞 | 13 |
運(yùn)輸與倉儲 | 物流 | 14 |
運(yùn)輸與倉儲 | 倉儲 | 15 |
教育 | 培訓(xùn) | 16 |
教育 | 院校 | 17 |
政府與公共事業(yè) | 學(xué)術(shù)科研 | 18 |
政府與公共事業(yè) | 交警 | 19 |
政府與公共事業(yè) | 博物館 | 20 |
政府與公共事業(yè) | 公共事業(yè)|非盈利機(jī)構(gòu) | 21 |
醫(yī)藥護(hù)理 | 醫(yī)藥醫(yī)療 | 22 |
醫(yī)藥護(hù)理 | 護(hù)理美容 | 23 |
醫(yī)藥護(hù)理 | 保健與衛(wèi)生 | 24 |
交通工具 | 汽車相關(guān) | 25 |
交通工具 | 摩托車相關(guān) | 26 |
交通工具 | 火車相關(guān) | 27 |
交通工具 | 飛機(jī)相關(guān) | 28 |
房地產(chǎn) | 建筑 | 29 |
房地產(chǎn) | 物業(yè) | 30 |
消費(fèi)品 | 消費(fèi)品 | 31 |
商業(yè)服務(wù) | 法律 | 32 |
商業(yè)服務(wù) | 會(huì)展 | 33 |
商業(yè)服務(wù) | 中介服務(wù) | 34 |
商業(yè)服務(wù) | 認(rèn)證 | 35 |
商業(yè)服務(wù) | 審計(jì) | 36 |
文體娛樂 | 傳媒 | 37 |
文體娛樂 | 體育 | 38 |
文體娛樂 | 娛樂休閑 | 39 |
印刷 | 印刷 | 40 |
其它 | 其它 | 41 |
獲取設(shè)置的行業(yè)信息
獲取帳號設(shè)置的行業(yè)信息??稍贛P官網(wǎng)中查看行業(yè)信息,為方便第三方開發(fā)者,提供通過接口調(diào)用的方式來獲取帳號所設(shè)置的行業(yè)信息,具體如下:
接口調(diào)用請求說明
http請求方式:GET https://api.weixin.qq.com/cgi-bin/template/get_industry?access_token=ACCESS_TOKEN
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 接口調(diào)用憑證 |
返回說明
正確調(diào)用后的返回示例:
{ "primary_industry":{"first_class":"運(yùn)輸與倉儲","second_class":"快遞"}, "secondary_industry":{"first_class":"IT科技","second_class":"互聯(lián)網(wǎng)|電子商務(wù)"} }
返回參數(shù)說明
參數(shù) | 是否必填 | 說明 |
---|---|---|
access_token | 是 | 接口調(diào)用憑證 |
primary_industry | 是 | 帳號設(shè)置的主營行業(yè) |
secondary_industry | 是 | 帳號設(shè)置的副營行業(yè) |
獲得模板ID
從行業(yè)模板庫選擇模板到帳號后臺,獲得模板ID的過程可在MP中完成。為方便第三方開發(fā)者,提供通過接口調(diào)用的方式來獲取模板ID,具體如下:
接口調(diào)用請求說明
http請求方式: POST https://api.weixin.qq.com/cgi-bin/template/api_add_template?access_token=ACCESS_TOKEN
POST數(shù)據(jù)說明
POST數(shù)據(jù)示例如下:
{ "template_id_short":"TM00015" }
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 接口調(diào)用憑證 |
template_id_short | 是 | 模板庫中模板的編號,有“TM**”和“OPENTMTM**”等形式 |
返回碼說明
在調(diào)用模板消息接口后,會(huì)返回JSON數(shù)據(jù)包。正常時(shí)的返回JSON數(shù)據(jù)包示例:
{ "errcode":0, "errmsg":"ok", "template_id":"Doclyl5uP7Aciu-qZ7mJNPtWkbkYnWBWVja26EGbNyk" }
獲取模板列表
獲取已添加至帳號下所有模板列表,可在MP中查看模板列表信息,為方便第三方開發(fā)者,提供通過接口調(diào)用的方式來獲取帳號下所有模板信息,具體如下:
接口調(diào)用請求說明
http請求方式:GET https://api.weixin.qq.com/cgi-bin/template/get_all_private_template?access_token=ACCESS_TOKEN
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 接口調(diào)用憑證 |
返回說明
正確調(diào)用后的返回示例:
{ "template_list": [{ "template_id": "iPk5sOIt5X_flOVKn5GrTFpncEYTojx6ddbt8WYoV5s", "title": "領(lǐng)取獎(jiǎng)金提醒", "primary_industry": "IT科技", "deputy_industry": "互聯(lián)網(wǎng)|電子商務(wù)", "content": "{ {result.DATA} }\n\n領(lǐng)獎(jiǎng)金額:{ {withdrawMoney.DATA} }\n領(lǐng)獎(jiǎng) 時(shí)間:{ {withdrawTime.DATA} }\n銀行信息:{ {cardInfo.DATA} }\n到賬時(shí)間: { {arrivedTime.DATA} }\n{ {remark.DATA} }", "example": "您已提交領(lǐng)獎(jiǎng)申請\n\n領(lǐng)獎(jiǎng)金額:xxxx元\n領(lǐng)獎(jiǎng)時(shí)間:2013-10-10 12:22:22\n銀行信息:xx銀行(尾號xxxx)\n到賬時(shí)間:預(yù)計(jì)xxxxxxx\n\n預(yù)計(jì)將于xxxx到達(dá)您的銀行卡" }] }
返回參數(shù)說明
參數(shù) | 是否必填 | 說明 |
---|---|---|
access_token | 是 | 接口調(diào)用憑證 |
template_id | 是 | 模板ID |
title | 是 | 模板標(biāo)題 |
primary_industry | 是 | 模板所屬行業(yè)的一級行業(yè) |
deputy_industry | 是 | 模板所屬行業(yè)的二級行業(yè) |
content | 是 | 模板內(nèi)容 |
example | 是 | 模板示例 |
刪除模板
刪除模板可在MP中完成,為方便第三方開發(fā)者,提供通過接口調(diào)用的方式來刪除某帳號下的模板,具體如下:
接口調(diào)用請求說明
http請求方式:POST https://api.weixin.qq.com/cgi-bin/template/del_private_template?access_token=ACCESS_TOKEN
POST數(shù)據(jù)說明如下:
{ "template_id" : "Dyvp3-Ff0cnail_CDSzk1fIc6-9lOkxsQE7exTJbwUE" }
參數(shù)說明
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 接口調(diào)用憑證 |
template_id | 是 | 公眾帳號下模板消息ID |
返回說明
在調(diào)用接口后,會(huì)返回JSON數(shù)據(jù)包。正常時(shí)的返回JSON數(shù)據(jù)包示例:
{ "errcode" : 0, "errmsg" : "ok" }
發(fā)送模板消息
接口調(diào)用請求說明
http請求方式: POST https://api.weixin.qq.com/cgi-bin/message/template/send?access_token=ACCESS_TOKEN
POST數(shù)據(jù)說明
POST數(shù)據(jù)示例如下:
{ "touser":"OPENID", "template_id":"ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY", "url":"http://weixin.qq.com/download", "data":{ "first": { "value":"恭喜你購買成功!", "color":"#173177" }, "keynote1":{ "value":"巧克力", "color":"#173177" }, "keynote2": { "value":"39.8元", "color":"#173177" }, "keynote3": { "value":"2014年9月22日", "color":"#173177" }, "remark":{ "value":"歡迎再次購買!", "color":"#173177" } } }
參數(shù)說明
參數(shù) | 是否必填 | 說明 |
---|---|---|
touser | 是 | 接收者openid |
template_id | 是 | 模板ID |
url | 否 | 模板跳轉(zhuǎn)鏈接 |
data | 是 | 模板數(shù)據(jù) |
返回碼說明
在調(diào)用模板消息接口后,會(huì)返回JSON數(shù)據(jù)包。正常時(shí)的返回JSON數(shù)據(jù)包示例:
{ "errcode":0, "errmsg":"ok", "msgid":200228332 }
事件推送
在模版消息發(fā)送任務(wù)完成后,微信服務(wù)器會(huì)將是否送達(dá)成功作為通知,發(fā)送到開發(fā)者中心中填寫的服務(wù)器配置地址中。
1、送達(dá)成功時(shí),推送的XML如下:
<xml> <ToUserName><![CDATA[gh_7f083739789a]]></ToUserName> <FromUserName><![CDATA[oia2TjuEGTNoeX76QEjQNrcURxG8]]></FromUserName> <CreateTime>1395658920</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[TEMPLATESENDJOBFINISH]]></Event> <MsgID>200163836</MsgID> <Status><![CDATA[success]]></Status> </xml>
參數(shù)說明
參數(shù) | 說明 |
---|---|
ToUserName | 公眾號微信號 |
FromUserName | 接收模板消息的用戶的openid |
CreateTime | 創(chuàng)建時(shí)間 |
MsgType | 消息類型是事件 |
Event | 事件為模板消息發(fā)送結(jié)束 |
MsgID | 消息id |
Status | 發(fā)送狀態(tài)為成功 |
2、送達(dá)由于用戶拒收(用戶設(shè)置拒絕接收公眾號消息)而失敗時(shí),推送的XML如下:
<xml> <ToUserName><![CDATA[gh_7f083739789a]]></ToUserName> <FromUserName><![CDATA[oia2TjuEGTNoeX76QEjQNrcURxG8]]></FromUserName> <CreateTime>1395658984</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[TEMPLATESENDJOBFINISH]]></Event> <MsgID>200163840</MsgID> <Status><![CDATA[failed:user block]]></Status> </xml>
參數(shù)說明
參數(shù) | 說明 |
---|---|
ToUserName | 公眾號微信號 |
FromUserName | 接收模板消息的用戶的openid |
CreateTime | 創(chuàng)建時(shí)間 |
MsgType | 消息類型是事件 |
Event | 事件為模板消息發(fā)送結(jié)束 |
MsgID | 消息id |
Status | 發(fā)送狀態(tài)為用戶拒絕接收 |
3、送達(dá)由于其他原因失敗時(shí),推送的XML如下:
<xml> <ToUserName><![CDATA[gh_7f083739789a]]></ToUserName> <FromUserName><![CDATA[oia2TjuEGTNoeX76QEjQNrcURxG8]]></FromUserName> <CreateTime>1395658984</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[TEMPLATESENDJOBFINISH]]></Event> <MsgID>200163840</MsgID> <Status><![CDATA[failed: system failed]]></Status> </xml>
參數(shù)說明
參數(shù) | 說明 |
---|---|
ToUserName | 公眾號微信號 |
FromUserName | 接收模板消息的用戶的openid |
CreateTime | 創(chuàng)建時(shí)間 |
MsgType | 消息類型是事件 |
Event | 事件為模板消息發(fā)送結(jié)束 |
MsgID | 消息id |
Status | 發(fā)送狀態(tài)為發(fā)送失?。ǚ怯脩艟芙^) |