保利威文档中心

幫助中心

更新抽獎活動

更新時間：2025-05-07 09:00:51

介面描述

1、更新抽奖活动
2、接口支持https协议

介面URL

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

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看 2、若參數不正確則會回應400異常

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰】
timestamp true Long 當前13位毫秒級時間戳，3分鐘內有效
sign true String 簽名，為32位大寫的MD5值，產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】
channelId true Integer 頻道號

請求體參數描述

參數名 必選 類型 說明
id true Long 抽獎活動ID
activityName true String 抽獎活動名稱
lotteryCondition true String 抽獎活動類型，none:無條件，invite:邀請好友，duration:觀看時長，comment:留言抽獎，question:答題抽獎
amount true Integer 中獎人數
hiddenWinnerAmount false String 是否隱藏中獎人數，值:Y/N，預設N
lotteryRange false String 參與抽獎用戶類型：all:全部，customGroup:自訂分組
customGroupIds false Array 自訂分組ID，抽獎用戶類型為自訂時有效
customGroupLotteryType false String 分組抽取方式，average:等額抽獎，random:隨機抽獎
customGroupLotteryAmount false Integer 每組抽取數量
hiddenAttendeeNumber false String 是否隱藏參與人數，值:Y/N，預設N
repeatWinEnabled false String 允許重複中獎，值:Y/N，預設N
receiveEnabled false String 是否填寫收貨資訊，值:Y/N，預設N
receiveInfo false Array 收貨欄位資訊列表，無條件抽獎時填寫【詳見ReceiveInfo】
prizeName true String 獎品名稱
thumbnail false String 獎品圖片
activityDuration false String 活動時長，非無條件抽獎時必填
activityDurationType false String 活動時長單位(second,minute,hour)，預設minute
inviteType false String 邀請方式，poster:邀請海報，external:外部邀請，邀請抽獎時必填
externalListLink false String 外部名單連結，邀請抽獎且邀請方式為外部邀請時必填
externalInviteNumLink false String 取得邀請人數連結，邀請抽獎且邀請方式為外部邀請時必填
inviteNum false Integer 邀請人數，邀請抽獎時必填
duration false Integer 觀看時長，觀看時長抽獎時必填
comment false String 留言內容，留言抽獎時必填
acceptType false String 領獎方式，form:表單，link:外鏈，qrCode:掃描QR Code，非無條件和答題抽獎必填
formInfo false Array 領獎方式表單欄位資訊，領獎方式為表單填寫【詳見ReceiveInfo】
prizeUrl false String 領獎方式獎品連結，領獎方式為外鏈必填
qrCode false String 領獎方式QR Code連結，領獎方式為QR Code必填
qrCodeTips false String 領獎方式QR Code提示語，領獎方式為QR Code填寫
realPrice false BigDecimal 優惠價格
price false BigDecimal 獎品原價
prizeInfo false Array 獎品資訊，答題抽獎時必填【詳見PrizeInfo】
questionGroupId false Long 問答組模板ID，答題抽獎必填
perAnswerDuration false Integer 每道題的答題時長，答題抽獎必填
lotteryOnlineEnabled false String 開獎時觀眾需在線，值:Y/N，預設Y(無條件分組抽獎時設定生效)
answerType false String 答題抽獎，答題方式，pushQuestion:邊推邊答，autonomyAnswer:自主答題，預設：pushQuestion

ReceiveInfo參數描述

參數名 必選 類型 說明
type false String 類型，userName:姓名、userPhone:手機號碼、custom:自訂
field true String 欄位名稱
tips true String 提示語
required false Boolean 是否必填，true/false

PrizeInfo參數描述

參數名 必選 類型 說明
prizeItem true String 獎項名稱
correctAnswerCount true Integer 答對題目數
prizeName true String 獎品名稱
thumbnail false String 獎品圖片
realPrice false BigDecimal 優惠價格
price false BigDecimal 獎品原價
acceptType true String 領獎方式，form:表單，link:外鏈，qrCode:掃描QR Code
formInfo false Array 領獎方式表單欄位資訊，領獎方式為表單填寫【詳見ReceiveInfo】
prizeUrl false String 領獎方式獎品連結，領獎方式為外鏈必填
qrCode false String 領獎方式QR Code連結，領獎方式為QR Code必填
qrCodeTips false String 領獎方式QR Code提示語，領獎方式為QR Code填寫
amount true Integer 中獎人數
hiddenWinnerAmount false String 是否隱藏中獎人數，值:Y/N，預設N

範例

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

請求體json參數：

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

回應描述

參數名 類型 說明
code Integer 狀態碼，與 http 狀態碼相同，用於確定基本的回應狀態
status String 回應結果，由業務決定，成功回傳success，失敗回傳error
success Boolean 是否成功回應
requestId String 請求ID，每次請求產生的唯一 UUID，僅可用於排查、除錯，不應該和業務掛鉤
error Object 狀態碼非200時的錯誤資訊【詳見Error欄位描述】
data Object 回應資訊

Error回應描述

參數名 類型 說明
code Integer 錯誤代碼，用於確定具體的錯誤原因
desc String 錯誤描述，與 error.code 對應

Java請求範例

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

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

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "723ed01861804e9aa3dc1cf1aced83d5.72.17097790901718347",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服，在线咨询