抖音开放平台Logo
开发者文档
控制台
  • 服务端API介绍
  • 小游戏 OpenAPI SDK 总览
  • 接口调用凭证
  • 登录
  • 数据缓存
  • 二维码
  • 其它
  • 订阅消息
  • 客服消息
  • 礼包福袋
  • 礼包兑奖
  • 内容安全
  • 推荐流直出游戏能力
  • 动态分享
  • 礼包兑奖

    收藏
    我的收藏

    接口说明

    用户在获取到礼包兑换码进入游戏后,发起核销兑换码的动作,开发者需要使用本接口校验礼包兑换码的有效性。校验通过后才可以发放对应礼包。

    前提条件

    基本信息

    名称描述
    HTTP URL
    https://minigame.zijieapi.com/mgplatform/api/gift/receive_reward
    HTTP Method
    POST
    Scope
    open.ttgame.mgplatform

    请求参数

    请求头
    access-token必填String
    示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
    content-type必填String
    示例:application/json
    固定值"application/json"
    Body
    gift_code必填String
    示例:mg1722924937_11229022
    小游戏完成道具礼包领取后,开发者核销用户的礼包码(长度64字节以内)
    open_id必填String
    示例:ba253642-0590-40bc-40ca
    兑奖用户的OpenID
    uuid必填String
    示例:a017cd52-ca34-4a21-bab1-0844160d06e5
    兑奖通用唯一ID字符串,用于请求幂等(长度64字节以内)
    env_typeString
    示例:development
    可以使用 env_type 以隔离生产环境,若该字段不填写则默认为线上生产环境 可选项: - development 测试环境 - production 线上生产环境

    该字段通过 tt.getEnvInfoSync 接口返回的 unkown 字段获取

    请求示例
    curl --location 'https://minigame.zijieapi.com/mgplatform/api/gift/receive_reward' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{ "uuid": "a017cd52-ca34-4a21-bab1-0844160d06e5", "open_id": "ba253642-0590-40bc-40ca", "gift_code": "mg1722924937_11229022", }'

    响应参数

    Body展开全部子属性
    err_msg必填String
    err_no非0时对应的错误信息文案提示,成功时为空字符串
    err_no必填Int32
    0表示成功
    gift_infoStruct
    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "gift_info": { "play_type": 1, "user_receive_guide": [ "玩小游戏10秒后获得白金礼包" ], "name": "白金强化碎片包", "icon_url": "https://img.byte25cdn.org/image/198082103523233", "gift_effective_start_time": 1722873600, "gift_effective_end_time": 1723737600, "gift_id": "222622358400", "prop_list": { "prop_id": "10111", "name": "白金强化碎片", "icon": "https://img.byte25cdn.org/image/1980821035232290", "count": 10 } }, "err_msg": "", "log_id": "202008121419360101980821035705926A", "err_no": 0 }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    20028001005
    系统内部错误,请重试
    请求重试,若依然无解请向平台提交反馈
    20028001003
    access_token无效
    重新请求生成access_token
    20028001008
    access_token过期,请刷新或重新授权
    重新请求生成access_token
    20028001006
    网络调用错误,请重试
    重试即可
    20028001007
    参数错误
    请仔细检查相关参数
    20028006040
    礼包码重复核销
    该券已经提交过核销记录,无需再提交
    20028006041
    礼包码与open_id的绑定关系有误
    礼包码与open_id的绑定关系有误,请再次确认