消息母板批量查询接口

商户可使用该接口查询可申领的消息模板列表

错误码

公共错误码

业务错误码

状态码	错误码	错误描述	解决方案
400	ILLEGAL_ARGUMENT_PARAMS	无效的参数	请检查入参是否符合接口要求
400	APPINFO_NOT_EXIST	应用信息不存在	请检查传入的应用id是否有误
400	SYSTEM_ERROR	系统繁忙	请检查输入参数是否正确，或者稍后重试
400	INDUSTRY_NOT_SELECTABLE	所选行业暂不开放	所选行业暂不开放
400	BIZ_CONTENT_IS_NULL	biz_content为空	请检查输入参数是否正确

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/open/mini/template/templatelib/query' \ --header 'authorization: ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign' \ --header 'alipay-request-id: $requestid' \ --header 'Content-Type: application/json' \ --data-raw '{ "industry_code":"XS1001", "industry_scenario":"ISC5e562b19c5a24116888e45d2d53130b9", "scene_rule":"long_term_subscribe", "has_push":true, "page_num":1, "page_size":5 }'

{ "template_lib_list": [ { "code": "TMd3ff322d73a74018839c9240911dfa51", "name": "集卡活动开始通知", "industry_code": "XS1001", "industry_scenario": "ISC5e562b19c5a24116888e45d2d53130b9", "keyword_desc": "参与方式,开赛时间,比赛描述", "has_push": true, "scene_rule": "long_term_subscribe", "status": "STARTED", "delivery_settings": "follower", "selectable": true, "not_selectable_reason": { "reason_text": "小程序整改原因xxxx", "action_url": "服务不可选具体说明链接" }, "fatigue": { "unit": "day", "total": "10", "value": "1" } } ], "total_count": 15, "page_num": 1, "page_size": 1 }

请求参数

Header 参数

authorization

string

必需

示例值:

ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign

alipay-request-id

string

必需

示例值:

$requestid

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

industry_code

string

必需

一级行业类目，以XS开头的行业编码。注意事项行业编码见文档：https://www.yuque.com/gehadz/hhzyk5/uwxcq6m3kiohst88?singleDoc#

industry_scenario

string

可选

归属于行业类目下的行业场景注意事项行业场景见文档：https://www.yuque.com/gehadz/hhzyk5/uwxcq6m3kiohst88?singleDoc#

scene_rule

string

必需

可选两种类型，长期性订阅传long_term_subscribe，一次性订阅传one_time_subscribe 枚举值长期订阅: long_term_subscribe 一次性订阅: one_time_subscribe

has_push

boolean

可选

若需要查询带push的消息模板则传true，否则传false

page_num

integer

必需

分页查询参数，分页页码

page_size

integer

必需

分页查询参数，分页大小，规定最大分页大小为10

示例

返回响应

🟢200成功

application/json

Body

template_lib_list

array [object {12}]

消息母板列表

必需

code

string

消息母板code

必需

name

string

消息母板名称

必需

industry_code

string

行业编码

必需

industry_scenario

string

行业场景

必需

keyword_desc

string

关键词描述

必需

has_push

boolean

是否带push

必需

scene_rule

string

必需

描述消息模板为一次性订阅（one_time_subscribe）或长期性订阅（long_term_subscribe）

status

string

母板状态

必需

delivery_settings

string

可选

消息推送类型，follower为粉丝用户，all为所有用户

selectable

boolean

必需

母板是否可选，若为false，则不可申领

not_selectable_reason

object

可选

用于展示母版不可选理由以及具体说明的引导页链接，当模板可选时，本字段为空

fatigue

object

消息疲劳度

必需

total_count

integer

查询结果总数

必需

page_num

integer

分页页码

必需

page_size

integer

必需

分页大小，规定最大分页大小为10

🟠400请求有误

消息母板批量查询接口

错误码#

公共错误码#

业务错误码#

请求参数

返回响应

错误码

公共错误码

业务错误码