上传文档到某个频道
接口描述
接口URL
请求方式
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、上传的文件不超过200M,格式限制为(ppt, pdf,pptx,doc,docx,wps)。
3、file和url只需要传递其中一个,如果传递了url和file,以file字段为准
请求参数描述
appId
true
String
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
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
示例
表单参数:
响应参数描述
code
Integer
status
String
响应状态文本信息
message
String
响应描述信息,当code为400或者500的时候,辅助描述错误原因
data
Object
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×tamp=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请求线程池进行了统一封装和优化。
响应示例
系统全局错误说明详见全局错误说明
成功示例
异常示例
Last updated
Was this helpful?