抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 服务端API介绍
  • 小游戏 OpenAPI SDK 总览
  • 接口调用凭证
  • 登录
  • 开放数据
  • 二维码
  • 订阅消息
  • 消息推送客服
  • 游戏礼包
  • 游戏内容安全
  • 推荐流直出游戏能力
  • 动态分享
  • 消息推送
  • 消息推送配置接入指引
  • 抖音小游戏「游戏站」礼包消息推送接入指引
  • 抖音客服平台-客服能力消息推送接入指引
  • 抖音客服平台-客服能力
  • Link链接
  • Schema链接
  • 抖音小游戏「游戏站」礼包消息推送接入指引

    收藏
    我的收藏

    技术接入流程 - 礼包模块

    参考流程图:

    游戏站礼包通过消息推送的形式给用户发货,开发者需要在平台上配置好推送的地址,当用户领取礼包时,平台将同步把请求推送到开发者服务器,整体流程可见下图
    为了保障用户领取礼包的体验,开发者需要在礼包上线前做好发货的逻辑验证,并在上线期间保障推送地址所在服务的稳定性,避免出现用户领取礼包失败、领取礼包进入游戏后找不到等问题。建议开发者按照如下流程完成接入:

    详细路径:

    步骤一:消息推送能力接入

    参考:消息推送配置接入指引 进行接入

    步骤二:道具发货协议

    在具体的发货请求中,有效的 payload 会放在请求的 body 中,开发者可在验签成功后对 body 进行解析,并执行具体的发货业务逻辑。
    请求
    编码协议:JSON
    字段名
    字段类型
    必须
    说明
    gift_id
    int64
    发货时对应的礼包ID,正式请求一般有,在道具测试阶段无
    gift_code
    string
    此次发货使用的礼包码,可用于消息去重
    在执行发货时,无法避免同一条发货消息的重复推送,开发者需通过 gift_code 保障幂等(保留24小时即可),避免同一个 gift_code 被多次使用,造成损失
    open_id
    string
    领奖用户的 open_id
    prop_list
    array
    此次发货的道具列表,正常情况下,开发者需给用户账号增加这些道具资产
    prop_list.prop_id
    string
    道具列表中当前道具的道具ID
    prop_list.name
    string
    道具列表中当前道具的道具名称
    prop_list.count
    int64
    道具列表中当前道具的发货数量
    env_type
    string
    发货请求的环境标识
      development:调试环境,使用平台测试推送入口时使用
      production:正式环境,用户正式领取礼包时使用
    send_time
    int64
    礼包推送请求触发的秒级时间戳
    示例:
    { "gift_id": 7461891275051078697, "gift_code": "cdk0000001", "open_id": "_0000-vQJEof2jifeowf1TbzSda6jg", "prop_list": [ { "prop_id": "coin003", "name": "游戏金币", "count": 5 }, { "prop_id": "skin002", "name": "皮肤", "count": 1 } ], "env_type": "production", "send_time": 1737619782 }
    响应
    正常响应
    HTTP 状态码:200
    HTTP 响应体:JSON
    { "success": true }
    异常响应
    HTTP 状态码:200(非200响应可能导致礼包下架, 无法发货请通过下方错误码返回
    HTTP 响应体:JSON
    { "success": false, "err_code": 100001, "reason": "失败原因" }
    err_code 错误码枚举
    err_code
    说明
    100001
    未注册/未登录/未创建角色,用户未满足领取条件
    100002
    触发频控,允许稍后重试

    步骤三:道具推送测试

    推送测试
    示例图
      完成道具配置后,可在道具列表点击「道具推送测试」来触发消息推送
      请按照提示输入你用来测试的抖音UID,以及本次发货使用的CDKey(也即上面的 gift_code 字段),并选择此次推送的道具,点击确定后,你将在下方的实时日志中看到此次请求的详细内容
      完成道具推送测试和确认发货能力正常后,可进入礼包列表界面新增游戏站礼包
    详情见下方厂商运营管理后台配置示意图

    步骤四:礼包下发弹窗-告知用户

    推送测试
    示例图
      请配合平台,将游戏礼包&道具统一下发到游戏内账号邮箱中,用户可自行进行领取,展示规则如下:
      icon、名称对齐平台配置礼包名称、道具名称
      过期时间需披露

    步骤五:配置道具&礼包,完成上线

    示例图

    配置入口

    小游戏开发者平台 - 运营能力 - 道具&礼包营销
    开发者后台展示
    游戏站礼包

    配置道具

    新建道具内容,配置后进入审核,审核通过后即可创建礼包
      审核结果会通过短信和站内信通知,请留意通知结果
    创建道具
    道具管理列表

    配置礼包,完成上线

    新建礼包内容,配置后进入审核,审核通过后礼包进入待上线或上线状态
      建议配置高价值礼包提升用户转化效果,每日签到小游戏站与每日登录游戏各配置 1 个
      审核结果会通过短信和站内信通知,请留意通知结果
      请尽量配置充足礼包库存,避免用户无法领取,库存<=20%时,会通过站内信短信提醒,请留意通知
    创建礼包
    礼包管理列表