查询订阅消息模版库
收藏接口说明
获取小程序所属类目下的公共模版列表
前提条件
需要小程序已上线
使用限制
只能查询小程序已经审核通过的服务类目下的订阅消息模版库
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/notification/v2/subscription/query_tpl_list/ |
| HTTP Method | GET |
| Scope | notification.openapi.common |
| 权限要求 | 服务商代调用场景下，需商家授予服务商运营管理权限集：
|
请求参数
请求头
access-token必填String
当非服务商时，调用https://open.douyin.com/oauth/client_token/生成的token
当服务商时，调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
当服务商时，调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
content-type必填String
示例：application/json
固定值"application/json"
Query展开全部子属性
classification必填Enum
示例：1
订阅消息类型
展开子属性
page_num必填Int32
示例：1
分页编号，从1开始
page_size必填Int32
示例：10
分页大小，小于等于50
template_type必填Enum
示例：1
模版类型
1: 公共模版
category_idsString
示例：79,117,158
服务类目id，多个id用英文逗号隔开，可以通过获取已设置的服务类目接口获取小程序的服务类目，只能是已经审核通过的服务类目
keywordString
示例：退款通知
根据关键词搜索
请求示例
curl --location --request GET 'https://open.douyin.com/api/notification/v2/subscription/query_tpl_list/?classification=1&template_type=1&category_ids=500,135,140&page_num=1&page_size=10' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
错误信息
err_no必填Int32
示例：0
错误码，0 是成功，其它为异常
log_id必填String
示例：202008121419360101980821035705926A
标识请求的唯一id，在接口异常时用于问题排查
响应示例
正常响应示例异常响应示例
{ "err_msg": "", "err_no": 0, "log_id": "202008121419360101980821035705926A", "data": { "total_count": 1, "template_list": [ { "template_id": 12259, "classification": 1, "title": "拍摄通知", "keyword_list": [ "时间", "地点" ], "category_name": "摄影/扩印", "host_list": [ "toutiao" ] } ] } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28001038 | 参数错误 | 按err_msg检查入参 |
| 200 | 28001005 | 服务内部错误，请重试 | 自行重试，重试仍无效请联系平台 Oncall 解决 |
| 200 | 28001003 | access_token无效 | 重新请求生成access_token |
| 200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
| 200 | 28001016 | 当前应用已被封禁或下线 | clientKey被封禁或者下线 |
| 200 | 28001006 | 网络调用错误，请重试 | 重试即可 |
| 200 | 28001014 | 应用未授权任何能力 | 确认应用是否授权能力 |
| 200 | 28001018 | 应用未获得该能力 | 开通相关能力 |
| 200 | 28001019 | 应用该能力已被封禁 | 该能力被封禁，请联系平台 Oncall 解决 |
| 200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
