能力接入

添加转码任务

添加一个Office转PDF的转码任务

接口地址

https://open.aimiaoyin.com/api/v1/convert/add

请求方法

POST

请求参数

参数名 类型 必需 说明
app_id string Y 开放平台申请的appId
sign string Y app签名 (查看接口鉴权)
nonce_str string Y 随机字符串 (查看接口鉴权)
time_stamp string Y 10位时间戳 (查看接口鉴权)
file_url string Y 文件url
convert_type int Y 转码类型 (查看转码类型定义)
callback_url string N 回调url (查看接收回调方法)
file_name string N 文件名

响应参数

参数名 类型 说明
convert_id string 转码任务id

请求示例

app_id=XXXXXXXX&sign=XXXXXXXX&file_url=XXXXXXXX&convert_type=1

响应示例

{
    "code": 200,
    "message": "添加转码任务",
    "data": {
        "develop_app_id": 1,
        "convert_type": "1",
        "update_time": "1571129132",
        "create_time": "1571129132",
        "app_convert_task_id": 4,
        "convert_id": "c7e9ad7f9adeb76c6b71f2b0cd9f0acb"
    }
}

获取转码任务详情

获取转码任务的信息、转码的状态、转码的结果等。

接口地址

https://open.aimiaoyin.com/api/v1/convert/detail

请求方法

GET

请求参数

参数名 类型 必需 说明
app_id string Y 开放平台申请的appId
sign string Y app签名 (查看接口鉴权)
nonce_str string Y 随机字符串 (查看接口鉴权)
time_stamp string Y 10位时间戳 (查看接口鉴权)
convert_id string Y 转码任务id

响应参数

参数名 类型 说明
convert_id string 转码任务id
convert_type int 转码类型 (查看转码类型定义)
status string 转码状态 (查看转码状态值定义)
complete_file_oss_url string 转码后文件的url, 10分钟有效
complete_file_page string 转码后文件页数
create_time string 创建时间
start_time string 开始时间
end_time string 结束时间
file_name string 文件名

请求示例

app_id=XXXXXXXX&sign=XXXXXXXX&convert_id=XXXXXXXX

响应示例

{
    "code": 200,
    "message": "转码任务详情",
    "data": {
        "convert_id": "03a792c8fda08750e34c3b8427353c94",
        "convert_type": 1,
        "status": 2,
        "complete_file_oss_url": "https://oss.aimiaoyin.com/userConvert/test.docx.pdf",
        "complete_file_page": "10",
        "start_time": 1571128122,
        "end_time": 1571128124,
        "create_time": "1571128121",
        "update_time": "1571128121",
        "file_name": "03a792c8fda08750e34c3b8427353c94"
    }
}

获取完成完成事件回调

文件转码完成后,喵印开放平台服务器将会给开发者添加转码任务时填入的callback_url发送POST请求。

注意事项

  • 喵印开放平台服务器在发送回调请求时,10秒内收不到响应则会断开请求,若失败3次则结束回调。

回调请求方法

POST

回调示例

{
    "convert_id": "XXXXXXXX",
    "convert_type": "1",
    "status": "2",
    "complete_file_oss_url": "XXXXXXXX",
    "complete_file_page": "10",
    "end_time": "1567590473"
}
  • 转码失败时的回调
{
    "convert_id": "XXXXXXXX",
    "status": "3",
    "end_time": "1567590473"
}

回调参数

参数名 类型 说明
convert_id string 转码任务id
convert_type int 转码类型 (查看转码类型定义)
status string 转码状态 (查看转码状态值定义)
complete_file_oss_url string 转码后文件的url, 10分钟有效
complete_file_page string 转码后文件页数
end_time string 结束时间

results matching ""

    No results matching ""