创建邀请有礼活动

请求参数

Body 参数application/json

appKey

string

appKey

必需

operatorOrgId

string

操作人id

必需

operatorOrgType

string

操作人类型

必需

operator

string

操作人

必需

data

object

必需

businessSystemId

string

业务体系id

必需

activityName

string

活动名称

必需

activityType

string

活动类型

必需

activityDescription

string

活动描述

必需

startTime

string

开始时间

必需

endTime

string

结束时间

必需

additionalJson

object

必需

下面是每满奖励json结构：~~~ json{ "inviterConfigInfo": { "rewardModel": 1, "rewardInfoList": [ { "issuePolicy": "", "rewardLines": 3, "rewardDetailList": [ { "id": "2342342", "couponType": "满减券", "worth": "30", "name": "3元满减券", "amount": 3, "rewardType": 1 } ], "rewardRangeInfoList": [ { "order": 1, "minLines": 0, "maxLines": 3, "rewardIds": [ "2342342", "5455467546" ] }, { "order": 2, "minLines": 3, "maxLines": 6, "rewardIds": [ "23423423", "54554675462" ] } ] } ] }, "inviteeConfigInfo":{ "rewardSwitch":false, "onlyOne":true, "rewardInfo":{ "issuePolicy":"", "rewardDetailList":[ { "id":"2342342", "couponType":"满减券", "worth":"30", "name":"3元满减券", "amount":3, "rewardType":1 } ] } }, "backgroundInfo":{ "imgUrl":"www.baidu.com", "color":"黑色" }, "shareConfigInfo":{ "title":"领红包了", "description":"描述", "imgUrl":"www.baidu.com" }}~~~下面是阶梯奖励json结构：~~~ json{ "inviterConfigInfo":{ "rewardModel":1, "rewardInfoList":[ { "issuePolicy":"", "rewardLines":3, "rewardDetailList":[ { "id":"2342342", "couponType":"满减券", "worth":"30", "name":"3元满减券", "amount":3, "rewardType":1 } ] } ] }, "inviteeConfigInfo":{ "rewardSwitch":false, "onlyOne":true, "rewardInfo":{ "issuePolicy":"", "rewardDetailList":[ { "id":"2342342", "couponType":"满减券", "worth":"30", "name":"3元满减券", "amount":3, "rewardType":1 } ] } }, "backgroundInfo":{ "imgUrl":"www.baidu.com", "color":"黑色" }, "shareConfigInfo":{ "title":"领红包了", "description":"描述", "imgUrl":"www.baidu.com" }}~~~### 下面是描述信息* inviterConfigInfo：邀请人配置； * rewardModel：奖励模式：1 每满奖励，2 阶梯奖励 * rewardInfoList：奖励信息列表 * issuePolicy：发放策略：空全部发放，1 随机一张，2随机两张，3 随机三张，以此类推 * rewardLines：满多少奖励， * rewardDetailList:奖励明细 * id:奖励id：优惠券id，积分id * couponType：类型：优惠券类型 * worth：价值，优惠券价值（当为满减券传值couponWorth,当为折扣券传值maxDiscountAmount），积分价值 * name:奖励名称 * amount：奖励数量 * rewardType:奖励类型：1 优惠券，2 积分，3 成长值 * rewardRangeInfoList：每满奖励范围配置 * order：排序号 * minLines：最小次数 * maxLines：最大次数 * rewardIds：奖励id列表（优惠券就是优惠券id列表） * inviteeConfigInfo：被邀请人配置； * rewardSwitch：奖励开关 * onlyOne：仅一次 * rewardInfo：奖励信息 * issuePolicy：发放策略：空全部发放，1 随机一张，2随机两张，3 随机三张，以此类推 * rewardDetailList:奖励明细 * id:奖励id：优惠券id，积分id * couponType：类型：优惠券类型 * worth：价值，优惠券价值（当为满减券传值couponWorth,当为折扣券传值maxDiscountAmount），积分价值 * name:奖励名称 * amount：奖励数量 * rewardType:奖励类型：1 优惠券，2 积分，3 成长值 * backgroundInfo：背景页设置 * imgUrl：图片url * color:颜色 * shareConfigInfo：分享配置 * title：标题 * description：描述 * imgUrl：图片url

rules

array [object {4}]

必需

"rules":[
            {
                "ruleTemplateId":7,
                "name":"邀请有礼参与规则模板",
                "ruleInstanceDesc":"邀请有礼参与规则模板",
                "ruleDetails":[
                    {
                        "ruleDictCode":"invite_crowd",
                        "descrption":"邀请人群设置",
                        "ruleDetailValue":""
                    },
                    {
                        "ruleDictCode":"invite_activity_type",
                        "descrption":"邀请活动类型（1 助力，2 拉新）",
                        "ruleDetailValue":"1"
                    },
                    {
                        "ruleDictCode":"invite_task_period",
                        "descrption":"邀请任务周期(单位:h)",
                        "ruleDetailValue":"2"
                    },
                    {
                        "ruleDictCode":"invite_task_max_count",
                        "descrption":"单个用户可发起邀请任务次数",
                        "ruleDetailValue":"3"
                    },
                    {
                        "ruleDictCode":"user_assistance_max_count",
                        "descrption":"用户助力最大次数",
                        "ruleDetailValue":"4"
                    }
                ]
            }
        ]

上面json中的
invite_crowd 指的是邀请人群设置；
invite_activity_type指的是邀请活动类型（1 助力，2 拉新）；
invite_task_period指的是邀请任务周期(单位:h)；
invite_task_max_count指的是单个用户可发起邀请任务次数；
user_assistance_max_count指的是用户助力最大次数；
不限制的值都可以为空

示例

{
  "appKey": "vientiane",
  "data": {
    "activityDescription": "qq",
    "activityName": "邀请有礼-l",
    "activityType": "INVITE_REWARD",
    "additionalJson": {
      "inviterConfigInfo": {
        "rewardModel": 2,
        "rewardInfoList": [
          {
            "issuePolicy": "",
            "rewardLines": "3",
            "rewardDetailList": [
              {
                "id": "282485436487764512",
                "name": "metersphere创建无规则券",
                "couponType": "REDUCE",
                "worth": 1,
                "amount": 1,
                "rewardType": 1,
                "couponList": {
                  "id": "282485436487764512",
                  "code": "uUVtMWkmrKabh1b",
                  "platformName": "YUNDA",
                  "deliverChannel": "PROMOTION_ACTIVITY",
                  "couponName": "metersphere创建无规则券",
                  "couponStatus": "PROCESSING",
                  "activityId": "282485436487764536",
                  "remark": "metersphere创建无规则券",
                  "useStartTime": "2021-11-02 00:00:00",
                  "useEndTime": "2032-03-20 23:59:59",
                  "pickupStartTime": "2021-11-02 00:00:00",
                  "pickupEndTime": "2031-11-30 23:59:59",
                  "pickupAfterPeriod": 0,
                  "pickupAfterDays": "111",
                  "issueMaxAmount": 10000,
                  "pickupAmount": 0,
                  "usedAmount": 0,
                  "writeOffAmount": 0,
                  "miniOrderAmount": 10,
                  "maxDiscountAmount": 0,
                  "discountAmount": 1,
                  "discountRate": 0,
                  "businessSystemId": "expressBusiness",
                  "couponType": "REDUCE",
                  "couponDescription": "metersphere创建无规则券",
                  "useChannels": ""
                },
                "totalLimitNumber": 10,
                "todayLimitNumber": 1
              }
            ]
          },
          {
            "issuePolicy": "",
            "rewardLines": "6",
            "rewardDetailList": [
              {
                "id": "282485436487762518",
                "name": "metersphere创建无规则券",
                "couponType": "REDUCE",
                "worth": 1,
                "amount": 1,
                "rewardType": 1,
                "couponList": {
                  "id": "282485436487762518",
                  "code": "kyUtMWkmrKM9Zl8",
                  "platformName": "YUNDA",
                  "deliverChannel": "PROMOTION_ACTIVITY",
                  "couponName": "metersphere创建无规则券",
                  "couponStatus": "PROCESSING",
                  "activityId": "282485436487762516",
                  "remark": "metersphere创建无规则券",
                  "useStartTime": "2021-11-02 00:00:00",
                  "useEndTime": "2032-03-20 23:59:59",
                  "pickupStartTime": "2021-11-02 00:00:00",
                  "pickupEndTime": "2031-11-30 23:59:59",
                  "pickupAfterPeriod": 0,
                  "pickupAfterDays": "111",
                  "issueMaxAmount": 10000,
                  "pickupAmount": 0,
                  "usedAmount": 0,
                  "writeOffAmount": 0,
                  "miniOrderAmount": 10,
                  "maxDiscountAmount": 0,
                  "discountAmount": 1,
                  "discountRate": 0,
                  "businessSystemId": "expressBusiness",
                  "couponType": "REDUCE",
                  "couponDescription": "metersphere创建无规则券",
                  "useChannels": ""
                },
                "totalLimitNumber": 10,
                "todayLimitNumber": 5
              }
            ]
          },
          {
            "issuePolicy": "",
            "rewardLines": "9",
            "rewardDetailList": [
              {
                "id": "282484697753394427",
                "name": "metersphere创建无规则券",
                "couponType": "REDUCE",
                "worth": 1,
                "amount": 1,
                "rewardType": 1,
                "couponList": {
                  "id": "282484697753394427",
                  "code": "fHNT0WXmrKU2Trq",
                  "platformName": "YUNDA",
                  "deliverChannel": "PROMOTION_ACTIVITY",
                  "couponName": "metersphere创建无规则券",
                  "couponStatus": "PROCESSING",
                  "activityId": "282484697753394425",
                  "remark": "metersphere创建无规则券",
                  "useStartTime": "2021-11-02 00:00:00",
                  "useEndTime": "2032-03-20 23:59:59",
                  "pickupStartTime": "2021-11-02 00:00:00",
                  "pickupEndTime": "2031-11-30 23:59:59",
                  "pickupAfterPeriod": 0,
                  "pickupAfterDays": "111",
                  "issueMaxAmount": 10000,
                  "pickupAmount": 0,
                  "usedAmount": 0,
                  "writeOffAmount": 0,
                  "miniOrderAmount": 10,
                  "maxDiscountAmount": 0,
                  "discountAmount": 1,
                  "discountRate": 0,
                  "businessSystemId": "expressBusiness",
                  "couponType": "REDUCE",
                  "couponDescription": "metersphere创建无规则券",
                  "useChannels": ""
                },
                "totalLimitNumber": 15,
                "todayLimitNumber": 5
              }
            ]
          }
        ]
      },
      "inviteeConfigInfo": {
        "rewardSwitch": true,
        "onlyOne": true,
        "rewardInfo": {
          "issuePolicy": 1,
          "rewardDetailList": [
            {
              "id": "282485436487762512",
              "name": "metersphere创建无规则券",
              "couponType": "REDUCE",
              "worth": 1,
              "amount": 1,
              "rewardType": 1,
              "totalLimitNumber": 100,
              "todayLimitNumber": 1,
              "couponList": {
                "id": "282485436487762512",
                "code": "eyUtMWkmrKAgNwc",
                "platformName": "YUNDA",
                "deliverChannel": "PROMOTION_ACTIVITY",
                "couponName": "metersphere创建无规则券",
                "couponStatus": "PROCESSING",
                "activityId": "282485436487762511",
                "remark": "metersphere创建无规则券",
                "useStartTime": "2021-11-02 00:00:00",
                "useEndTime": "2032-03-20 23:59:59",
                "pickupStartTime": "2021-11-02 00:00:00",
                "pickupEndTime": "2031-11-30 23:59:59",
                "pickupAfterPeriod": 0,
                "pickupAfterDays": "111",
                "issueMaxAmount": 10000,
                "pickupAmount": 0,
                "usedAmount": 0,
                "writeOffAmount": 0,
                "miniOrderAmount": 10,
                "maxDiscountAmount": 0,
                "discountAmount": 1,
                "discountRate": 0,
                "businessSystemId": "expressBusiness",
                "couponType": "REDUCE",
                "couponDescription": "metersphere创建无规则券",
                "useChannels": ""
              }
            },
            {
              "id": "282484697753394427",
              "name": "metersphere创建无规则券",
              "couponType": "REDUCE",
              "worth": 1,
              "amount": 1,
              "rewardType": 1,
              "totalLimitNumber": 100,
              "todayLimitNumber": 1,
              "couponList": {
                "id": "282484697753394427",
                "code": "fHNT0WXmrKU2Trq",
                "platformName": "YUNDA",
                "deliverChannel": "PROMOTION_ACTIVITY",
                "couponName": "metersphere创建无规则券",
                "couponStatus": "PROCESSING",
                "activityId": "282484697753394425",
                "remark": "metersphere创建无规则券",
                "useStartTime": "2021-11-02 00:00:00",
                "useEndTime": "2032-03-20 23:59:59",
                "pickupStartTime": "2021-11-02 00:00:00",
                "pickupEndTime": "2031-11-30 23:59:59",
                "pickupAfterPeriod": 0,
                "pickupAfterDays": "111",
                "issueMaxAmount": 10000,
                "pickupAmount": 0,
                "usedAmount": 0,
                "writeOffAmount": 0,
                "miniOrderAmount": 10,
                "maxDiscountAmount": 0,
                "discountAmount": 1,
                "discountRate": 0,
                "businessSystemId": "expressBusiness",
                "couponType": "REDUCE",
                "couponDescription": "metersphere创建无规则券",
                "useChannels": ""
              }
            }
          ]
        }
      },
      "backgroundInfo": {
        "color": "#cad4ba",
        "imgUrl": "http://10.171.32.18:31005/promotioncenter/picture/202111/20211103103516779.png"
      },
      "shareConfigInfo": {
        "title": "分享",
        "description": "11",
        "imgUrl": "http://10.171.32.18:31005/promotioncenter/picture/202111/20211103103532474.png"
      }
    },
    "businessSystemId": "expressBusiness",
    "endTime": 1637251199000,
    "rules": [
      {
        "name": "邀请有礼参与规则模板",
        "ruleInstanceDesc": "邀请有礼参与规则模板",
        "ruleInstanceDetailList": [
          {
            "ruleDetailValue": "",
            "ruleDictCode": "invite_crowd"
          },
          {
            "ruleDetailValue": "1",
            "ruleDictCode": "invite_activity_type"
          },
          {
            "ruleDetailValue": "",
            "ruleDictCode": "invite_task_period"
          },
          {
            "ruleDetailValue": "",
            "ruleDictCode": "invite_task_max_count"
          },
          {
            "ruleDetailValue": "",
            "ruleDictCode": "user_assistance_max_count"
          }
        ],
        "ruleTemplateId": 7
      }
    ],
    "startTime": 1635868800000
  },
  "operator": "0001|张三测试",
  "operatorOrgId": "",
  "operatorOrgType": ""
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/promotioncenter/activity/create' \
--header 'Content-Type: application/json' \
--data-raw '{
  "appKey": "vientiane",
  "data": {
    "activityDescription": "qq",
    "activityName": "邀请有礼-l",
    "activityType": "INVITE_REWARD",
    "additionalJson": {
      "inviterConfigInfo": {
        "rewardModel": 2,
        "rewardInfoList": [
          {
            "issuePolicy": "",
            "rewardLines": "3",
            "rewardDetailList": [
              {
                "id": "282485436487764512",
                "name": "metersphere创建无规则券",
                "couponType": "REDUCE",
                "worth": 1,
                "amount": 1,
                "rewardType": 1,
                "couponList": {
                  "id": "282485436487764512",
                  "code": "uUVtMWkmrKabh1b",
                  "platformName": "YUNDA",
                  "deliverChannel": "PROMOTION_ACTIVITY",
                  "couponName": "metersphere创建无规则券",
                  "couponStatus": "PROCESSING",
                  "activityId": "282485436487764536",
                  "remark": "metersphere创建无规则券",
                  "useStartTime": "2021-11-02 00:00:00",
                  "useEndTime": "2032-03-20 23:59:59",
                  "pickupStartTime": "2021-11-02 00:00:00",
                  "pickupEndTime": "2031-11-30 23:59:59",
                  "pickupAfterPeriod": 0,
                  "pickupAfterDays": "111",
                  "issueMaxAmount": 10000,
                  "pickupAmount": 0,
                  "usedAmount": 0,
                  "writeOffAmount": 0,
                  "miniOrderAmount": 10,
                  "maxDiscountAmount": 0,
                  "discountAmount": 1,
                  "discountRate": 0,
                  "businessSystemId": "expressBusiness",
                  "couponType": "REDUCE",
                  "couponDescription": "metersphere创建无规则券",
                  "useChannels": ""
                },
                "totalLimitNumber": 10,
                "todayLimitNumber": 1
              }
            ]
          },
          {
            "issuePolicy": "",
            "rewardLines": "6",
            "rewardDetailList": [
              {
                "id": "282485436487762518",
                "name": "metersphere创建无规则券",
                "couponType": "REDUCE",
                "worth": 1,
                "amount": 1,
                "rewardType": 1,
                "couponList": {
                  "id": "282485436487762518",
                  "code": "kyUtMWkmrKM9Zl8",
                  "platformName": "YUNDA",
                  "deliverChannel": "PROMOTION_ACTIVITY",
                  "couponName": "metersphere创建无规则券",
                  "couponStatus": "PROCESSING",
                  "activityId": "282485436487762516",
                  "remark": "metersphere创建无规则券",
                  "useStartTime": "2021-11-02 00:00:00",
                  "useEndTime": "2032-03-20 23:59:59",
                  "pickupStartTime": "2021-11-02 00:00:00",
                  "pickupEndTime": "2031-11-30 23:59:59",
                  "pickupAfterPeriod": 0,
                  "pickupAfterDays": "111",
                  "issueMaxAmount": 10000,
                  "pickupAmount": 0,
                  "usedAmount": 0,
                  "writeOffAmount": 0,
                  "miniOrderAmount": 10,
                  "maxDiscountAmount": 0,
                  "discountAmount": 1,
                  "discountRate": 0,
                  "businessSystemId": "expressBusiness",
                  "couponType": "REDUCE",
                  "couponDescription": "metersphere创建无规则券",
                  "useChannels": ""
                },
                "totalLimitNumber": 10,
                "todayLimitNumber": 5
              }
            ]
          },
          {
            "issuePolicy": "",
            "rewardLines": "9",
            "rewardDetailList": [
              {
                "id": "282484697753394427",
                "name": "metersphere创建无规则券",
                "couponType": "REDUCE",
                "worth": 1,
                "amount": 1,
                "rewardType": 1,
                "couponList": {
                  "id": "282484697753394427",
                  "code": "fHNT0WXmrKU2Trq",
                  "platformName": "YUNDA",
                  "deliverChannel": "PROMOTION_ACTIVITY",
                  "couponName": "metersphere创建无规则券",
                  "couponStatus": "PROCESSING",
                  "activityId": "282484697753394425",
                  "remark": "metersphere创建无规则券",
                  "useStartTime": "2021-11-02 00:00:00",
                  "useEndTime": "2032-03-20 23:59:59",
                  "pickupStartTime": "2021-11-02 00:00:00",
                  "pickupEndTime": "2031-11-30 23:59:59",
                  "pickupAfterPeriod": 0,
                  "pickupAfterDays": "111",
                  "issueMaxAmount": 10000,
                  "pickupAmount": 0,
                  "usedAmount": 0,
                  "writeOffAmount": 0,
                  "miniOrderAmount": 10,
                  "maxDiscountAmount": 0,
                  "discountAmount": 1,
                  "discountRate": 0,
                  "businessSystemId": "expressBusiness",
                  "couponType": "REDUCE",
                  "couponDescription": "metersphere创建无规则券",
                  "useChannels": ""
                },
                "totalLimitNumber": 15,
                "todayLimitNumber": 5
              }
            ]
          }
        ]
      },
      "inviteeConfigInfo": {
        "rewardSwitch": true,
        "onlyOne": true,
        "rewardInfo": {
          "issuePolicy": 1,
          "rewardDetailList": [
            {
              "id": "282485436487762512",
              "name": "metersphere创建无规则券",
              "couponType": "REDUCE",
              "worth": 1,
              "amount": 1,
              "rewardType": 1,
              "totalLimitNumber": 100,
              "todayLimitNumber": 1,
              "couponList": {
                "id": "282485436487762512",
                "code": "eyUtMWkmrKAgNwc",
                "platformName": "YUNDA",
                "deliverChannel": "PROMOTION_ACTIVITY",
                "couponName": "metersphere创建无规则券",
                "couponStatus": "PROCESSING",
                "activityId": "282485436487762511",
                "remark": "metersphere创建无规则券",
                "useStartTime": "2021-11-02 00:00:00",
                "useEndTime": "2032-03-20 23:59:59",
                "pickupStartTime": "2021-11-02 00:00:00",
                "pickupEndTime": "2031-11-30 23:59:59",
                "pickupAfterPeriod": 0,
                "pickupAfterDays": "111",
                "issueMaxAmount": 10000,
                "pickupAmount": 0,
                "usedAmount": 0,
                "writeOffAmount": 0,
                "miniOrderAmount": 10,
                "maxDiscountAmount": 0,
                "discountAmount": 1,
                "discountRate": 0,
                "businessSystemId": "expressBusiness",
                "couponType": "REDUCE",
                "couponDescription": "metersphere创建无规则券",
                "useChannels": ""
              }
            },
            {
              "id": "282484697753394427",
              "name": "metersphere创建无规则券",
              "couponType": "REDUCE",
              "worth": 1,
              "amount": 1,
              "rewardType": 1,
              "totalLimitNumber": 100,
              "todayLimitNumber": 1,
              "couponList": {
                "id": "282484697753394427",
                "code": "fHNT0WXmrKU2Trq",
                "platformName": "YUNDA",
                "deliverChannel": "PROMOTION_ACTIVITY",
                "couponName": "metersphere创建无规则券",
                "couponStatus": "PROCESSING",
                "activityId": "282484697753394425",
                "remark": "metersphere创建无规则券",
                "useStartTime": "2021-11-02 00:00:00",
                "useEndTime": "2032-03-20 23:59:59",
                "pickupStartTime": "2021-11-02 00:00:00",
                "pickupEndTime": "2031-11-30 23:59:59",
                "pickupAfterPeriod": 0,
                "pickupAfterDays": "111",
                "issueMaxAmount": 10000,
                "pickupAmount": 0,
                "usedAmount": 0,
                "writeOffAmount": 0,
                "miniOrderAmount": 10,
                "maxDiscountAmount": 0,
                "discountAmount": 1,
                "discountRate": 0,
                "businessSystemId": "expressBusiness",
                "couponType": "REDUCE",
                "couponDescription": "metersphere创建无规则券",
                "useChannels": ""
              }
            }
          ]
        }
      },
      "backgroundInfo": {
        "color": "#cad4ba",
        "imgUrl": "http://10.171.32.18:31005/promotioncenter/picture/202111/20211103103516779.png"
      },
      "shareConfigInfo": {
        "title": "分享",
        "description": "11",
        "imgUrl": "http://10.171.32.18:31005/promotioncenter/picture/202111/20211103103532474.png"
      }
    },
    "businessSystemId": "expressBusiness",
    "endTime": 1637251199000,
    "rules": [
      {
        "name": "邀请有礼参与规则模板",
        "ruleInstanceDesc": "邀请有礼参与规则模板",
        "ruleInstanceDetailList": [
          {
            "ruleDetailValue": "",
            "ruleDictCode": "invite_crowd"
          },
          {
            "ruleDetailValue": "1",
            "ruleDictCode": "invite_activity_type"
          },
          {
            "ruleDetailValue": "",
            "ruleDictCode": "invite_task_period"
          },
          {
            "ruleDetailValue": "",
            "ruleDictCode": "invite_task_max_count"
          },
          {
            "ruleDetailValue": "",
            "ruleDictCode": "user_assistance_max_count"
          }
        ],
        "ruleTemplateId": 7
      }
    ],
    "startTime": 1635868800000
  },
  "operator": "0001|张三测试",
  "operatorOrgId": "",
  "operatorOrgType": ""
}'

application/json

Body

code

string

必需

message

string | null

必需

data

integer

必需

success

boolean

必需

示例

{
    "code": "string",
    "message": "string",
    "data": 0,
    "success": true
}

创建邀请有礼活动

请求参数

示例代码

返回响应