新聞中心
subscribeMessage.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ā)送訂閱消息
調(diào)用方式:
- HTTPS 調(diào)用
- 云調(diào)用
HTTPS 調(diào)用
請(qǐng)求地址
POST https://api.weixin.qq.com/cgi-bin/message/subscribe/send?access_token=ACCESS_TOKEN
請(qǐng)求參數(shù)
| 屬性 | 類(lèi)型 | 默認(rèn)值 | 必填 | 說(shuō)明 |
|---|---|---|---|---|
| access_token | string | 是 | 接口調(diào)用憑證 | |
| touser | string | 是 | 接收者(用戶)的 openid | |
| template_id | string | 是 | 所需下發(fā)的訂閱模板id | |
| page | string | 否 | 點(diǎn)擊模板卡片后的跳轉(zhuǎn)頁(yè)面,僅限本小程序內(nèi)的頁(yè)面。支持帶參數(shù),(示例index?foo=bar)。該字段不填則模板無(wú)跳轉(zhuǎn)。 | |
| data | Object | 是 | 模板內(nèi)容,格式形如 { "key1": { "value": any }, "key2": { "value": any } } | |
| miniprogram_state | string | 否 | 跳轉(zhuǎn)小程序類(lèi)型:developer為開(kāi)發(fā)版;trial為體驗(yàn)版;formal為正式版;默認(rèn)為正式版 | |
| lang | string | 否 | 進(jìn)入小程序查看”的語(yǔ)言類(lèi)型,支持zh_CN(簡(jiǎn)體中文)、en_US(英文)、zh_HK(繁體中文)、zh_TW(繁體中文),默認(rèn)為zh_CN |
返回值
Object
返回的 JSON 數(shù)據(jù)包
| 屬性 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| errcode | number | 錯(cuò)誤碼 |
| errmsg | string | 錯(cuò)誤信息 |
errcode 的合法值
| 值 | 說(shuō)明 | 最低版本 |
|---|---|---|
| 40003 | touser字段openid為空或者不正確 | |
| 40037 | 訂閱模板id為空不正確 | |
| 43101 | 用戶拒絕接受消息,如果用戶之前曾經(jīng)訂閱過(guò),則表示用戶取消了訂閱關(guān)系 | |
| 47003 | 模板參數(shù)不準(zhǔn)確,可能為空或者不滿足規(guī)則,errmsg會(huì)提示具體是哪個(gè)字段出錯(cuò) | |
| 41030 | page路徑不正確,需要保證在現(xiàn)網(wǎng)版本小程序中存在,與app.json保持一致 |
接口限制
次數(shù)限制:開(kāi)通支付能力的是3kw/日,沒(méi)開(kāi)通的是1kw/日。
請(qǐng)求示例
{
"touser": "OPENID",
"template_id": "TEMPLATE_ID",
"page": "index",
"miniprogram_state":"developer",
"lang":"zh_CN",
"data": {
"number01": {
"value": "339208499"
},
"date01": {
"value": "2015年01月05日"
},
"site01": {
"value": "TIT創(chuàng)意園"
} ,
"site02": {
"value": "廣州市新港中路397號(hào)"
}
}
}
訂閱消息參數(shù)值內(nèi)容限制說(shuō)明
| 參數(shù)類(lèi)別 | 參數(shù)說(shuō)明 | 參數(shù)值限制 | 說(shuō)明 |
|---|---|---|---|
| thing.DATA | 事物 | 20個(gè)以內(nèi)字符 | 可漢字、數(shù)字、字母或符號(hào)組合 |
| number.DATA | 數(shù)字 | 32位以內(nèi)數(shù)字 | 只能數(shù)字,可帶小數(shù) |
| letter.DATA | 字母 | 32位以內(nèi)字母 | 只能字母 |
| symbol.DATA | 符號(hào) | 5位以內(nèi)符號(hào) | 只能符號(hào) |
| character_string.DATA | 字符串 | 32位以內(nèi)數(shù)字、字母或符號(hào) | 可數(shù)字、字母或符號(hào)組合 |
| time.DATA | 時(shí)間 | 24小時(shí)制時(shí)間格式(支持+年月日),支持填時(shí)間段,兩個(gè)時(shí)間點(diǎn)之間用“~”符號(hào)連接 | 例如:15:01,或:2019年10月1日 15:01 |
| date.DATA | 日期 | 年月日格式(支持+24小時(shí)制時(shí)間),支持填時(shí)間段,兩個(gè)時(shí)間點(diǎn)之間用“~”符號(hào)連接 | 例如:2019年10月1日,或:2019年10月1日 15:01 |
| amount.DATA | 金額 | 1個(gè)幣種符號(hào)+10位以內(nèi)純數(shù)字,可帶小數(shù),結(jié)尾可帶“元” | 可帶小數(shù) |
| phone_number.DATA | 電話 | 17位以內(nèi),數(shù)字、符號(hào) | 電話號(hào)碼,例:+86-0766-66888866 |
| car_number.DATA | 車(chē)牌 | 8位以內(nèi),第一位與最后一位可為漢字,其余為字母或數(shù)字 | 車(chē)牌號(hào)碼:粵A8Z888掛 |
| name.DATA | 姓名 | 10個(gè)以內(nèi)純漢字或20個(gè)以內(nèi)純字母或符號(hào) | 中文名10個(gè)漢字內(nèi);純英文名20個(gè)字母內(nèi);中文和字母混合按中文名算,10個(gè)字內(nèi) |
| phrase.DATA | 漢字 | 5個(gè)以內(nèi)漢字 | 5個(gè)以內(nèi)純漢字,例如:配送中 |
符號(hào)表示除中文、英文、數(shù)字外的常見(jiàn)符號(hào),不能帶有換行等控制字符。 時(shí)間格式支持HH:MM:SS或者HH:MM。 日期包含年月日,為y年m月d日,y年m月、m月d日格式,或者用‘-’、‘/’、‘.’符號(hào)連接,如2018-01-01,2018/01/01,2018.01.01,2018-01,01-01。 每個(gè)模板參數(shù)都會(huì)以類(lèi)型為前綴,例如第一個(gè)數(shù)字模板參數(shù)為number01.DATA,第二個(gè)為number02.DATA
例如,模板的內(nèi)容為
姓名: {{name01.DATA}}
金額: {{amount01.DATA}}
行程: {{thing01.DATA}}
日期: {{date01.DATA}}
則對(duì)應(yīng)的json為
{
"touser": "OPENID",
"template_id": "TEMPLATE_ID",
"page": "index",
"data": {
"name01": {
"value": "某某"
},
"amount01": {
"value": "¥100"
},
"thing01": {
"value": "廣州至北京"
} ,
"date01": {
"value": "2018-01-01"
}
}
}
云調(diào)用
云調(diào)用是小程序·云開(kāi)發(fā)提供的在云函數(shù)中調(diào)用微信開(kāi)放接口的能力,需要在云函數(shù)中通過(guò) wx-server-sdk 使用。
接口方法
openapi.subscribeMessage.send
需在 config.json 中配置 subscribeMessage.send API 的權(quán)限, 詳情
請(qǐng)求參數(shù)
| 屬性 | 類(lèi)型 | 默認(rèn)值 | 必填 | 說(shuō)明 |
|---|---|---|---|---|
| touser | string | 是 | 接收者(用戶)的 openid | |
| templateId | string | 是 | 所需下發(fā)的訂閱模板id | |
| page | string | 否 | 點(diǎn)擊模板卡片后的跳轉(zhuǎn)頁(yè)面,僅限本小程序內(nèi)的頁(yè)面。支持帶參數(shù),(示例index?foo=bar)。該字段不填則模板無(wú)跳轉(zhuǎn)。 | |
| data | Object | 是 | 模板內(nèi)容,格式形如 { "key1": { "value": any }, "key2": { "value": any } } | |
| miniprogramState | string | 否 | 跳轉(zhuǎn)小程序類(lèi)型:developer為開(kāi)發(fā)版;trial為體驗(yàn)版;formal為正式版;默認(rèn)為正式版 | |
| lang | string | 否 | 進(jìn)入小程序查看”的語(yǔ)言類(lèi)型,支持zh_CN(簡(jiǎn)體中文)、en_US(英文)、zh_HK(繁體中文)、zh_TW(繁體中文),默認(rèn)為zh_CN |
返回值
Object
返回的 JSON 數(shù)據(jù)包
| 屬性 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| errCode | number | 錯(cuò)誤碼 |
| errMsg | string | 錯(cuò)誤信息 |
errCode 的合法值
| 值 | 說(shuō)明 | 最低版本 |
|---|---|---|
| 0 | 成功 |
異常
Object
拋出的異常
| 屬性 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| errCode | number | 錯(cuò)誤碼 |
| errMsg | string | 錯(cuò)誤信息 |
errCode 的合法值
| 值 | 說(shuō)明 | 最低版本 |
|---|---|---|
| 40003 | touser字段openid為空或者不正確 | |
| 40037 | 訂閱模板id為空不正確 | |
| 43101 | 用戶拒絕接受消息,如果用戶之前曾經(jīng)訂閱過(guò),則表示用戶取消了訂閱關(guān)系 | |
| 47003 | 模板參數(shù)不準(zhǔn)確,可能為空或者不滿足規(guī)則,errmsg會(huì)提示具體是哪個(gè)字段出錯(cuò) | |
| 41030 | page路徑不正確,需要保證在現(xiàn)網(wǎng)版本小程序中存在,與app.json保持一致 |
請(qǐng)求示例
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.subscribeMessage.send({
touser: 'OPENID',
page: 'index',
lang: 'zh_CN',
data: {
number01: {
value: '339208499'
},
date01: {
value: '2015年01月05日'
},
site01: {
value: 'TIT創(chuàng)意園'
},
site02: {
value: '廣州市新港中路397號(hào)'
}
},
templateId: 'TEMPLATE_ID',
miniprogramState: 'developer'
})
return result
} catch (err) {
return err
}
} 名稱欄目:創(chuàng)新互聯(lián)小程序教程:微信小程序訂閱消息·send
網(wǎng)頁(yè)URL:http://fisionsoft.com.cn/article/cciojpo.html


咨詢
建站咨詢

