开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
基础 api
开放能力 api
支付
用户授权
会员
周期扣款
商家会员卡
消息
模板配置
支付宝卡包
交易组件
小程序商品
开发 > api > 开放能力 api > 消息
收藏
订阅更新
我的文档
设置
简介
调起客户端小程序消息订阅界面,返回用户订阅消息的操作结果。详细介绍可查看 商家消息产品介绍
使用限制
一次性模板 id 和长期性模板 id 不可同时使用。
开发者调用消息订阅接口,一次性最多传入三个模板 id。
基础库 v1.x 从 1.25.7 开始支持,基础库 v2.x 从 2.7.10 开始支持,低版本需要做 兼容处理,使用前可使用 caniuse 判断是否支持。
基础库版本低于 2.7.15,不能和 web-view 组件共用,会被遮盖。
此 api 暂不支持在 ide 模拟器上调试,请以 真机调试 结果为准。
此 api 支持个人支付宝小程序、企业支付宝小程序使用。
接口调用
示例代码
.js 示例代码
javascript
复制代码
my.requestsubscribemessage({
entityids: ['ac768fca1ce245ccae9404bb5243c49b', '9aa357acb7c6434aba294aded1cdfb7c'],
success: (res) => {
// res.behavior == 'subscribe'
console.log("接口调用成功的回调", res);
},
fail: (res) => {
console.log("接口调用失败的回调", res);
},
complete: (res) => {
console.log("接口调用结束的回调", res);
}
});
入参
object 类型,参数如下:
参数
类型
必填
描述
entityids
array

需要订阅的消息模板的id的集合。
thirdtypeappid
string

模板小程序标识,仅在 isv 场景下需要传入。
success
function

调用成功的回调函数。
fail
function

调用失败的回调函数。
complete
function

调用结束的回调函数(调用成功、失败都会执行)。
回调参数
属性
类型
可选值
描述
behavior
string
'','subscribe','cancel'
订阅行为。
'subscribe':表示订阅成功。
'cancel':表示取消订阅。
'':表示订阅失败。
success
boolean
true, false
订阅是否成功,已废弃,建议通过 behavior 字段获取订阅状态。
stat
string
'ok', 'failed'
订阅状态,已废弃,建议通过 behavior 字段获取订阅状态。
show
boolean
true, false
本次订阅过程是否弹出订阅弹层。
result
object
订阅数据,
{
//仅在订阅成功场景下存在,表示订阅成功的模板列表
subscribeentityids?: [ ],
// 最终订阅成功的模板列表
subscribedentityids: [ ],
// 未订阅的模板列表
unsubscribedentityids: [ ],
// 本次新增订阅成功的模板列表
currentsubscribedentityids: [ ],
//仅在取消订阅场景下存在,是传入的模板id集合
entitylist?: [],
};
keep
boolean
true, false
单次订阅模板,用户同意订阅并勾选 不再询问 时为 true。
refuse
boolean
true, false
长期订阅模板,用户点击 拒绝,不再询问 时为 true。
errorcode
number | string
见错误码
错误码,仅在订阅取消/失败时返回。
errormessage
string
见错误码
错误信息,仅在订阅取消/失败时返回。
[模板id]
string
'reject', 'accept'
动态键,表示该模板是否被订阅。仅在订阅成功( behavior == 'subscribe' )场景下数据可靠,其他场景下建议通过result字段获取订阅数据。静默订阅( show 为 false )时,返回状态为上一次的订阅结果。
回调参数示例
消息订阅.jpg

错误码
errorcode
errormessage
说明
10
系统异常
系统异常。
11
用户取消订阅
用户取消订阅。
15
当前有活跃的订阅授权窗口,此次调用不会弹窗,无订阅结果返回
重复触发消息订阅,调用失败。
203
无效的参数
传入参数错误,比如传入模板 id 数量大于 3。
402
应用暂不能提供服务
传入错误的小程序 appid。
100201
调用次数超限
接口限流。
106002
模板列表中同时存在一次性/长期订阅模板
模板列表中不能同时存在一次性/长期订阅模板。
106008
模板列表中存在非法/无效的模板id
模板 id 传入错误或传入小程序未订购的模板 id。
-1
订阅失败/校验模板列表失败
默认错误信息。
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图