提交中獎資訊

更新時間：2024-11-22 10:24:39

介面描述

1、提交中奖者填写的信息
2、只能成功保存一次观众中奖信息
3、中奖信息需在7天内提交保存，否则会失效
4、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/lottery/add-receive-info

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS以確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁保存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
lotteryId	true	String	抽獎場次ID，該參數取得自【查詢頻道中獎記錄】
winnerCode	true	String	中獎碼
viewerId	true	String	中獎者ID
receiveInfo	false	Array	自訂欄位資料，資料類型為JSON陣列 `[{"field":"姓名","value":"测试"},{"field":"手机","value":"13412345678"}]` field：欄位名稱 value：欄位值，如果傳遞此參數，則name和telephone欄位不需要傳遞（無效）

範例

http://api.polyv.net/live/v4/channel/lottery/add-receive-info

請求體參數：

{
    "channelId": "5030971",
    "lotteryId": "h1wkrnlnvo",
    "viewerId": "1731893115875",
    "winnerCode": "rWZt3tE0",
    "sessionId": "gzvceafnza",
    "receiveInfo": "[{\"value\":\"123\",\"type\":\"userName\",\"field\":\"姓名\",\"tips\":\"请输入您的名称\",\"required\":true},{\"value\":\"13192916616\",\"type\":\"userPhone\",\"field\":\"手机\",\"tips\":\"请输入您的手机号码\",\"required\":true}]"
}

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	String	成功返回"儲存成功"，失敗返回空

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);

/**
 * 提交中奖信息
 * @throws IOException
 */
@Test
public void testAddReceiveInfo() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "2191532";
    String url = "http://api.polyv.net/live/v4/channel/lottery/add-receive-info";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        
    String json = "{"channelId":"5030971","lotteryId":"h1wkrnlnvo","viewerId":"1731893115875","winnerCode":"rWZt3tE0","sessionId":"gzvceafnza","receiveInfo":"[{\"value\":\"123\",\"type\":\"userName\",\"field\":\"姓名\",\"tips\":\"请输入您的名称\",\"required\":true},{\"value\":\"13192916616\",\"type\":\"userPhone\",\"field\":\"手机\",\"tips\":\"请输入您的手机号码\",\"required\":true}]"}";
    String response = HttpUtil.postJsonBody(url, json,null);
    
    log.info("测试提交中奖信息接口返回值：{}",response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "保存成功"
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}