頻道下獲取PPT文件上傳TOKEN介面
更新時間:2022-05-24 09:38:10
介面URL
http://api.polyv.net/live/v3/channel/document/token/get
介面說明
1、提供上傳ppt文件token的介面
2、支援https
支援格式
JSON
請求方式
GET
請求數限制
TRUE
請求參數
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | 是 | string | 從API設定中取得,在直播系統登記的appId |
| timestamp | 是 | string | 目前時間的秒級時間戳(13位) |
| sign | 是 | string | 簽名,為32位大寫的MD5值 |
| channelId | 是 | int | 頻道號 |
| fileId | 是 | string | 檔案ID,(格式為:產生檔案的MD5值value1, 取得頻道號value2, type串的值value3(普通PPT為‘common’,動畫PPT為‘animate’),fileId=value1 + value2 + value3)其中value1的值(即檔案的MD5值)也可透過檔案名+檔案的修改時間進行MD5的值作為value1的值,產生檔案ID時必須嚴格按照格式產生,涉及同個頻道同個檔案下的唯一性和秒傳功能 |
| fileName | 是 | string | 檔案名(帶檔案副檔名,限制檔案副檔名 .ppt, .pptx, .pdf,.doc, .docx, .wps) |
| type | 是 | string | 檔案轉換類型,“common” 普通ppt , “animate”動畫PPT |
操作成功回應範例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"encodedCallback": "xxxxxxxxxxxxxxxxxxxx",
"convertStatus": "waitUpload",
"host": "xxx.xxx.xxx",
"callback": "xxxxxxxxxxxxxxxxxxxx",
"policy": "xxxxx",
"dir": "xxxxxx",
"endpoint": "xxxxxxx",
"bucket": "bucket",
"expire": "xdadada",
"accessId": "xxxx",
"policy": "policy",
"signature": "signature"
}
}
操作失敗回應範例
簽名錯誤
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
缺少參數 channelId
{
"code": 400,
"status": "error"
"message": "param should not be empty: channelId",
"data": ""
}
檔案ID非法
{
"code": 400,
"status": "error"
"message": "illegal document fileId",
"data": ""
}
回應欄位說明
| 名稱 | 類型 | 說明 |
|---|---|---|
| code | string | 回應代碼,成功為200,失敗為400,簽名錯誤為403,異常錯誤500 |
| status | string | 成功為success,失敗為error |
| message | string | 錯誤時為錯誤提示訊息 |
| data | string | 成功回應物件 |
| data.convertStatus | string | PPT狀態,“normal” 正常,不需要重複上傳檔案,已經有上傳成功的相同PPT,可以直接進入輪詢。“waitConvert” 轉換PPT中,已經有相同的檔案正在轉換中,直接進入輪詢。“waitUpload” 等待上傳狀態,進入上傳阿里雲步驟 |
| data.autoId | int | 檔案自增ID |
| data.fileId | string | 檔案ID |
| data.accessId | string | oss上傳OSSAccessKeyId |
| data.policy | string | oss上傳policy |
| data.signature | string | oss上傳signature |
| data.dir | string | 上傳到oss的資料夾 |
| data.endpoint | string | oss上傳的endpoint |
| data.bucket | string | oss上傳的桶 |
| data.host | string | oss上傳的host |
| data.expire | string | 加密串過期時間 |
| data.callback | string | oss上傳的回調參數(必須帶上這個參數,用於回調後端告知上傳狀態) |
| data.encodedCallback | string | oss上傳回調參數使用encode編碼(上傳OSS時必須帶上這個參數,用於回調後端告知上傳狀態) |
| data.object | string | 文件的存放目錄key |
