获取文档下载地址
更新时间:2022-12-28
接口描述
获取文档下载地址
请求地址
https://ccapi.csslcloud.net/api/v1/doc/download
请求方式
GET
请求参数
接口统一权限认证请参考THQS认证方式。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| account_id | String | 是 | 开发者账号ID |
| room_id | String | 是 | 直播间ID |
| doc_id | String | 是 | 文档ID |
请求示例
GET https://ccapi.csslcloud.net/api/v1/doc/download?account_id=41E8063FC799ACE&room_id=D90DCF5BF6DA3C8C9C33DC5901307461&doc_id=0A0833E541533352&time=1670412086&hash={hash}
返回数据
公共返回数据结构请参考 公共返回数据说明。
| 名称 | 类型 | 描述 |
|---|---|---|
| result | String | 返回状态:OK为成功,FAIL为失败 |
| picDomain | String | 文档域名 |
| down_url | String | 文档下载地址 |
| doc | Object | 文档信息 |
doc说明
| 名称 | 类型 | 描述 |
|---|---|---|
| id | String | 文件ID |
| name | String | 文件名称 |
| pageSize | Integer | 文件页数 |
| roomId | String | 直播间ID |
| size | Integer | 文件大小 |
| useSDK | Integer | ppt动效:0为未开启,1为开启 |
| useSdk | Boolean | ppt动效 |
| create_time | String | 上传时间,格式:yyyy-MM-dd HH:mm:ss,示例:"2022-12-11 00:00:00" |
| status | Integer | 文件状态:-2为未上传,-1为上传失败,0为上传成功,1为转换成功,2为转换中,3为转换失败 |
| related | Integer | 是否关联:1为已关联,0为未关联,如果room_id参数没传,则不返回该字段 |
| uploadFileType | Integer | 上传文件类型 |
| userId | String | 开发者账号ID |
| md5 | String | 文件md5 |
| fileName | String | 文件名称 |
| pageTitles | Array String | 文件标题列表 |
| mode | Integer | 模式 |
返回示例
{
"doc": {
"uploadFileType": 2,
"userId": "123",
"id": "123",
"md5": "E753B5CBAA0CC2AB62A232767B8667EB",
"roomId": "123",
"fileName": "第一讲 二次函数的面积.ppt",
"useSDK": 0,
"useSdk": false,
"pageTitles": [
"第一讲 二次函数下的面积问题"
],
"pageSize": 12,
"mode": 0,
"size": 857600,
"name": "第一讲 二次函数的面积.ppt"
},
"down_url": "http://doc-origin.csslcloud.net/document/88C79C053AFF11E39C33DC5901307461/CA982990E70632FB.ppt",
"picDomain": "http://image.csslcloud.net",
"result": "OK"
}

