ks.requestSubscribeMessage

更新时间：2024-09-19 14:44:23

基础库1.26.1开始支持,低版本需做兼容处理

开发者工具1.22.0开始支持 (MOCK),真实场景请使用真机调试

调起客户端小程序订阅消息界面，获取用户订阅消息的操作结果。完整订阅能力接入

requestSubscribeMessage(options: RequestSubscribeMessageOptions): Promise<Record<string, 'ACCEPT' | 'REFUSE'>>

参数

参数	类型	必填
options	RequestSubscribeMessageOptions	是

RequestSubscribeMessageOptions

属性

属性	类型	必填	说明
tmplIds	string[]	是	需要订阅的消息模板 id
success	(result: Record<string, 'ACCEPT' | 'REFUSE'>) => void	否	接口调用成功的回调函数
fail	(error: RequestSubscribeMessageError) => void	否	接口调用失败的回调函数
complete	(resultOrError: Record<string, 'ACCEPT' | 'REFUSE'> | RequestSubscribeMessageError) => void	否	接口调用结束的回调函数（调用成功、失败都会执行）

返回值

Promise<Record<string, 'ACCEPT' | 'REFUSE'>>

错误信息

错误信息	错误说明
repeated request	重复订阅
empty template id	模板id参数为空
template number exceed limit	模板消息数量超过限制
user close main switch	用户关闭了总开关，无法弹窗
template type not unified	模板消息类型不统一，必须全部为一次性消息或永久消息

Bug & Tip

tip: 调用订阅必须发生在用户tap操作或者showModal的confirm操作之后

示例代码