抖音开放平台Logo
控制台

发送订阅消息

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

用户产生了订阅模板消息的行为后，可以通过这个接口发送模板消息给用户，功能参考订阅消息能力。


Bug & Tip

  • 请求 body 的Content-Type限定为application/json。
  • 对单个用户推送消息，频率限制为 1 次/秒。
  • 订阅消息分为一次性订阅和长期订阅（内测中），详情参考订阅消息能力。

基本信息

名称描述
HTTP URL
https://minigame.zijieapi.com/mgplatform/api/apps/subscribe_notification/developer/v1/notify
HTTP Method
POST
Scope
open.ttgame.mgplatform

请求头

名称字段类型是否必填示例描述
content-typeString是application/json
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
access_tokenString是08011218462b6b4b5054626e426e50685a7554643144644449413d3d
调用https://minigame.zijieapi.com/mgplatform/api/apps/v2/token生成的token
app_idString是

小程序的 id

open_idString是

接收消息目标用户的 open_id，参考code2session

tpl_idString是

模板的 id，参考订阅消息能力

pageString否

跳转的页面，可参考小程序订阅消息

page参数，一般小游戏场景下无需使用

请求示例

curl -X POST \
 -H "content-type: application/json" \
 -d '{"access_token":"080112********6b6c537666514d413d3d","app_id":"tt4*********65","tpl_id":"MSG*********5237304","open_id":"vziikC*******FR9","page":"","data":{"名次": 1, "奖励": "500钻石", "领取时间": "202x-0x-xx"}}' \
 https://minigame.zijieapi.com/mgplatform/api/apps/subscribe_notification/developer/v1/notify

响应参数

Body

名称字段类型是否必填示例描述
err_noInt64否
错误码
err_tipsString否
错误信息

响应示例

正常响应示例

{
  "err_no": 0,
  "err_tips": ""
}

异常响应示例

{
  "err_no": 1001,
  "err_tips": "app_id / open_id不合法"
}

错误码

http状态码错误码错误码描述排查建议
2000
成功
2001000
参数格式有误
2001001
参数内容有误
2001008
通知内容违规
2001009
推送消息能力被封禁
2001010
发送消息过于频繁
2002000
服务内部错误