模板订阅关系查询

商户使用该接口可以查询用户对其消息模板的订阅关系，可以根据是否订阅引导用户进行订阅和精准触达消息

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/open/app/messagetemplate/subscribe/query' \ --header 'Content-Type: application/json' \ --data-raw '{ "open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5", "user_id": "2088202882050410", "template_id_list": "[\"6511999536b14ba5830e3a0289ea69a\",\"0b1fcca882aa435382ae98641e14d37\",\"a3b396be6fd345579221af5dea35028\"]" }'

{ "show_component": true, "subscribe_relations": [ { "keep_state": "0", "show": true, "subscribe_state": "0", "subscribe_type": "longterm", "template_id": "7c866fab64464afaa956223c74ce6cbc" } ] }

请求参数

Body 参数application/json

open_id

string

可选

支付宝openId，用于支付宝用户在当前应用下的用户标识。

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

user_id

string

可选

订阅消息模板用户的支付宝唯一标识，2088开头。

示例值:

2088202882050410

template_id_list

array[string]

可选

消息模板id，可以填写多个，最多不超过3个。模板id需要保持同一个应用主体，并且展示在同一个订阅组件中的模板id。模板id获取详情参见模板消息。

示例值:

["6511999536b14ba5830e3a0289ea69a","0b1fcca882aa435382ae98641e14d37","a3b396be6fd345579221af5dea35028"]

示例

返回响应

🟢200common response

application/json

Body

show_component

boolean

可选

是否显示订阅组件。枚举值： true：显示订阅组件。 false：不显示订阅组件

示例值:

true

subscribe_relations

array[object (SubscribeRelation) {5}]

可选

用户对消息模板的订阅关系列表，为入参中的用户id对消息模板id的订阅关系。限制：用户未订阅消息，该参数不返回。

keep_state

string

可选

订阅保持状态，即用户勾选“总是保持以上选择，不再询问”选项时勾选的订阅状态。枚举值： 1：保持订阅。 0：保持拒绝订阅。说明：若用户“总是保持以上选择，不再询问”选项，且选择订阅消息。下次触发消息订阅组件时，支付宝将自动发起一次静默订阅（不再拉起订阅组件，无需用户手动订阅）。

示例值:

show

boolean

可选

模板是否展示在订阅组件中。枚举值： true：订阅组件中展示查询的模板。 false：订阅组件中不展示模板

示例值:

true

subscribe_state

string

可选

订阅状态。枚举值 0：拒绝订阅。 1：订阅

示例值:

subscribe_type

string

可选

消息模板的订阅类型。枚举值： longterm：长期性订阅 onetime：一次性订阅

示例值:

longterm

template_id

string

消息模板id

可选

示例值:

7c866fab64464afaa956223c74ce6cbc

🔴500请求失败