# 发送订阅通知
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:sendNewSubscribeMsg
发送订阅通知
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/message/subscribe/bizsend?access_token=ACCESS_TOKEN
# 云调用
调用方法:subscribeMessage.bizsend
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:89
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| template_id | string | 是 | 所需下发的订阅模板id |
| page | string | 否 | 点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转 |
| touser | string | 是 | 接收者(用户)的 openid |
| data | object | 是 | 模板内容,格式形如{ "phrase3": { "value": "审核通过" }, "name1": { "value": "订阅" }, "date2": { "value": "2019-12-25 09:42" } } |
| miniprogram_state | string | 是 | 跳转小程序类型:developer为开发版;trial为体验版;formal为正式版;默认为正式版 |
| lang | string | 是 | 进入小程序查看”的语言类型,支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文),默认为zh_CN |
# Body.data Object Payload
模板内容,格式形如{ "phrase3": { "value": "审核通过" }, "name1": { "value": "订阅" }, "date2": { "value": "2019-12-25 09:42" } }
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| thing.DATA | string | 否 | 事物,可汉字、数字、字母或符号组合,20个以内字符 |
| number.DATA | number | 否 | 数字,只能数字,可带小数,32位以内数字 |
| symbol.DATA | string | 否 | 符号,5位以内,除中文、英文、数字外的常见符号,不能带有换行等控制字符 |
| character_string.DATA | string | 否 | 字符串,可数字、字母或符号组合,32位以内数字、字母或符号 |
| time.DATA | string | 否 | 时间,24小时制时间格式(支持+年月日),支持HH:MM:SS或者HH:MM,支持填时间段,两个时间点之间用“~”符号连接,例如:「15:01」或「2019年10月1日 15:01」 |
| date.DATA | string | 否 | 日期,年月日格式(支持+24小时制时间),支持填时间段,两个时间点之间用‘-’、‘/’、‘.’符号连接,例如:「2019年10月1日」或「2019年10月1日 15:01」 |
| amount.DATA | string | 否 | 金额,1个币种符号+10位以内纯数字,可带小数,结尾可带“元” |
| phone_number.DATA | string | 否 | 电话号码,17位以内,数字、符号,例:+86-0766-66888866 |
| car_number.DATA | string | 否 | 车牌号码,8位以内,第一位与最后一位可为汉字,其余为字母或数字,如:粤A8Z888挂 |
| name.DATA | string | 否 | 姓名,中文名10个汉字内;纯英文名20个字母内;中文和字母混合按中文名算,10个字内 |
| phrase.DATA | string | 否 | 汉字,5个以内纯汉字,例如:配送中 |
| letter.DATA | string | 否 | 字母,32位以内字母 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误描述 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"touser":"OPENID",
"template_id":"ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY",
"page":"http://weixin.qq.com/download",
"miniprogram":{
"appid":"xiaochengxuappid12345",
"pagepath":"index?foo=bar"
},
"client_msg_id":"MSG_000001",
"data":{
"keyword1":{
"value":"巧克力"
},
"keyword2": {
"value":"39.8元"
},
"keyword3": {
"value":"2014年9月22日"
}
}
}
返回示例
{
"errcode":0,
"errmsg":"ok"
}
# 6. 错误码
此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
| 公众号 | 服务号 |
|---|---|
| 仅认证 | 仅认证 |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;