支付寶小程序Serverless 營銷能力API·cloud.marketing.templateMessage.send

2020-09-18 14:32 更新

cloud.marketing.templateMessage.send 是小程序模板消息 場景下發(fā)送模板消息的接口。

使用該API前,請確認(rèn)你的小程序應(yīng)用已經(jīng)添加 模板消息 功能

入?yún)⒄f明

字段名 類型 必填 說明
toUserId String 發(fā)送消息的支付寶賬號
formId String 用戶發(fā)生的交易行為的交易號,或者用戶在小程序產(chǎn)生表單提交的表單號,用于信息發(fā)送的校驗
userTemplateId String 用戶申請的模板id號,固定的模板id會發(fā)送固定的消息
page String 小程序的跳轉(zhuǎn)頁面,用于消息中心用戶點擊之后詳細(xì)跳轉(zhuǎn)的小程序頁面,例如:page/component/index
data String 開發(fā)者需要發(fā)送模板消息中的自定義部分來替換模板的占位符,例如:{"keyword1": {"value" : "12:00"},"keyword2": {"value" : "20180808"},"keyword3": {"value" : "支付寶"}}
appAuthToken String 三方代調(diào)用應(yīng)用訪問令牌,目前僅在云函數(shù)中調(diào)用支持。

調(diào)用示例

在云函數(shù)中調(diào)用

  1. // 云函數(shù)中使用云調(diào)用無需引入其他依賴,只需要使用ctx.cloud調(diào)用
  2. module.exports = async function (ctx) {
  3. const res = await ctx.cloud.marketing.templateMessage.send({
  4. // 參數(shù)接收自云函數(shù)調(diào)用端傳入的參數(shù)
  5. toUserId: ctx.args.toUserId,
  6. formId: ctx.args.formId,
  7. page: ctx.args.page,
  8. data: ctx.args.data,
  9. userTemplateId: ctx.args.userTemplateId });
  10. return res;
  11. };

支持傳入appAuthToken進(jìn)行三方代調(diào)用

  1. // 云函數(shù)中使用云調(diào)用無需引入其他依賴,只需要使用ctx.cloud調(diào)用
  2. module.exports = async function (ctx) {
  3. const res = await ctx.cloud.marketing.templateMessage.send({
  4. // 參數(shù)接收自云函數(shù)調(diào)用端傳入的參數(shù)
  5. toUserId: ctx.args.toUserId,
  6. formId: ctx.args.formId,
  7. page: ctx.args.page,
  8. data: ctx.args.data,
  9. userTemplateId: ctx.args.userTemplateId }, {
  10. // appAuthToken參數(shù)接收自云函數(shù)調(diào)用處傳入的參數(shù)
  11. appAuthToken: ctx.args.appAuthToken
  12. });
  13. return res;
  14. };

在小程序頁面調(diào)用

alipay-serverless-sdk 版本&=1.0.0

  1. import cloud from 'alipay-serverless-sdk';
  2. ?
  3. const res = await cloud.marketing.templateMessage.send({
  4. // 參數(shù)接收自云函數(shù)調(diào)用端傳入的參數(shù)
  5. toUserId: '2088102122458832',
  6. formId: '2017010100000000580012345',
  7. page: 'page/component/index',
  8. data: '{"keyword1": {"value" : "12:00"}}',
  9. userTemplateId: 'MDI4YzIxMDE2M2I5YTQzYjUxNWE4MjA4NmU1MTIyYmM=' });

alipay-serverless-sdk 版本<1.0.0

  1. import cloud from 'alipay-serverless-sdk';
  2. ?
  3. const res = await cloud.marketing.templateMessage.send('2088102122458832', '2017010100000000580012345', 'MDI4YzIxMDE2M2I5YTQzYjUxNWE4MjA4NmU1MTIyYmM=','page/component/index','{"keyword1": {"value" : "12:00"}}');

返回數(shù)據(jù)示例

  1. {
  2. "code":"10000",
  3. "msg":"Success"
  4. }
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號