LiveAPI
公共信息
版本：v.1.0.0
最后修改日期：2019-09-26
API系统加密方式：THQS加密
如果请求失败，将返回错误信息，其中错误码可以快速定位问题，建议提供错误码排查问题。
其中常见的错误码如下：
| 错误码 | 描述 | 备注 |
|---|---|---|
| 1001 | 参数错误 | 检查传入参数是否正确 |
| 1002 | 加密错误 | THQS加密错误 |
| 10000 | 直播间状态错误 | 确认直播间状态是否正常 |
| 其他值 | 系统错误 | 联系客服解决 |
通过LiveApi上传文档时序图如下：
上传步骤：
- 创建上传信息；
- 组建上传地址；
- 上传文件；
1. 创建上传信息
通过LiveAPI系统的http://api.csslcloud.net/api/document/create接口创建上传信息，返回结果result：
{
"success": true,
"datas": {
"uploadUrl": "http://doc-bj.csslcloud.net/api/document/upload",
"docId": "753C612EB38A8D5A"
},
"errorCode": 0
}
2. 组建上传地址
通过步骤1返回的信息组建完整的上传地址，格式为：
{result.datas.uploadUrl}?userid={客户ID}&docid={result.datas.docId}&supportanimation={supportanimation}
例：通过步骤1的返回内容组建完整的上传地址为：
http://doc-bj.csslcloud.net/api/document/upload?userid=63835A29B2A11961&docid=753C612EB38A8D5A&supportanimation=0
参数说明：
| 参数名称 | 类型 | 备注 |
|---|---|---|
| userid | string | 必须，客户的唯一ID，可以通过https://admin.bokecc.com右上角账号ID处获取 |
| docid | string | 必须，创建上传信息返回 |
| supportanimation | integer | 非必须，是否保留动画，只针对ppt、pptx文件有效，0：不保留动画（默认）；1：保留动画；2：保留动画（极速）； |
3. 上传文件
通过上一部组建的上传地址，使用RFC 1867协议进行文件上传。
实例的Http信息：
Request URL:
http://doc-bj.csslcloud.net/api/document/upload?userid=63835A29B2A11961&docid=753C612EB38A8D5A&supportanimation=0
Request Headers:
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryZfxPQ4ins67a7ppa
Query String Parameters:
supportanimation=0&userid=63835A29B2A11961&docid=753C612EB38A8D5A
Form Data:
------WebKitFormBoundaryZfxPQ4ins67a7ppa
Content-Disposition: form-data; name="file"; filename="我要上传的文档.pptx"
Content-Type: application/vnd.openxmlformats-officedocument.presentationml.presentation
------WebKitFormBoundaryZfxPQ4ins67a7ppa
文档功能
创建文档上传信息
基本信息
Path： http://api.csslcloud.net/api/document/create
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| userid | 是 | 用户ID，例：753C612EB38A8D5A | |
| roomid | 是 | 直播间ID，例：63835A29B2A11961 | |
| title | 是 | 文档标题，注：长度不能超过100个字符 | |
| filesize | 是 | 文档大小，单位Byte，注：最大不能超过104857600（100MB） |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| datas | object | 非必须 | |||
| ├─ uploadUrl | string | 非必须 | |||
| ├─ docId | string | 非必须 | |||
| errorCode | number | 非必须 | |||
| success | boolean | 非必须 |
上传文档
基本信息
Path： 组建完成的上传地址(组建方式见本文档上传步骤2)
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | multipart/form-data | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| file | file | 是 | 上传文件 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| datas | object | 非必须 | |||
| ├─ docId | string | 非必须 | |||
| errorCode | number | 非必须 | |||
| success | boolean | 非必须 |
删除文档
基本信息
Path： http://api.csslcloud.net/api/document/delete
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| userid | 是 | 客户ID | |
| docids | 是 | 文档ID，以英文逗号分隔，例：F3342D97BB1D6DF8,0498CE5AAF1F53F5 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| datas | object | 非必须 | |||
| errorCode | number | 非必须 | |||
| success | boolean | 非必须 |
查询文档信息
基本信息
Path： http://api.csslcloud.net/api/documents
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| userid | 是 | 客户ID | |
| docids | 否 | 文档ID，以英文逗号分隔，例：F3342D97BB1D6DF8,0498CE5AAF1F53F5 | |
| roomid | 否 | 直播间ID，注：与docids参数不能同时存在，否则无效。 | |
| pagenum | 否 | 每页返回文档个数，默认：100，注：不能超过100 | |
| pageindex | 否 | 页码，默认：1 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 非必须 | |||
| datas | object | 非必须 | |||
| ├─ pageIndex | number | 非必须 | |||
| ├─ documents | object [] | 非必须 | item 类型: object | ||
| ├─ pageCount | number | 必须 | 文档页数，当文档为处理中状态该值为0 | ||
| ├─ fileSize | number | 必须 | 文档大小，单位：Byte | ||
| ├─ supportAnimation | boolean | 必须 | 是否支持动画 | ||
| ├─ id | string | 必须 | 文档ID | ||
| ├─ originalFileURL | string | 必须 | 源文件下载地址，如果文档源文件不存在，则不返回该字段 | ||
| ├─ type | number | 必须 | 文档类型，0:PDF 1:WORD 2:PPT 3:JPG | ||
| ├─ title | string | 必须 | 文档名称 | ||
| ├─ uploadTime | string | 必须 | 文档上传时间 | ||
| ├─ roomId | string | 必须 | 直播间ID | ||
| ├─ status | number | 必须 | 文档状态，10:处理中 20:正常 | ||
| ├─ count | number | 非必须 | |||
| ├─ pageNum | number | 非必须 | |||
| errorCode | number | 非必须 |