新增分組

更新時間：2024-09-05 17:26:45

介面描述

1、新建分组
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/lottery-viewer-group/whitelist/create

請求方式

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	頻道號

請求體參數描述

參數名	必選	類型	說明
title	true	String	分組名稱

範例

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

請求體 json 參數：

{
    "title": "分组1"
}

回應描述

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

Error 回應描述

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

data 回應描述

參數名	類型	說明
id	Long	分組 ID
title	String	分組名稱

Java 請求範例

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

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

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新建分组
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void groupAdd() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
        
    String url = "http://api.polyv.net/live/v4/channel/lottery-viewer-group/whitelist/create";
    //业务参数
    Integer channelId = 5004544;
    String title = "分组1";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
        
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("title", title);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试新建分组结果：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "df1d4247-3cd6-4cf5-990d-b19fd4cd58e9",
    "data": {
        "id": 678,
        "title": "分组1"
    },
    "success": true
}

異常範例

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