tt.requestSubscribeMessage
收藏我的收藏
收藏基础库 1.73.0 开始支持本方法，这是一个异步方法。
调起客户端订阅消息界面，返回用户订阅消息的操作结果。当用户勾选了订阅面板中的 “总是保持以上选择，不再询问” 时，或是点击了订阅面板中 “拒绝，不再询问” 时，模板消息会被添加到用户的小程序设置页，用户可以在设置页面进行管理。
语法
tt.requestSubscribeMessage(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| tmplIds | Array<string> | 是 | 需要订阅的消息模板的 id 的集合，最多支持传入三个 tmplId。 消息 id 获取请参考教程中的【获取消息 ID】步骤 | 1.73.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.73.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.73.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.73.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| TEMPLATE_ID | string | [TEMPLATE_ID]为模板 id | 1.73.0 |
| errMsg | string | "requestSubscribeMessage:ok" | 1.73.0 |
TEMPLATE_ID 参数说明
值 | 说明 |
accept | 用户同意订阅该条 id 对应的模板消息 |
reject | 用户拒绝订阅该条 id 对应的模板消息 |
ban | 表示已被后台封禁 |
fail | 表示该条 id 对应的模版消息授权失败 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "requestSubscribeMessage:fail" + 详细错误信息 | 1.73.0 |
代码示例
// index.js const tmplIds = ["MSGxx", "MSGxx"]; tt.requestSubscribeMessage({ tmplIds: tmplIds, complete: (res) => { tt.showModal({ title: "订阅完成", content: JSON.stringify(res), }); }, });
错误码
errCode | errNo | errMsg | 说明 |
1001 | 暂时未加 | no permission | 没有权限(白名单配置，暂无需关注) |
1002 | 20000 | invalid params | 参数不合法 |
1003 | 20000 | template counts out of max bounds | 模版消息个数超过限制（最多 3 个） |
1004 | 21101 | template not exist or invalid | 模版消息不存在或不合法 |
1005 | 21102 | template type not the same | 模版消息类型不一致，或者订阅消息是多个并包含了版本更新提醒。 在 tmplIds 数组中，多个模板 id 代表的模板类型（一次性或者永久）和 消息类型（分为普通消息和版本更新消息两类）都应该分别保持一致。例如：tmplIds 中的所有模版 id 代表的模板类型统一为一次性，消息类型全部为普通消息。 |
2001 | 21103 | network error | 网络问题 |
2002 | 21104 | service error | 服务错误 |
3001 | 21105 | auth deny | 拒绝授权 |
3002 | 21106 | login deny | 拒绝登录 |
4001 | 21107 | request count out of limit | 请求次数超过限制 (二期弹窗频控取消，不会再出现) |
4002 | 21108 | main switch off | 总开关关闭 |
4003 | 21109 | templates switches all off | 请求模版消息开关均关闭 |
4004 | 21110 | forbidden | 后台封禁 |
暂时未加 | 暂时未加 | not supported by current application | 宿主不支持 |
5001 | 10401 | Internal error: \${附加信息} | 内部错误 |
