查询小程序的模板列表_

接口说明

获取小程序已添加的订阅消息模板列表

前提条件

需要小程序已上线

使用限制

无

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/notification/v2/subscription/query_app_tpl/
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
content-type	String	是	application/json	固定值"application/json"

请求参数

Query

名称	字段类型	是否必填	示例	描述
classification	Enum	是	1	订阅消息类型
page_num	Int32	是	1	分页编号，从1开始
page_size	Int32	是	10	分页大小，小于等于50
category_ids	String	否	8,9,16	服务类目id，多个id用英文逗号隔开，可以通过获取已设置的服务类目接口获取小程序的服务类目，只能是已经审核通过的服务类目

请求示例

curl --location --request GET 'https://open.douyin.com/api/notification/v2/subscription/query_app_tpl/?page_num=1&page_size=10&classification=1&category_ids=8,9,16' \
--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": [
      {
        "msg_id": "MSG122591232",
        "template_id": 12259,
        "classification": 1,
        "title": "拍摄通知",
        "keyword_list": [
          "时间",
          "地点"
        ],
        "category_name": "摄影/扩印",
        "host_list": [
          "toutiao"
        ]
      }
    ]
  }
}

异常响应示例

{
  "err_no": 28001038,
  "err_msg": "xx参数不合法",
  "log_id": "202008121419360101980821035705926A"
}

错误码

http状态码	错误码	错误码描述	排查建议
200	28001038	参数错误	按err_msg检查入参
200	28014024	一次性模板和长期模板不能混用
200	28014025	被禁止使用订阅通知功能
200	28001005	服务内部错误
200	28014028	只对抖音/抖音极速版/头条开放
200	28014029	新手村权限拦截
200	28014026	发送消息太频繁
200	28014030	tpl_id不合法
200	28014027	存在敏感内容

查询小程序的模板列表在线调试

接口说明

前提条件

使用限制

基本信息

请求头

请求参数

Query

请求示例

响应参数

Body

响应示例

正常响应示例

异常响应示例

错误码

查询小程序的模板列表