查询频道文档转码状态

接口描述

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": ""
}