微信小程序API 接收消息和事件
接收消息和事件
在頁(yè)面中使用 <contact-button/>
可以顯示進(jìn)入客服會(huì)話按鈕。
當(dāng)用戶在客服會(huì)話發(fā)送消息(或進(jìn)行某些特定的用戶操作引發(fā)的事件推送時(shí)),微信服務(wù)器會(huì)將消息(或事件)的數(shù)據(jù)包(JSON或者XML格式)POST請(qǐng)求開(kāi)發(fā)者填寫(xiě)的URL。開(kāi)發(fā)者收到請(qǐng)求后可以使用發(fā)送客服消息接口進(jìn)行異步回復(fù)。
微信服務(wù)器在將用戶的消息發(fā)給小程序的開(kāi)發(fā)者服務(wù)器地址(開(kāi)發(fā)設(shè)置處配置)后,微信服務(wù)器在五秒內(nèi)收不到響應(yīng)會(huì)斷掉連接,并且重新發(fā)起請(qǐng)求,總共重試三次,如果在調(diào)試中,發(fā)現(xiàn)用戶無(wú)法收到響應(yīng)的消息,可以檢查是否消息處理超時(shí)。關(guān)于重試的消息排重,有msgid的消息推薦使用msgid排重。事件類(lèi)型消息推薦使用FromUserName + CreateTime 排重。
服務(wù)器收到請(qǐng)求如果#不需要轉(zhuǎn)發(fā)到客服工具#,必須做出下述回復(fù),這樣微信服務(wù)器才不會(huì)對(duì)此作任何處理,并且不會(huì)發(fā)起重試,否則,將出現(xiàn)嚴(yán)重的錯(cuò)誤提示。詳見(jiàn)下面說(shuō)明:
1、直接回復(fù)success(推薦方式) 2、直接回復(fù)空串(指字節(jié)長(zhǎng)度為0的空字符串,而不是結(jié)構(gòu)體中content字段的內(nèi)容為空)
一旦遇到以下情況,微信都會(huì)在小程序會(huì)話中,向用戶下發(fā)系統(tǒng)提示“該小程序客服暫時(shí)無(wú)法提供服務(wù),請(qǐng)稍后再試”:
1、開(kāi)發(fā)者在5秒內(nèi)未回復(fù)任何內(nèi)容 2、開(kāi)發(fā)者回復(fù)了異常數(shù)據(jù)
如果開(kāi)發(fā)者希望把消息或事件轉(zhuǎn)發(fā)到客服工具,請(qǐng)參看轉(zhuǎn)發(fā)消息到客服工具。客服工具接入請(qǐng)參考客服工具使用說(shuō)明
如果開(kāi)發(fā)者希望增強(qiáng)安全性,可以在開(kāi)發(fā)者中心處開(kāi)啟消息加密,這樣,用戶發(fā)給小程序的消息以及小程序被動(dòng)回復(fù)用戶消息都會(huì)繼續(xù)加密,詳見(jiàn)消息加解密說(shuō)明。
各消息類(lèi)型的推送JSON、XML數(shù)據(jù)包結(jié)構(gòu)如下。
文本消息
用戶在客服會(huì)話中發(fā)送文本消息時(shí)將產(chǎn)生如下數(shù)據(jù)包:
XML 格式
<xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>1482048670</CreateTime> <MsgType><![CDATA[text]]></MsgType> <Content><![CDATA[this is a test]]></Content> <MsgId>1234567890123456</MsgId> </xml>
JSON 格式
{ "ToUserName": "toUser", "FromUserName": "fromUser", "CreateTime": 1482048670, "MsgType": "text", "Content": "this is a test", "MsgId": 1234567890123456 }
參數(shù)說(shuō)明
圖片消息
用戶在客服會(huì)話中發(fā)送圖片消息時(shí)將產(chǎn)生如下數(shù)據(jù)包:
XML 格式
<xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>1482048670</CreateTime> <MsgType><![CDATA[image]]></MsgType> <PicUrl><![CDATA[this is a url]]></PicUrl> <MediaId><![CDATA[media_id]]></MediaId> <MsgId>1234567890123456</MsgId> </xml>
JSON 格式
{ "ToUserName": "toUser", "FromUserName": "fromUser", "CreateTime": 1482048670, "MsgType": "image", "PicUrl": "this is a url", "MediaId": "media_id", "MsgId": 1234567890123456 }
參數(shù)說(shuō)明
進(jìn)入會(huì)話事件
用戶在小程序“客服會(huì)話按鈕”進(jìn)入客服會(huì)話時(shí)將產(chǎn)生如下數(shù)據(jù)包:
XML 格式
<xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>1482048670</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[user_enter_tempsession]]></Event> <SessionFrom><![CDATA[sessionFrom]]></SessionFrom> </xml>
JSON 格式
{ "ToUserName": "toUser", "FromUserName": "fromUser", "CreateTime": 1482048670, "MsgType": "event", "Event": "user_enter_tempsession", "SessionFrom": "sessionFrom" }
參數(shù)說(shuō)明
轉(zhuǎn)發(fā)消息到客服工具
如果開(kāi)發(fā)者希望消息被轉(zhuǎn)發(fā)到客服工具處理,請(qǐng)按照下述結(jié)構(gòu)返回響應(yīng)包。響應(yīng)包的數(shù)據(jù)格式(XML或JSON)需要與設(shè)置的接收消息數(shù)據(jù)格式一致。
XML 格式
<xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>1482048670</CreateTime> <MsgType><![CDATA[transfer_customer_service]]></MsgType> </xml>
JSON 格式
{ "ToUserName": "toUser", "FromUserName": "fromUser", "CreateTime": 1482048670, "MsgType": "transfer_customer_service", }