微信小程序 send

2022-05-10 16:26 更新

uniformMessage.send

本接口應(yīng)在服務(wù)器端調(diào)用,詳細(xì)說(shuō)明參見(jiàn)服務(wù)端API。
本接口支持云調(diào)用。需開(kāi)發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

下發(fā)小程序和公眾號(hào)統(tǒng)一的服務(wù)消息

調(diào)用方式:

  • HTTPS 調(diào)用
  • 云調(diào)用

HTTPS 調(diào)用

請(qǐng)求地址

POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN

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

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
access_token string 接口調(diào)用憑證
touser string 用戶(hù)openid,可以是小程序的openid,也可以是mp_template_msg.appid對(duì)應(yīng)的公眾號(hào)的openid
weapp_template_msg Object 小程序模板消息相關(guān)的信息,可以參考小程序模板消息接口; 有此節(jié)點(diǎn)則優(yōu)先發(fā)送小程序模板消息
mp_template_msg Object 公眾號(hào)模板消息相關(guān)的信息,可以參考公眾號(hào)模板消息接口;有此節(jié)點(diǎn)并且沒(méi)有weapp_template_msg節(jié)點(diǎn)時(shí),發(fā)送公眾號(hào)模板消息

weapp_template_msg 的結(jié)構(gòu)

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
template_id string 小程序模板ID
page string 小程序頁(yè)面路徑
form_id string 小程序模板消息formid
data string 小程序模板數(shù)據(jù)
emphasis_keyword string 小程序模板放大關(guān)鍵詞

mp_template_msg 的結(jié)構(gòu)

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
appid string 公眾號(hào)appid,要求與小程序有綁定且同主體
template_id string 公眾號(hào)模板id
url string 公眾號(hào)模板消息所要跳轉(zhuǎn)的url
miniprogram string 公眾號(hào)模板消息所要跳轉(zhuǎn)的小程序,小程序的必須與公眾號(hào)具有綁定關(guān)系
data string 公眾號(hào)模板消息的數(shù)據(jù)

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類(lèi)型 說(shuō)明
errcode number 錯(cuò)誤碼
errmsg string 錯(cuò)誤信息

錯(cuò)誤

錯(cuò)誤碼 錯(cuò)誤信息 說(shuō)明
40037 模板id不正確,weapp_template_msg.template_id或者mp_template_msg.template_id
41028 weapp_template_msg.form_id過(guò)期或者不正確
41029 weapp_template_msg.form_id已被使用
41030 weapp_template_msg.page不正確
45009 接口調(diào)用超過(guò)限額
40003 touser不是正確的openid
40013 appid不正確,或者不符合綁定關(guān)系要求

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

{
    "touser":"OPENID",
    "weapp_template_msg":{
        "template_id":"TEMPLATE_ID",
        "page":"page/page/index",
        "form_id":"FORMID",
        "data":{
            "keyword1":{
                "value":"339208499"
            },
            "keyword2":{
                "value":"2015年01月05日 12:30"
            },
            "keyword3":{
                "value":"騰訊微信總部"
            },
            "keyword4":{
                "value":"廣州市海珠區(qū)新港中路397號(hào)"
            }
        },
        "emphasis_keyword":"keyword1.DATA"
    },
    "mp_template_msg":{
        "appid":"APPID ",
        "template_id":"TEMPLATE_ID",
        "url":"http://weixin.qq.com/download",
        "miniprogram":{
            "appid":"xiaochengxuappid12345",
            "pagepath":"index?foo=bar"
        },
        "data":{
            "first":{
                "value":"恭喜你購(gòu)買(mǎi)成功!",
                "color":"#173177"
            },
            "keyword1":{
                "value":"巧克力",
                "color":"#173177"
            },
            "keyword2":{
                "value":"39.8元",
                "color":"#173177"
            },
            "keyword3":{
                "value":"2014年9月22日",
                "color":"#173177"
            },
            "remark":{
                "value":"歡迎再次購(gòu)買(mǎi)!",
                "color":"#173177"
            }
        }
    }
}

返回?cái)?shù)據(jù)示例

{
 "errcode": 0,
 "errmsg": "ok"
}

云調(diào)用

云調(diào)用是小程序·云開(kāi)發(fā)提供的在云函數(shù)中調(diào)用微信開(kāi)放接口的能力,需要在云函數(shù)中通過(guò) wx-server-sdk 使用。

接口方法

openapi.uniformMessage.send
需在 config.json 中配置 uniformMessage.send API 的權(quán)限,詳情

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

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
touser string 用戶(hù)openid,可以是小程序的openid,也可以是mp_template_msg.appid對(duì)應(yīng)的公眾號(hào)的openid
weappTemplateMsg Object 小程序模板消息相關(guān)的信息,可以參考小程序模板消息接口; 有此節(jié)點(diǎn)則優(yōu)先發(fā)送小程序模板消息
mpTemplateMsg Object 公眾號(hào)模板消息相關(guān)的信息,可以參考公眾號(hào)模板消息接口;有此節(jié)點(diǎn)并且沒(méi)有weapp_template_msg節(jié)點(diǎn)時(shí),發(fā)送公眾號(hào)模板消息

weappTemplateMsg 的結(jié)構(gòu)

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
templateId string 小程序模板ID
page string 小程序頁(yè)面路徑
formId string 小程序模板消息formid
data string 小程序模板數(shù)據(jù)
emphasisKeyword string 小程序模板放大關(guān)鍵詞

mpTemplateMsg 的結(jié)構(gòu)

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
appid string 公眾號(hào)appid,要求與小程序有綁定且同主體
templateId string 公眾號(hào)模板id
url string 公眾號(hào)模板消息所要跳轉(zhuǎn)的url
miniprogram string 公眾號(hào)模板消息所要跳轉(zhuǎn)的小程序,小程序的必須與公眾號(hào)具有綁定關(guān)系
data string 公眾號(hào)模板消息的數(shù)據(jù)

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類(lèi)型 說(shuō)明
errCode number 錯(cuò)誤碼
errMsg string 錯(cuò)誤信息

異常

Object

拋出的異常

屬性 類(lèi)型 說(shuō)明
errCode number 錯(cuò)誤碼
errMsg string 錯(cuò)誤信息

errCode 的合法值

說(shuō)明 最低版本

錯(cuò)誤

錯(cuò)誤碼 錯(cuò)誤信息 說(shuō)明
40037 模板id不正確,weapp_template_msg.template_id或者mp_template_msg.template_id
41028 weapp_template_msg.form_id過(guò)期或者不正確
41029 weapp_template_msg.form_id已被使用
41030 weapp_template_msg.page不正確
45009 接口調(diào)用超過(guò)限額
40003 touser不是正確的openid
40013 appid不正確,或者不符合綁定關(guān)系要求

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

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.uniformMessage.send({
        touser: 'OPENID',
        weappTemplateMsg: {
          page: 'page/page/index',
          data: {
            keyword1: {
              value: '339208499'
            },
            keyword2: {
              value: '2015年01月05日 12:30'
            },
            keyword3: {
              value: '騰訊微信總部'
            },
            keyword4: {
              value: '廣州市海珠區(qū)新港中路397號(hào)'
            }
          },
          templateId: 'TEMPLATE_ID',
          formId: 'FORMID',
          emphasisKeyword: 'keyword1.DATA'
        },
        mpTemplateMsg: {
          appid: 'APPID ',
          url: 'http://weixin.qq.com/download',
          miniprogram: {
            appid: 'xiaochengxuappid12345',
            pagepath: 'index?foo=bar'
          },
          data: {
            first: {
              value: '恭喜你購(gòu)買(mǎi)成功!',
              color: '#173177'
            },
            keyword1: {
              value: '巧克力',
              color: '#173177'
            },
            keyword2: {
              value: '39.8元',
              color: '#173177'
            },
            keyword3: {
              value: '2014年9月22日',
              color: '#173177'
            },
            remark: {
              value: '歡迎再次購(gòu)買(mǎi)!',
              color: '#173177'
            }
          },
          templateId: 'TEMPLATE_ID'
        }
      })
    return result
  } catch (err) {
    return err
  }
}

返回?cái)?shù)據(jù)示例

{
  "errCode": 0,
  "errMsg": "openapi.uniformMessage.send:ok"
}


以上內(nèi)容是否對(duì)您有幫助:
在線(xiàn)筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)