铺码文档相关接口

日期: 2021-05-18

创盛视联数码科技（北京）有限公司

[TOC]

一、流程说明

文档上传到账户下,以下操作接口同时支持普通类型文档

1.上传文档

描述：

创建文档信息并获取上传信息, 通过返回上传信息，执行上传文档操作

注意，第一步doc_size参数需要和第二步实际上传文档大小一致

1.1 获取文档上传信息

地址：

https://ccapi.csslcloud.net/openapi/v1/doc/add

方法：

GET

请求参数：

参数名称 参数类型 参数说明 备注
accountId 字符串 开发者账号ID 必须
docName 字符串 文件名 必须
docSize 整型 文档大小，单位Byte（最大不能超过104857600 必须
docType 整型 文档类型 默认0，0普通课件 1 铺码课件（注：铺码上传文件类型仅支持:*.pdf，文件大小仅支持A4）
allowAnimation 整型 是否极速文档 默认为0， 0不支持 1支持ppt 2ppt极速,注：docType为0的时候才起作用
cycleCode 整型 循环铺码 0非循环铺码, 1循环铺码(注：当前铺码资源不够时将释放最早铺码的文件资源，释放后已下载铺码文件将不可用 ) docType为1的时候必须传值

返回示例:

{
  "result": "OK",
  "error": null,
  "data": {
    "uploadUrl": "https://document.csslcloud.net/api/document/upload?userid=41E8063FC799ACE5&docid=36F5A35557149BF39C33DC5901307461&supportanimation=0"
  },
  "errorMsg": ""
}
1.2 文档上传

地址：

 上传地址通过 上一步 获取文档信息接口 返回（data.uploadUrl）
 普通课件文件格式支持:  .doc  .docx  .ppt  .pptx  .pdf  .png
 后续支持jpg
 铺码课件文件格式支持：.pdf,文件大小仅支持A4

方法：

POST

请求参数：

参数名称 参数类型 参数说明 备注
file 二进制 文档 必须
supportanimation 整型 支持动画，0:不支持 1:支持 （只对PPT有效） 可选

备注:

file需要放到request body里面，supportanimation参数需要拼接到URL中, 如果需要

返回示例:

{
    "datas": {
        "docId": "0A0833E541533352"
    },
    "errorCode": 0,
    "success": true
}

2. 获取账户文档列表

描述：

获取某个账户下共享文档列表

地址：

https://ccapi.csslcloud.net/openapi/v1/doc/list

方法：

GET

请求参数:

参数名称 参数类型 参数说明 备注
accountId 字符串 开发者账号ID 必须
pageSize 整型 获取指定页，默认返回第一页 可选
pageLength 整型 每页的数据条数，默认每页50 可选
roomId 整型 查询该账户下的文档 是否与该房间已关联 可选
docId 整型 文档ID, 用于查询 可选
docName 字符串 文档名, 用于查询 可选
timeGte 日期 date/datetime 根据此参数，选择上传时间>= 该值的文档 可选
timeLte 日期 date/datetime 根据此参数，选择上传时间<= 该值的文档 可选
docType 整型 文档类型，0普通课件 1铺码课件，用于查询 可选
status 整型 文档状态 -2: 未上传 -1:上传失败 0: 上传成功 1: 转换成功 2: 转换中 3: 转换失败 -11铺码失效 -10铺码失败 10铺码成功 11铺码中，用于查询 可选

备注：status 状态字段：普通课件下的状态(-2: 未上传 -1:上传失败 0: 上传成功 1: 转换成功 2: 转换中 3: 转换失败)

​ 铺码课件下的状态(-2: 未上传 -1:上传失败 0: 上传成功 1: 转换成功 2: 转换中 3: 转换失败 -11铺码失效 -10铺码失败 10铺码成功 11铺码中)

返回示例:

{
  "result": "OK",
  "error": null,
  "data": {
    "docs": {
      "total": 82,
      "data": [
        {
          "size": 1000, #文档大小
          "status": -2, -11 铺码失效、-10铺码失败 -2: 未上传  -1:上传失败 0: 上传成功 1: 转换成功 
                     2: 转换中 3: 转换失败 10铺码成功 11铺码种
          "docId": "36F5A35557149BF39C33DC5901307461", #文档Id
          "docName": "测试文档.pdf",# 文件名称
          "pageSize": 0, # 文件页数
          "docRoomId": "88C79C053AFF11E39C33DC5901307461",
          "useSDK": 0, #ppt动效 0: 未开启  1: 开启
          "createTime": null,#上传时间
          "mode": 0,
          "retainMedia": 0, # 保留音视频标识,默认值0不保留, 1保留
          "docType": 0,#文档类型 0普通课件 1铺码课件
          "related": null #已关联 0 未关联，如果room_id参数没传，则不返回该字段
        }
      ]
    },
    "picDomain": "https://image.csslcloud.net", # 实际去访问文档的地址
    "picDotDomain": "https://docclass.csslcloud.net" #实际下载铺码文档的地址
  },
  "errorMsg": ""
}
}
铺码文档下载地址规则说明：${picDotDomain}/dot/${accountId}/${docId}.pdf
示例：http://docclass.csslcloud.net/dot/ACC1C50945095C28/D30F83EF605D6D0C.pdf

3.删除账户文档

描述：

删除账户下实际文档(不可恢复)

地址：

https://ccapi.csslcloud.net/openapi/v1/doc/delete

方法：

GET

请求参数：

参数名称 参数类型 参数说明 备注
accountId 字符串 开发者账号ID 必须
docId 字符串 文档ID,多个docId用逗号(,)隔开 必须

返回示例:

{
  "result": "OK", # 失败： FAIL，成功：OK
  "error": null,
  "data": null,
  "errorMsg": ""
}

4.查询练习历史作答文档信息

描述：

查询练习历史作答文档信息

地址:

https://ccapi.csslcloud.net/openapi/v1/doc/practice/history/doc_info

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
accountId 字符串 开发者账号ID 必须
roomId 字符串 直播间ID 必须
liveId 字符串 直播ID 必须
userId 字符串 用户ID 可选
pageSize 整型 页码 可选 (不传userId时生效)
pageLength 整型 条数 可选 (不传userId时生效)

返回示例:

{
    "result":"OK",
    "error":null,
    "data":{
        "total":1,//总条数
        "list":[
            {
                "list":[
                    {
                        "docId":"EBDB77206AB3B7C19C33DC5901307461", //文档id
                        "page":0, //页码
                        "url":"https://image.csslcloud.net/image/9F2252F04EC4874F9C33DC5901307461/EBDB77206AB3B7C19C33DC5901307461/0.jpg", //打开的url
                        "picDomain":"https://image.csslcloud.net", //请求主域名
                        "docRoomId":"9F2252F04EC4874F9C33DC5901307461", //文档的docRoomId
                        "totalPage":50 //总页码
                    }
                ],
                "userId":"1412", //当前用户id
                "userName":"测试用户14" //当前用户名称
            } 
        ]
    },
    "errorMsg":""
}

5.查询练习文档画笔详情

描述：

查询练习文档画笔详情

地址:

https://ccapi.csslcloud.net/openapi/v1/doc/practice/history/draw_detail

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
accountId 字符串 开发者账号ID 必须
liveId 字符串 直播ID 必须
userId 字符串 用户ID 必须
docPage 整型 文档页码 必须
docId 字符串 文档ID 必须

返回示例:

{
    "result":"OK",
    "error":null,
    "data":{
        "list":[
            {
              // 用户id
                "viewerid":"1412",
              // 切换画笔类型前的上一个画笔类型
                "preType":2,
              // 画笔颜色
                "color":"00000000",
              // 画笔粗细
                "thickness":0.5,
              // 文档id
                "docid":"EBDB77206AB3B7C19C33DC5901307461",
              // 用户名
                "viewername":"测试用户14",
              // 画笔id
                "drawid":"14121619345723628",
              // 画笔坐标数据
                "draw":[
                    {
                        "x":0.43589285714285714,
                        "y":0.11527777777777778
                    }
                ],
              // 当前画笔类型（2是普通画笔）
                "type":2,
              // 文档转码模式
                "mode":0,
              // 画笔透明度
                "alpha":1,
              // 画笔所在容器宽度
                "width":1470,
              // 文件名称
                "name":"5年级满分班1-10讲试卷.pdf",
              // 使用动画（练习未使用
                "useSDK":false,
              // 字体大小（练习中未使用
                "fontSize":15,
              // 当前页码
                "page":0,
              // 画笔所在容器高度
                "height":2080
            }
        ]
    },
    "errorMsg":""
}

results matching ""

    No results matching ""