查询用户模板订阅状态
收藏接口说明
获取当前小程序下用户和小程序模版的订阅状态
前提条件
需要小程序已上线
使用限制
无
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/notification/v2/subscription/query_user_subscribe/ |
| HTTP Method | POST |
| 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"
Body
msg_id必填String
示例：MSG1739739273736
消息模板的 id，来自添加模板接口
open_id必填String
示例：ba253642-0590-40bc-9bdf-9a1334b94059
需要查询的目标用户 OpenID
请求示例
curl --location --request POST 'https://open.douyin.com/api/notification/v2/subscription/query_user_subscribe/' \ --header 'access-token: clt.0801121846735352506a356a6' \ --header 'content-type: application/json' \ --data ' { "msg_id": "MSG38489d04608c5f0fdeb565fc5114afff6410*******", "open_id": "36d4bd3c8****", } '
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例："access_token无效"
错误描述
err_no必填Int32
示例：28001003
错误码
log_id必填String
示例："202405291440576E078D8757B9"
日志id
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "", "log_id": "20230213140437EEEDFAB3025AEA105C06", "data": { "subscribe_status": 1, "user_allow_notification": false } }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28014001 | 参数错误 | |
| 200 | 28001005 | 系统内部错误，请重试 | 自行重试，重试无效请联系平台 Oncall 解决 |
| 200 | 28014025 | 被禁止使用订阅通知功能 | 小程序订阅消息能力被封禁 |
| 200 | 28014037 | 模版状态不可用 | 当前小程序模板已经被封禁，请更换小程序模板或联系平台 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 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
