上传文档到某个频道

更新时间：2024-10-22 11:02:08

接口描述

1、上传频道文档接口
2、（channelId, type, docName, callbackUrl, timestamp, appId, url）参与sign签名，并和sign一起通过post表单传递，文件通过二进制流提交到服务器端。
3、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/document/upload-doc

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、上传的文件不超过200M，格式限制为（ppt， pdf，pptx，doc，docx，wps）。

3、file和url只需要传递其中一个，如果传递了url和file，以file字段为准

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
channelId	true	String	频道号
file	false	File	上传的文件不超过200M，格式限制为（ppt， pdf，pptx，doc，docx，wps），file和url只需要传递其中一个，如果传递了url和file，以file字段为准
type	false	String	转换类型，默认不传转普通，因为只有ppt，pptx可以转动画，其他类型文件会自动转成普通；文件转动画转失败会直接把类型转为普通 common：转普通图片 animate：转动画效果
docName	false	String	文档名称，默认不传使用ppt上传的文件获取到的文件名作为文档名称，文档名称不得超过100个字符
callbackUrl	false	String	文档上传转换成功回调地址
url	false	String	文件地址url（需要可访问的地址），file和url只需要传递其中一个，如果传递了url和file，以file字段为准，上传的文件不超过200M

示例

http://api.polyv.net/live/v3/channel/document/upload-doc

表单参数：

docName=test&appId=frlr1zazn3&sign=FC2296E942D2DB118C64C11AD941445D&callbackUrl=http%3A%2F%2Fwww.baidu.com&type=common&channelId=1965681&timestamp=1621842842327

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	请求成功时为上传文档的有关信息【详见Data参数描述】，请求失败时为空

Data参数描述

参数名	类型	说明
type	String	转换类型，默认不传转普通，因为只有ppt，pptx可以转动画，其他类型文件会自动转成普通；文件转动画转失败会直接把类型转为普通 common：转普通图片 animate：转动画效果
fileId	String	文件ID，成功时返回
status	String	文档状态 normal：正常 waitUpload：等待上传 failUpload：上传失败 waitConvert：转换PPT中 failConvert：转换PPT失败

回调说明

ppt转换图片、动画等结果实时信息回调，可以及时通知用户上传、转换任务的结果。

原理

通过HTTP接口（设置的callbackUrl）向用户服务器发送GET请求，将合并结果推送给用户服务器。

举例说明

举例如下：http://abc.com/test.do?status=normal&timestamp=1603506240000&channelId=xxxx&fileId=xxx&sign=xxdxxxxx

参数名	类型	说明
status	String	文件转换状态（“normal” ：正常，"failConvert":转换PPT失败）
fileId	String	文件ID，成功时返回
channelId	String	频道号
timestamp	Long	13位毫秒级时间戳
sign	String	校验的加密字符串，生成的规则md5(channelId+timestamp)

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 testUploadDoc() 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/upload-doc";
    String channelId = "1965681";
    String type = "common";
    String docName = "test";
    String callbackUrl = "http://www.baidu.com";
    String path = getClass().getResource("/file/").getPath() + "report.pdf";
    File file = new File("D:/test.pdf");

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    Map<String,File> fileMap = new HashMap<>();
    fileMap.put("file",file);
    requestMap.put("type",type);
    requestMap.put("docName",docName);
    requestMap.put("callbackUrl",callbackUrl);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFile(url, requestMap,fileMap,"utf-8");
    log.info("测试上传文档到某个频道：{}",response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "type":"common",
        "fileId":"39e6bd3fe674c952815ad1a09c66e1061965681common",
        "status":"waitConvert"
    }
}

异常示例

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

直播服务端 API