查询账号文档列表

更新时间：2022-12-28

接口描述

查询账号文档列表

请求地址

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

请求方式

GET

请求参数

接口统一权限认证请参考THQS认证方式。

名称 类型 必填 描述
accountId String 是 开发者账号
pageSize Integer 否 第几页，默认1。取值范围:大于1的整数
pageLength Integer 否 每页记录条数，默认50。取值范围:1~500整数
roomId String 否 直播间ID，如果该参数传值表示该账户下的文档是否与该直播间已关联
docId String 否 文档ID
docName String 否 文档名称，取值范围为：长度1~200个字符
timeGte date 否 日期,格式：'yyyy-MM-dd HH:mm:ss'，取值范围：选择上传时间>=该值的文档
timeLte date 否 日期,格式：'yyyy-MM-dd HH:mm:ss'，取值范围：选择上传时间<=该值的文档
docType Integer 否 文档类型：0为普通文档， 1为铺码文档，默认值：0，取值范围：[0,1]
status Integer 否 文档状态: -2为未上传, -1为上传失败, 0为上传成功, 1为转换成功, 2为转换中, 3为转换失败, -11为铺码失效, -10为铺码失败, 10为铺码成功, 11为铺码中，取值范围:[-2,-1,0,1,2,3,-11,10,11]

请求示例

GET https://ccapi.csslcloud.net/openapi/v1/doc/list?accountId=41E8063FC799ACE&status=1time=1670412086&hash={hash}

返回数据

公共返回数据结构请参考 公共返回数据说明。

名称 类型 描述
docs Object 返回文档数据
picDomain String 普通文档的地址
picDotDomain String 铺码文档下载域名，铺码文档下载地址规则说明：${picDotDomain}/dot/${accountId}/${docId}.pdf，示例：http://docclass.csslcloud.net/dot/ACC1C50945095C28/D30F83EF605D6D0C.pdf

docs说明

名称 类型 描述
total Integer 文档列表总条数
data Array 文档列表信息

data说明

名称 类型 描述
size Integer 文档大小，单位:Byte
status Integer 状态：-2为未上传, -1为上传失败，0为上传成功， 1为转换成功，2为转换中， 3为转换失败， -11为铺码失效， -10为铺码失败， 10为铺码成功，11为铺码中
docId String 文档ID
docName String 文档名称
pageSize Integer 文档页数
docRoomId String 共享盘直播间D，说明：文档上传挂载载该直播间共享磁盘下
useSDK Integer PPT动效：0为未开启，1为开启
createTime String 上传时间，格式：yyyy-MM-dd HH:mm:ss
mode Integer 文档模式：0为非动画，1为普通动画，2为极速动画
retainMedia Integer 保留音视频标识：0为不保留，1为保留
docType Integer 文档类型：0为普通文档， 1为铺码文档
related Integer 关联标识：0为未关联，1为已关联 ，说明：如果room_id参数没传，则该字段返回null

返回示例


{
  "result": "OK",
  "error": null,
  "data": {
    "docs": {
      "total": 82,
      "data": [
        {
          "size": 1000,
          "status": -2,
          "docId": "36F5A35557149BF39C33DC5901307461", 
          "docName": "测试文档.pdf",
          "pageSize": 0,
          "docRoomId": "88C79C053AFF11E39C33DC5901307461",
          "useSDK": 0,
          "createTime": null,
          "mode": 0,
          "retainMedia": 0, 
          "docType": 0,
          "related": null
        }
      ]
    },
    "picDomain": "https://image.csslcloud.net",
    "picDotDomain": "https://docclass.csslcloud.net"
  },
  "errorMsg": ""
}

results matching ""

    No results matching ""