给用户发送订阅消息__抖音开放平台

接口说明

发送订阅消息V1 接口预期下线时间为2024.07.01，接口文档下线后V1接口停止维护，后续建议统一使用该接口发送订阅消息
用户产生了订阅模板消息的行为后，可以通过该接口发送模板消息给用户。功能参考订阅消息。

前提条件

通过设置该接口入参的 notify_type 字段发送抖音内横幅或抖音外实时提醒消息说明：

消息模版需支持实时提醒能力：

开发者在抖音开放平台-控制台-选中小程序-互动能力-订阅消息-模版库-申请新模版时在“是否使用额外触达能力中”选中“实时提醒”选项；
开发者基于已具备实时提醒能力的模版选择"“添加”生成我的模版。

用户需同意打开提醒能力：

开发者在小程序中拉起订阅组件后，用户针对特定模版点击右侧的“添加提醒”后点击“同意”；
用户在订阅消息管理页针对特定模版勾选“提醒订阅消息”；

开发者可订阅抖音内横幅或抖音站外实时提醒触达用户失败事件获取触达用户失败原因。

消息额度说明：

针对存量一次性模版，用户订阅一次该模版，开发者一年内仅可发送2条模版消息，用户再次订阅该模版，开发者发送模版消息额度累加；
针对存量长期模版，用户订阅一次该模版，开发者每30天可发送8条模版消息，用户再次订阅该模版，开发者发送模版消息额度不做累加；
开发者可在抖音开放平台-控制台-选中小程序-互动能力-订阅消息-模版库-申请新模版时选择默认模版消息额度或自定义模版消息额度，审核成功后消息额度生效。

使用限制

无

基本信息

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

请求参数

Body

名称	字段类型	是否必填	示例	描述
data	Map	是		模板内容
msg_id	String	是		消息模板的 id，来自添加模板接口
open_id	String	是		接收消息目标用户的 open_id，参考 code2session
notify_type	List	否	[1,2]	发送消息模式列表；枚举说明：[1] 表示仅发送抖音内横幅或抖音外实时提醒消息（用户在抖音端内则发送站内横幅，用户在抖音端外则发送站外push）； [2] 表示仅发送订阅消息；发消传参：[1]仅发送push，如订阅模板不支持push或用户未订阅push通知，则不支持发送。[2]仅发送订阅消息。[1,2] 同时支持发送订阅消息和抖音内横幅或抖音外实时提醒消息，如果订阅模板不支持push或用户未订阅push通知，则只发送订阅消息。
page	String	否	pages/presaleCoupon/couponDetails/ticketDetails?orderId=****	小程序页面链接，由页面的query和path参数构成；目前暂不支持跳转外部链接

请求示例

curl --location --request POST 'https://open.douyin.com/api/notification/v2/subscription/notify_user/' \
--header 'access-token: 0801121846735352506a356a6' \
--header 'content-type: application/json' \
--data '
  {
  "msg_id": "MSG38489d04608c5f0fdeb565fc5114afff6410*******",
  "open_id": "36d4bd3c8****",
  "data": {
    "物品名称": "测试值0",
    "购买金额": "测试值1"
  },
  "notify_type":[1,2]
  "page": "pages/index?a=b"
  }
'

响应参数

Body

名称	字段类型	是否必填	示例	描述
err_msg	String	是	“”	错误信息
err_no	Int32	是	0	错误码，0 是成功，其它为异常
log_id	String	是	202008121419360101980821035705926A	标识请求的唯一id，在接口异常时用于问题排查

响应示例

正常响应示例

{
  "err_no": 0,
  "err_msg": "",
  "log_id": "202008121419360101980821035705926A"
}

异常响应示例

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

错误码

http状态码	错误码	错误码描述	排查建议
200	28001038	参数错误	按err_msg检查入参
200	28014024	一次性模板和长期模板不能混用
200	28014025	被禁止使用订阅通知功能
200	28001005	服务内部错误	重试仍无效时提oncall
200	28014028	只对抖音/抖音极速版/头条开放
200	28014029	新手村权限拦截
200	28014026	发送消息太频繁
200	28014030	tpl_id不合法
200	28014027	存在敏感内容
200	28001003	access_token无效	重新请求生成access_token
200	28001008	access_token过期,请刷新或重新授权	重新请求生成access_token
200	28001016	当前应用已被封禁或下线	clientKey被封禁或者下线
200	28001006	网络调用错误，请重试	重试即可
200	28001014	应用未授权任何能力	确认应用是否授权能力
200	28001018	应用未获得该能力	开通相关能力
200	28003017	quota已用完	联系平台处理
200	28001019	应用该能力已被封禁	该能力被封禁，联系平台处理
200	28001007	参数不合法	根据错误信息检查请求参数是否填写正常

开发者平台

给用户发送订阅消息

接口说明

前提条件

使用限制

基本信息

请求头

请求参数

Body

请求示例

响应参数

Body

响应示例

正常响应示例

异常响应示例

错误码

Bug & Tip

给用户发送订阅消息在线调试

接口说明

前提条件

使用限制

基本信息

请求头

请求参数

Body

请求示例

响应参数

Body

响应示例

正常响应示例

异常响应示例

错误码

​Bug & Tip​

给用户发送订阅消息

Bug & Tip