保利威文档中心

幫助中心

批量建立頻道推廣

更新時間:2025-05-20 15:00:10

介面說明

1、支持批量创建渠道推广
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/popularization/create-batch

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

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

請求體參數說明

參數名 必填 類型 說明
names true Array 頻道推廣名稱(同一頻道僅支援建立500個頻道推廣,包含歷史建立;陣列的元素為字串,每個頻道推廣名稱最多20個字元)
channelId true Integer 頻道號

範例

https://api.polyv.net/live/v4/channel/popularization/create-batch?appId=frlr1zazn3&sign=439CDA1327558DFCF947F305D03AFA92&timestamp=1621843779393

請求體參數

{
  "channelId": 10002,
  "names": ["渠道1", "渠道2"]
}

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Array 成功回應時為頻道基本資訊列表 【詳見data欄位說明】

data欄位說明

參數名 類型 說明
promoteId String 推廣ID
popularizationName String 頻道推廣名稱

Java請求範例

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

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

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

/**
 * 批量创建渠道推广
 * @throws IOException
 */
@Test
public void testBatchCreatePopularization() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String temp = "https://api.polyv.net/live/v4/channel/popularization/create-batch";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    String body = "{\"channelId\":10002,\"names\":[\"渠道1\",\"渠道2\"]}";
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String url = HttpUtil.appendUrl(temp,requestMap);
    String response = HttpUtil.postJsonBody(url, body, null);
    log.info("测试批量创建渠道推广接口返回值:{}",response);
    //do somethings
}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "ed721ebb-9add-4469-ad0f-e46db8aac206",
  "data": [
      {
        "promoteId": "Fq5gpU",
        "questionnaireId": "渠道1"
      },
      {
        "promoteId": "Fq5gp1",
        "popularizationName": "渠道2"
      }
  ],
  "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询
在线咨询