通用场景
商户使用该接口可以查询用户对其消息模板的订阅关系，可以根据是否订阅引导用户进行订阅和精准触达消息
公共请求参数
业务请求参数
template_id_list｜消息模版id列表必选array[1,3]
【描述】消息模板id，可以填写多个，最多不超过3个。模板id需要保持同一个应用主体，并且展示在同一个订阅组件中的模板id。
模板id获取详情参见模板消息。
【示例值】["6511999536b14ba5830e3a0289ea69a","0b1fcca882aa435382ae98641e14d37","a3b396be6fd345579221af5dea35028"]
以下参数 二选一 传入
user_id｜支付宝useridstring[0,32]
【描述】订阅消息模板用户的支付宝唯一标识，2088开头。
新商户建议使用open_id替代该字段。对于新商户，user_id字段未来计划逐步回收，存量商户可继续使用。如使用open_id，请确认 应用-开发配置-openid配置管理 已启用。无该配置项，可查看openid配置申请。
【示例值】20882028****0410
open_id｜支付宝openidstring[0,128]
【描述】支付宝openid，用于支付宝用户在当前应用下的用户标识。 详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.messagetemplate.subscribe.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"user_id":"20882028****0410",
"open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
"template_id_list":[
"6511999536b14ba5830e3a0289ea69a",
"0b1fcca882aa435382ae98641e14d37",
"a3b396be6fd345579221af5dea35028"
]
}' 说明：本示例仅供参考。
公共响应参数
业务响应参数
show_component｜是否显示订阅组件必选boolean(8)
【描述】是否显示订阅组件
【枚举值】
显示订阅组件: true
不显示订阅组件: false
【示例值】true
subscribe_relations｜订阅关系列表特殊可选subscriberelation[]
【描述】用户对消息模板的订阅关系列表，为入参中的用户id对消息模板id的订阅关系。
限制：用户未订阅消息，该参数不返回。
template_id｜消息模板id必选string(64)
【描述】消息模板id
【示例值】7c866fab64464afaa956223c74ce6cbc
subscribe_type｜订阅类型必选string(20)
【描述】消息模板的订阅类型
【枚举值】
长期性订阅: longterm
一次性订阅: onetime
【示例值】longterm
subscribe_state｜订阅状态必选string(5)
【描述】订阅状态
【枚举值】
拒绝订阅: 0
订阅: 1
【示例值】0
keep_state｜保持订阅状态可选string(5)
【描述】订阅保持状态，即用户勾选“总是保持以上选择，不再询问”选项时勾选的订阅状态。说明：若用户“总是保持以上选择，不再询问”选项，且选择订阅消息。下次触发消息订阅组件时，支付宝将自动发起一次静默订阅（不再拉起订阅组件，无需用户手动订阅）。
【枚举值】
保持订阅: 1
保持拒绝订阅: 0
【示例值】0
show｜模板是否展示在订阅组件中可选boolean(10)
【描述】模板是否展示在订阅组件中
【枚举值】
订阅组件中展示查询的模板: true
订阅组件中不展示模板: false
【示例值】true
响应示例
正常示例
异常示例
{
"alipay_open_app_messagetemplate_subscribe_query_response": {
"code": "10000",
"msg": "success",
"subscribe_relations": [
{
"template_id": "7c866fab64464afaa956223c74ce6cbc",
"subscribe_type": "longterm",
"subscribe_state": "0",
"keep_state": "0",
"show": true
}
],
"show_component": true
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| biz_content_is_null | biz_content字段为空 | 请检查输入参数是否正确 |
| illegal_argument_params | 无效的参数 | 检查入参协议是否符合文档描述 |
| msg_template_invalid | 无效的消息模板内容template | 请输入正确的消息的模板内容 |
| msg_template_not_exist | 消息模板id列表为空 | 请按照文档协议传入消息模板id列表 |
| openid_invalid | 无效的userid | 请输入正确的支付宝账号id |
| subscribe_template_over_limit | 查询订阅关系模板不能超过3个 | 减少输入查询模板的数量 |