上傳偽直播互動腳本詞條文字

更新時間：2025-05-13 09:20:33

介面描述

1、上传伪直播互动脚本精准发言文件
2、伪直播脚本不存时，会自动创建
3、文件内容解析添加到该互动脚本下
4、接口支持https协议

範本檔案下載

精準發言範本.xlsx

介面URL

http://api.polyv.net/live/v4/channel/interaction-script/upload-disk-video-custom-script

請求方式

POST

介面限制

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

2、上傳的檔案不超過200M，格式限制為xlsx。

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
diskVideoId	true	String	偽直播影片id
labelId	false	Long	平台內容庫-成員庫-成員組ID，透過【平台內容庫分組列表】取得
file	true	File	上傳的範本檔案不超過10M

範例

http://api.polyv.net/live/v4/channel/interaction-script/upload-disk-video-custom-script

請求參數：

channelId=1965681&timestamp=1621842842327&diskVideoId=test&appId=frlr1zazn3&sign=FC2296E942D2DB118C64C11AD941445D

表單參數：

file=file

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	請求成功時為上傳文件的相關資訊【詳見Data參數說明】，請求失敗時為空

Data參數說明

參數名	類型	說明
id	Integer	腳本id

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelDocTest.class);
/**
 * 上传互动脚本精准发言
 * @throws IOException
 */
@Test
public void testUpload() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/interaction-script/upload-disk-video-custom-script";
    String channelId = "1965681";
    String diskVideoId = "diskVideoId";
    File file = new File("D:/%E7%B2%BE%E5%87%86%E5%8F%91%E8%A8%80%E6%A8%A1%E6%9D%BF.xlsx");
    
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("diskVideoId",diskVideoId);
    Map<String,File> fileMap = new HashMap<>();
    fileMap.put("file",file);
    String sign = LiveSignUtil.getSign(requestMap, appSecret);
    url += "?appId="+appId+"&timestamp="+timestamp+"&channelId="+channelId+"&sign="+sign+"&diskVideoId="+diskVideoId;
    String response = HttpUtil.postFile(url, null, fileMap,"utf-8");
    log.info("测试上传文档到某个频道：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "id":"scriptId"
    }
}

異常範例

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