支付寶小程序擴(kuò)展能力 消息組件使用手冊(cè)

介紹

系統(tǒng)定位

集成支付寶各產(chǎn)品消息發(fā)送渠道，提供統(tǒng)一消息發(fā)送操作入口和系統(tǒng)集成接口。支持的消息渠道包含：小程序模板消息、生活號(hào)模板消息、支付寶服務(wù)提醒及通知消息、短信以及釘釘消息（目前僅支持小程序模板消息和短信）。

系統(tǒng)功能

包含消息模板配置和消息發(fā)送兩大功能，以及 token 存儲(chǔ)功能。

消息模板配置

• 配置各個(gè)渠道發(fā)送消息需要的各種參數(shù)。
• 小程序模板：配置appid、支付寶公鑰、應(yīng)用私鑰、小程序模板ID、以及發(fā)送參數(shù)的字段信息

發(fā)送消息

指定單個(gè)用戶發(fā)送消息，或指定數(shù)據(jù)庫中某一個(gè)張表的某一個(gè)用戶字段，批量發(fā)送消息給該表中所有用戶。

查看結(jié)果：可以查看發(fā)送成功或者失敗數(shù)、以及失敗原因。

token 存儲(chǔ)

由于小程序模板類消息需要使用 formId（formId 需要在小程序前端通過用戶點(diǎn)擊獲?。┻@一類 token 作為發(fā)送依據(jù)，所以后端提供 API 用于存儲(chǔ)每個(gè)用戶的 token 信息。發(fā)送時(shí)，自動(dòng)使用相應(yīng)的 token。

操作步驟

1. 首先完成 開發(fā)者入駐 并 創(chuàng)建小程序。小程序創(chuàng)建完成后，開發(fā)者在 功能列表 部分可以點(diǎn)擊 添加功能 勾選 模板消息 功能后，點(diǎn)擊右下角 確定 即完成添加功能。??

1. 完成后進(jìn)入模板消息后臺(tái)查找選用需要的模板。登錄 支付寶開放平臺(tái)，點(diǎn)擊 立即進(jìn)入 玩轉(zhuǎn)小程序運(yùn)營，進(jìn)入 運(yùn)營中心。??

1. 選擇接入模板消息的小程序，選擇 用戶互動(dòng) > 模板消息 > 消息模板庫，進(jìn)行模板選用。 ?

選擇關(guān)鍵詞并排定關(guān)鍵詞優(yōu)先級(jí)

?

新關(guān)鍵詞申請(qǐng)（可選）

1. 若選用的模板中沒有合適的關(guān)鍵詞，可以在小程序后臺(tái)管理中以下路徑申請(qǐng)?zhí)砑雨P(guān)鍵詞：模板消息 > 消息模板庫，任意一個(gè)已有模板消息操作欄中點(diǎn)擊 選用。??

1. 點(diǎn)擊彈出的對(duì)話框下方的 點(diǎn)擊申請(qǐng)。 ??

1. 關(guān)鍵字和示例內(nèi)容框中輸入相應(yīng)內(nèi)容，點(diǎn)擊 提交。 ??

關(guān)鍵詞申請(qǐng)規(guī)則：

• 每個(gè)自然月可提交 5 次關(guān)鍵詞申請(qǐng)；
• 在同一標(biāo)題下，申請(qǐng)的關(guān)鍵詞不能存在相同；
• 在同一標(biāo)題下，申請(qǐng)的關(guān)鍵詞不能存在過度相似；
• 關(guān)鍵詞不能帶特殊符號(hào)、個(gè)性化字詞等沒有行業(yè)通用性的內(nèi)容；
• 關(guān)鍵詞示例內(nèi)容必須與關(guān)鍵詞對(duì)應(yīng)匹配，且描述清晰；
• 關(guān)鍵詞申請(qǐng)審核結(jié)果將以站內(nèi)信方式通知，審核通過后，關(guān)鍵詞將納入到模板中。

系統(tǒng)部署和接口調(diào)用方式

和 AntBuilder 一起啟動(dòng)和部署，部署完成后調(diào)用接口可以發(fā)送消息。

對(duì)內(nèi) API 接口

發(fā)送消息

API 接口需要暴露在內(nèi)網(wǎng)環(huán)境，不允許對(duì)外網(wǎng)提供入口。

• 地址：AntBuilder的部署地址或者負(fù)載地址+端口；
• 路徑：/api/message/rest/send/mini；
• httpMethod：POST；
• Content-Type：application/json。

請(qǐng)求參數(shù)

注意：這里如果填寫了 tradeNo 參數(shù)，頁面跳轉(zhuǎn)的 URL 參數(shù)會(huì)默認(rèn)帶上 tradeNo。

返回參數(shù)

請(qǐng)求參數(shù)示例

{
    "template": "安持測(cè)試消息",
    "user": "2088002393111854",
    "tradeNo": "2020061722001410851447611111",
    "data": "{\"keyword1\":\"繳費(fèi)進(jìn)度\",\"keyword2\":\"待繳費(fèi)\",\"keyword3\":\"待繳費(fèi)\"}",
    "params": "{\"id\":\"123\",\"action\":\"345\"}"
}

對(duì)應(yīng)小程序消息鏈接為 https://xxx.xxx?TradeNo=2020061722001410851447687910&id=123&action=345。

?

FormId 存儲(chǔ)

地址：AntBuilder 的部署地址或者負(fù)載地址+端口

路徑：/api/token/save

httpMethod：GET

請(qǐng)求參數(shù)

返回參數(shù)

示例

http://localhost:8080/api/token/save?applicationId=2021001105629024&uid=208810264978400111&formId=asdlkjaslkdjaslkdjaslkdja

集成包獨(dú)立部署模式

1. 前端頁面請(qǐng)求由 ISV 系統(tǒng)進(jìn)行用戶鑒權(quán)后，轉(zhuǎn)發(fā)至消息中心。
2. 消息中心暴露 http 服務(wù)接口，該服務(wù)可以直接處理前端的 ajax 請(qǐng)求。
3. 系統(tǒng)用戶及鑒權(quán)由 ISV 系統(tǒng)處理。

注意事項(xiàng)

• 目前批量發(fā)送為同步發(fā)送，同時(shí)發(fā)送數(shù)量太多可能導(dǎo)致超時(shí)，每次發(fā)送建議控制在1萬個(gè)以內(nèi)；
• 目前僅支持小程序模板消息和短信。