文档转码相关接口

编辑文档更新于 2024-11-11 06:14:32

描述

通过本接口创建文件转码任务

接口请求地址

请求方式：POST/JSON
传输协议：HTTPS
调用频次限制：50 次/秒
请求 URL：

https://api-brtm.baijiayun.com/doc/transcode/start

API鉴权

参见 Restful API 基本认证

请求参数

参数	类型	是否必选	描述
app_id	string	是	BRTC 给开发者分配的 appId，唯一标识一个应用
file_hash	string	否	源文件 MD5 值，要求为 32 位的 MD5 哈希值（全小写）
skip_hash_check	bool	否	是否跳过文件的 hash 验证，默认 false，如果 skip_hash_check 为 true，可以不传 file_hash 参数
file_name	string	是	源文件名称
file_size	int	是	源文件大小，单位为字节
source_file_url	string	是	经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式，比如文档地址为: `http://example.com/测试.pdf` 经过URL编码之后为 `http://example.com/%E6%B5%8B%E8%AF%95.pdf`
is_animation	bool	是否转成动态PPT，默认为 false ; 文档转码最终都会转成静态图片，但如果把 is_animation 设置为 true, 则文档会多转一份 PPT 动态效果的 HTML5 页面（仅支持`.ppt`/`.pptx`文件）

请求示例

请求包体内容：

{
  "app_id":"BZ2no1v919Die6mLc2nNOGvfqcQNSfKO",
  "file_hash":"3c715ad85f7926d930fc17a6b3a8932c",
  "file_name": "demo.pptx",
  "file_size": 1024,
  "source_file_url": "http://example.com/%E6%B5%8B%E8%AF%95.pdf",
  "is_animation": true
}

响应参数

参数	类型	描述
code	int	错误码
msg	string	描述
task_id	int	转码服务分配的任务 id ，任务 id 是对一次转码生命周期过程的唯一标识，结束转码时会失去意义

响应示例

响应包体内容：

{
    "code": 200,
    "data": {
        "task_id": 172
    },
    "msg": "ok"
}