跳到主要内容

奖品回调通知

最后更新：2024/08/30

回调说明​

当用户获得了奖品信息的时候，会回调奖品对应的数据到创建活动时配置的回调地址中;
此 API 需要访问NOTIFY TOKEN

回调请求​

请求头参数​

  • 请求方法：POST
  • 请求认证：Authorization: Token $NOTIFY_TOKEN
  • 内容类型：application/json

请求参数​

请求包体：

{
    "task_id": "kdiejsuehd73jf84kfde",
    "campaign_id": "cje49g6rdj7lp3l9rslg",
    "reward_id": "cj3j9s6rdj7t7pbv6pog",
    "reward_title": "设置的奖品名称", 
    "reward_type": 1, 
    "reward_num": 100,
    "kv_data": {
        "key1": "value1",
        "key2": "value2"
    },
    "user_id": "活动用户的ID标识",
    "invite_list": [
        {
            "user_id": "被邀请人用户的ID标识",
            "device_id": "被邀请人设备的ID标识",
            "invite_time": 1692668795,
            "platform": "ios"
        }
    ],
    "user_pid": "活动用户的上级用户ID标识", 
    "lang": "en", 
    "title": "活动标题",
    "user_platform": "ios",
    "parent_platform": "android"
}

参数说明：

参数必须类型说明
task_id是string回调任务ID
campaign_id是string活动 ID
reward_id是string奖品 ID
reward_title是string设置的奖品名称
reward_num是number发放的奖品数量
kv_data是object活动奖励配置的键值数据,也就是奖品的标识
user_id是string活动用户的ID标识，也就是app项目提供的用户标识
invite_list否[]object活动用户的邀请记录
invite_list.user_id否string被邀请人的用户ID标识
invite_list.device_id否string被邀请人的设备ID标识
invite_list.platform否string被邀请人的设备平台（详情查看tip提供的平台枚举）
invite_list.invite_time是number邀请时间
user_pid否string活动用户的上级用户ID标识，该值目前只在一起赢奖励活动获取新人奖时才有值
lang是string当前奖品发放时，用户绑定的语言标识 查看国际语言代码
title是string活动标题
user_platform是string活动用户设备平台（详情查看tip提供的平台枚举）
parent_platform否string活动用户的上级用户设备平台（详情查看tip提供的平台枚举）
reward_type是number奖品类型（1-活动奖品，2-站外活动奖品，3-额外奖品，4-新人奖品）

tip: 平台枚举：ios-苹果，ipad-苹果平板，android-安卓，web-pc网页，other-未上报关联

响应处理​

当回调处理成功之后，请返回字符串success；

当服务器收不到success返回，每过5分钟会重新回调一次，共回调5次；