查詢頻道文件轉碼狀態

更新時間：2022-09-02 18:08:07

介面說明

1、查询频道文档转换状态接口
2、支持https协议

介面URL

http://api.polyv.net/live/v3/channel/document/status/get

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
fileId	true	String	檔案ID，(如果有多個，可以用英文逗號隔開拼接成字串)，該值來源參考【查詢頻道已上傳文件列表】介面回傳資料的data.contents[0].fileId

範例

http://api.polyv.net/live/v3/channel/document/status/get?appId=frlr1zazn3&sign=EB9CF9CD3F473E0C6462E3031E97E7FA&channelId=1965681&timestamp=1621843039780&fileId=c2d585857870f4eff024976e3a265c0b1965681common%2C6e0603f6c8ec6113b87f69a7191d22021965681common

回應參數說明

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

Data參數說明

參數名	類型	說明
imageCount	Integer	大圖圖片數量，回應參數convertStatus="normal" 時回傳
images	String[]	大圖位址陣列，回應參數convertStatus="normal" 時回傳，如：["imgurl1"，"imgurl2"]
smallImages	String[]	小圖位址陣列，回應參數convertStatus="normal" 時回傳，如：["imgurl1"，"imgurl2"]
totalPage	Integer	總頁數，回應參數convertStatus="normal" 時回傳
htmlUrl	String	動畫PPT位址，回應參數convertStatus="normal" 時回傳
convertStatus	String	文件狀態，不傳預設查詢所有 normal：正常 waitUpload：等待上傳 failUpload：上傳失敗 waitConvert：轉換PPT中 failConvert：轉換PPT失敗
type	String	轉換類型，預設不傳轉普通，因為只有ppt，pptx可以轉動畫，其他類型檔案會自動轉成普通；檔案轉動畫轉失敗會直接把類型轉為普通 common：轉普通圖片 animate：轉動畫效果
fileId	String	檔案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 testGetDocConvertStatus() 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/v3/channel/document/status/get";
    String channelId = "1965681";
    String fileId = "c2d585857870f4eff024976e3a265c0b1965681common,6e0603f6c8ec6113b87f69a7191d22021965681common";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("fileId",fileId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道文档转码状态：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "imageCount":1,
            "smallImages":[
                "http://doc-2.polyv.net/images/2020/10/c2d585857870f4eff024976e3a265c0b1965681common/c2d585857870f4eff024976e3a265c0b1965681common_0000_s.jpeg"
            ],
            "images":[
                "http://doc-2.polyv.net/images/2020/10/c2d585857870f4eff024976e3a265c0b1965681common/c2d585857870f4eff024976e3a265c0b1965681common_0000.jpeg"
            ],
            "totalPage":1,
            "htmlUrl":null,
            "convertStatus":"normal",
            "type":"common",
            "fileId":"c2d585857870f4eff024976e3a265c0b1965681common"
        },
        {
            "imageCount":1,
            "smallImages":[
                "http://doc-2.polyv.net/images/2020/10/6e0603f6c8ec6113b87f69a7191d22021965681common/6e0603f6c8ec6113b87f69a7191d22021965681common_0000_s.jpeg"
            ],
            "images":[
                "http://doc-2.polyv.net/images/2020/10/6e0603f6c8ec6113b87f69a7191d22021965681common/6e0603f6c8ec6113b87f69a7191d22021965681common_0000.jpeg"
            ],
            "totalPage":1,
            "htmlUrl":null,
            "convertStatus":"normal",
            "type":"common",
            "fileId":"6e0603f6c8ec6113b87f69a7191d22021965681common"
        }
    ]
}

異常範例

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