建立抽獎活動

介面描述

1、创建抽奖活动
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/lottery-activity/create

請求方式

POST

介面約束

1、介面同時支援HTTP 、HTTPS ，建議使用HTTPS 確保介面安全，介面呼叫有頻率限制，詳細請查看 2、若參數不正確則會回應400異常 3、抽獎使用者類型為自訂分組、分組抽取方式為specified時，customGroupLotterySpecified不能為空，且需與customGroupIds中的分組完全一致（每個分組都要指定抽取數量，不能多也不能少），否則回傳錯誤碼40218

請求參數描述

請求體參數描述

CustomGroupLotterySpecified參數描述

ReceiveInfo參數描述

PrizeInfo參數描述

範例

http://api.polyv.net/live//v4/channel/lottery-activity/create?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=2974342

請求體json參數：

{
    "activityName": "无条件抽奖",
    "lotteryCondition": "none",
    "amount": 1,
    "receiveEnabled": "Y",
    "prizeName": "键盘",
    "receiveInfo": [{
        "field": "姓名",
        "tips": "请输入您的名称",
        "type": "userName",
        "required": true
    }, {
        "field": "手机",
        "tips": "请输入您的手机号码",
        "type": "userPhone",
        "required": true
    }],
    "lotteryRange": "all"
}

自訂分組並每組指定不同抽取人數的請求體範例（lotteryRange為customGroup，customGroupLotteryType為specified）：

{
    "activityName": "分组指定人数抽奖",
    "lotteryCondition": "none",
    "amount": 30,
    "receiveEnabled": "N",
    "prizeName": "键盘",
    "lotteryRange": "customGroup",
    "customGroupIds": [10001, 10002],
    "customGroupLotteryType": "specified",
    "customGroupLotterySpecified": [
        {"customGroupId": 10001, "amount": 10},
        {"customGroupId": 10002, "amount": 20}
    ]
}

回應描述

Error回應描述

data回應描述

CustomGroup回應描述

ReceiveInfo回應描述

PrizeInfo回應描述

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼， 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽章、HTTP請求執行緒池進行了統一封裝和優化。

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "723ed01861804e9aa3dc1cf1aced83d5.72.17097790901718347",
    "data": {
        "id": 20521,
        "activityName": "无条件抽奖",
        "lotteryCondition": "none",
        "amount": 1,
        "receiveEnabled": "Y",
        "receiveInfo": [
            {
                "type": "userName",
                "field": "姓名",
                "tips": "请输入您的名称",
                "required": true
            },
            {
                "type": "userPhone",
                "field": "手机",
                "tips": "请输入您的手机号码",
                "required": true
            }
        ],
        "prizeName": "键盘",
        "activityDuration": null,
        "inviteType": "poster",
        "inviteNum": null,
        "duration": null,
        "comment": null,
        "externalListLink": null,
        "externalInviteNumLink": null,
        "acceptType": null,
        "formInfo": null,
        "prizeUrl": null,
        "qrCode": null,
        "qrCodeTips": null,
        "thumbnail": null,
        "realPrice": null,
        "price": null,
        "status": null,
        "prizeInfo": null,
        "questionGroupId": null,
        "perAnswerDuration": null,
        "lotteryRange": "all",
        "repeatWinEnabled": "N",
        "customGroup": [],
        "hiddenWinnerAmount": "N",
        "hiddenAttendeeNumber": "N",
        "customGroupLotteryType": "random",
        "customGroupLotteryAmount": null
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}