创建邀请有礼活动

请求参数

Body 参数application/json

appKey

string

appKey

必需

operatorOrgId

string

操作人id

必需

operatorOrgType

string

操作人类型

必需

operator

string

操作人

必需

activity

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": "appKey",
    "operatorOrgId": "123456",
    "operatorOrgType": "",
    "operator": "tyl",
    "activity": {
        "businessSystemId": "expressBusiness",
        "activityName": "邀请有礼活动",
        "activityType": "INVITE_REWARD",
        "activityDescription": "邀请有礼活动",
        "startTime": "2021-03-30 08:00:00",
        "endTime": "2021-05-19 12:00:00",
        "additionalJson": {
            "inviterConfigInfo": {
                "rewardModel": 1,
                "rewardMaxCount": 10,
                "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"
            },
            "invitePageInfo": {
                "posterUrl": "http://",
                "displayRanking": true
            }
        },
        "rewardEventType": 0,
        "rules": [
            {
                "ruleTemplateId": 4,
                "name": "参与活动规则模板",
                "ruleInstanceDesc": "参与活动规则模板",
                "ruleDetails": [
                    {
                        "ruleDictCode": "person_take_activity_total",
                        "descrption": "参与活动次数",
                        "ruleDetailValue": "500"
                    },
                    {
                        "ruleDictCode": "allow_users",
                        "descrption": "允许的用户类型",
                        "ruleDetailValue": "vip7"
                    },
                    {
                        "ruleDictCode": "allow_app",
                        "descrption": "允许的业务端",
                        "ruleDetailValue": "alipay"
                    }
                ]
            }
        ]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/ypc/vientiane/activity/createThemeActivity' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appKey": "appKey",
    "operatorOrgId": "123456",
    "operatorOrgType": "",
    "operator": "tyl",
    "activity": {
        "businessSystemId": "expressBusiness",
        "activityName": "邀请有礼活动",
        "activityType": "INVITE_REWARD",
        "activityDescription": "邀请有礼活动",
        "startTime": "2021-03-30 08:00:00",
        "endTime": "2021-05-19 12:00:00",
        "additionalJson": {
            "inviterConfigInfo": {
                "rewardModel": 1,
                "rewardMaxCount": 10,
                "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"
            },
            "invitePageInfo": {
                "posterUrl": "http://",
                "displayRanking": true
            }
        },
        "rewardEventType": 0,
        "rules": [
            {
                "ruleTemplateId": 4,
                "name": "参与活动规则模板",
                "ruleInstanceDesc": "参与活动规则模板",
                "ruleDetails": [
                    {
                        "ruleDictCode": "person_take_activity_total",
                        "descrption": "参与活动次数",
                        "ruleDetailValue": "500"
                    },
                    {
                        "ruleDictCode": "allow_users",
                        "descrption": "允许的用户类型",
                        "ruleDetailValue": "vip7"
                    },
                    {
                        "ruleDictCode": "allow_app",
                        "descrption": "允许的业务端",
                        "ruleDetailValue": "alipay"
                    }
                ]
            }
        ]
    }
}'

application/json

Body

result

boolean

必需

code

string

必需

message

string

必需

data

null

必需

示例

{
    "result": true,
    "code": "string",
    "message": "string",
    "data": null
}

创建邀请有礼活动

请求参数

示例代码

返回响应