查询账户文档列表

更新时间：2022-12-28

接口描述

获取某个账户下文档列表

请求地址

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

请求方式

GET

请求参数

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

名称 类型 必填 描述
account_id String 是 开发者账号ID
doc_id String 否 文档ID
page Integer 否 第几页，默认1。取值范围:大于1的整数
lines Integer 否 每页记录条数，默认50。取值范围:1~500整数
time_gte String 否 查询大于等于上传时间的文档，格式:yyyy-MM-dd HH:mm:ss，示例:"2022-12-11 00:00:00"
time_lte String 否 查询小于等于上传时间的文档，格式:yyyy-MM-dd HH:mm:ss，示例:"2022-12-11 00:00:00"
room_id String 否 直播间ID
doc_name String 否 文档名称，取值范围为：长度1~200个字符

请求示例

GET https://ccapi.csslcloud.net/api/v1/doc/list?account_id=41E8063FC799ACE&time=1670412086&hash={hash}

返回数据

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

名称 类型 描述
result String 返回状态：OK为成功，FAIL为失败
picDomain String 文档域名
total Integer 总页数
current Integer 当前页数
docs Array 文档信息列表

docs说明

名称 类型 描述
id String 文件ID
name String 文件名称
pageSize Integer 文件页数
roomId String 共享盘直播间ID
size Integer 文件大小
useSDK Integer ppt动效：0为未开启，1为开启
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参数没传，则不返回该字段

返回示例

{
  "result": "OK",
  "picDomain": "https://image.csslcloud.net",
  "docs": [
    {
      "id": "CFD3C4FB8D2B6148", 
      "name": "MBA讲座.ppt", 
      "pageSize": 24, 
      "roomId": "2EE731074C8D64679C33DC5901307461",
      "size": 3679232,
      "useSDK": 0, 
      "create_time": "2018-01-01 12:00:00",
      "status": 1,
      "related": 1
    }

  ],
  "total": 1,  
  "current": 1
}

results matching ""

    No results matching ""