# 发送订阅消息

# 1、接口地址

  • 生产环境:https://xxxxxxx/api/dyminigame/subscribenotification

域名请联系发行获取(安全模块域名)

# 2、使用场景

WARNING

  • 前提:抖音小游戏用户才能调用接口:
  • 场景:开启消息订阅功能,并在抖音开发者平台配置了消息订阅模版。
  • 逻辑:消息订阅模版配置好后,用户达到触发模版内容条件时,游戏服务器调用本接口,本接口通知抖音触达用户。
  • 参考抖音订阅消息能力 (opens new window)

# 3、接口说明

DANGER

  • 非必接

# 4、请求方式

  • 方式:POST

  • 接入方式: 直接接入

    请求参数: headers头 Body raw(JSON)

参数类型 字段名 值类型 必填 说明
Body appId int 产品ID
Body timespan long 当前时间戳,秒,前后2小时有效
Body sign long 接口加密签名md5("accountId=" + accountId + "&appId=" + appId + "&openId=" + openId + "&tplId=" + tplId + "&timespan=" + timespan + appkey)
Body accountId long SDK用户登录后的账号ID
Body mainChannel int sdk配置的主渠道ID
Body secondChannel int sdk配置的次渠道ID
Body openId string 抖音小游戏的用户open_id
Body tplId string 抖音开发者后台配置的消息订阅模板 id
Body data json 用于填充模板的关键词数据 _key为对应小游戏消息模板关键字列表里的关键字,模版信息可参考查询小程序的模板列表,以某个排行榜奖励领取提醒模板为例,关键字列表(keyword_list)有"名次"、"奖励"、"领取时间"三个,此处_key则可以填写这三个关键字,参考抖音 (opens new window)
Body page string 跳转的页面,可参考小程序订阅消息page参数,一般小游戏场景下无需使用

# 5、接口响应说明

  • 请求示例
{"appId":1363299671,"sign":"1236c84d2332bb1d9716585f2803864e","timespan":1742441232,"mainChannel":100774,"secondChannel":100775,"accountId":2111124236,"openId":"_0c071Rose4vzWaGGNvgezdFEhksQIAzpFRY","tplId":"test","data":{"名次": 1, "奖励": "500钻石", "领取时间": "202x-0x-xx"}}
  • 验证不通过响应结果JSON格式

    {
    "resultCode": 14005,
    "datum": {
        "err_no": 28001038,
        "err_tips": "msg_id不合法"
    },
    "resultInfo": "推送抖音失败",
    "rid": "sidysubscribenotifi.9ce86a75cd4a4bb090da7ffabf78ff7b"
    }
    
    
  • 返回说明:

参数类型 字段名 值类型 说明 备注
result resultCode int 响应值 10000发送消息成功,其它失败
result resultInfo string 提示信息
result rid string response identifies(响应唯一标识)
result datum T 抖音返回消息 内容说明 (opens new window)
Last Updated: 2025/3/25 14:36:04