tt.requestSubscribeMessage
收藏我的收藏
收藏基础库 1.73.0 开始支持本方法，低版本需做兼容处理。支持宿主：头条，抖音。订阅消息功能介绍及使用方式请参见订阅消息2.0，这是一个异步方法。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 |
|
| 注意事项 | 无 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.requestSubscribeMessage(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| tmplIds | Array<string> | 是 | 需要订阅的消息模板的 id 的集合，最多支持传入三个 tmplId 在「开放平台控制台-进入对应小程序-能力-互动能力-消息管理-订阅消息」获取消息模版id | 1.73.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.73.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.73.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.73.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| templateSettings | object | 订阅结果 | 3.35.0 |
| errMsg | string | "requestSubscribeMessage:ok" | 3.35.0 |
templateSettings 参数说明
key为模板id，value为object类型。只有用户勾选了的模板才会返回。
templateSettings 类型说明
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| [TEMPLAT_ID] | object | 用户勾选了的模板id | 3.35.0 |
[TEMPLAT_ID] 类型说明
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| status | enum | 订阅结果。 | 3.35.0 |
| alwaysSubscribe | boolean | 是否为长期订阅状态(当用户在弹窗中勾选了"总是保持以上选择，不再询问"，对应模板的订阅状态会变为长期状态，长期订阅状态的模板后续不会弹窗询问用户，直接返回用户上次的选择)。 | 3.35.0 |
| allowReminderWay | Array<object> | 返回模板支持的提醒方式对应的用户授权结果。 | 3.35.0 |
status 的合法值
| 值 | 说明 | 最低支持版本 |
|---|---|---|
| accept | 用户同意订阅该条 id 对应的模板消息。 | 3.35.0 |
| reject | 用户拒绝订阅该条 id 对应的模板消息。 | 3.35.0 |
| fail | 表示该条 id 对应的模版消息授权失败。 | 3.35.0 |
| repeat | 表示该条id对应的 模板消息重复订阅。 注：该返回为长期模板特有返回。订阅消息2.0体系中，长期模板只需用户订阅一次，开发者即可不限时间的下发多条消息，但是下发的频次会有限制。重复订阅会返回repeat，但不影响开发者下发消息。 | 3.35.0 |
| limit | 表示用户对该条id对应的模板订阅次数达到上限。 注：该返回为一次性模板特有返回。 | 3.35.0 |
allowReminderWay 类型说明
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| reminderType | enum | 提醒方式。 | 3.35.0 |
| reminderStatus | enum | 提醒授权结果。 | 3.35.0 |
reminderType 的合法值
| 值 | 说明 | 最低支持版本 |
|---|---|---|
| message_notice | 消息通知。默认支持。 | 3.35.0 |
| feed | 推荐频道提醒。开发者需要申请支持信息流通知的模板。 | 3.35.0 |
| push | 实时提醒。开发者需要申请支持实时提醒的模板。 | 3.35.0 |
reminderStatus 的合法值
| 值 | 说明 | 最低支持版本 |
|---|---|---|
| accept | 同意。 | 3.35.0 |
| reject | 拒绝。 | 3.35.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | 接口调用失败错误信息 | 1.73.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 118505 | requestSubscribeMessage:fail auth deny | U | 拒绝授权 用户未授权消息推送，在合适的场景申请订阅消息 | 1.73.0 |
| 118501 | requestSubscribeMessage:fail template not exist or invalid | D | 模板无效 检查传入的模板id | 1.73.0 |
| 118509 | requestSubscribeMessage:fail templates switches all off | U | 所有模板都长期拒绝 所有模板都长期拒绝,开发者可通过tt.openSetting引导开发者去设置页开启 | 1.73.0 |
| 118599 | requestSubscribeMessage:fail invalid params | D | 入参无效 检查入参 | 1.73.0 |
| 118504 | requestSubscribeMessage:fail service error | F | 小程序框架内部错误，有需要请创建工单咨询 | 1.73.0 |
| 118591 | requestSubscribeMessage:fail Internal error xxx | F | 小程序框架内部错误，有需要请创建工单咨询 | 1.73.0 |
| 118508 | requestSubscribeMessage:fail main switch off | U | 主开关关闭 主开关关闭,开发者可通过tt.openSetting引导开发者去设置页开启 | 1.73.0 |
| 118585 | requestSubscribeMessage:fail network unavailable | U | 无网调用 用户网络不佳，若此错误频繁出现建议加入超时重试逻辑 | 1.73.0 |
| 118506 | requestSubscribeMessage:fail login deny | U | 用户拒绝登录 用户拒绝登录 | 1.73.0 |
| 118502 | requestSubscribeMessage:fail template type not the same | D | 一次性模板和长期模板混用 一次性模板和长期模板混用 | 1.73.0 |
