- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Demo Download and Experience
- Interface Customization
- API Documentation
- Service Callbacks
- Best Practice
- LCIC Policy
- Console Guide
- Quick Run-through
- FAQs
- Service Agreement
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Demo Download and Experience
- Interface Customization
- API Documentation
- Service Callbacks
- Best Practice
- LCIC Policy
- Console Guide
- Quick Run-through
- FAQs
- Service Agreement
1. API Description
Domain name for API request: lcic.tencentcloudapi.com.
This API is used to get the document list of a specific room.
A maximum of 20 requests can be initiated per second for this API.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDocumentsByRoom. |
| Version | Yes | String | Common Params. The value used for this API: 2022-08-17. |
| Region | No | String | Common Params. This parameter is not required. |
| RoomId | Yes | Integer | The room ID. |
| SdkAppId | Yes | Integer | The SDKAppID assigned by LCIC. |
| Page | No | Integer | The page to return records from. Pagination starts from 1, which is also the default value of this parameter. |
| Limit | No | Integer | The maximum number of records to return per page. The maximum value can be 1000. The default value is 100. |
| Permission.N | No | Array of Integer | The document access type. [0]: The private documents of the owner. [1]: The public documents of the owner. [0,1]: The private and public documents of the owner. [2]: The private and public documents of all users (including the owner). Default value: [2]. |
| Owner | No | String | The user ID of the document owner. If you do not specify this, the information of all documents under the application will be returned. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Documents | Array of DocumentInfo | Note: This field may return null, indicating that no valid values can be obtained. |
| Total | Integer | The total number of records that meet the conditions. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the documents of a specific room
This example shows you how to query the documents of a specific room.
Input Example
{
"RoomId": 1,
"SdkAppId":1234567
}
Output Example
{
"Response": {
"Total": 1,
"Documents": [
{
"DocumentId": "xx",
"DocumentUrl": "xx",
"DocumentName": "xx",
"Owner": "xx",
"SdkAppId": 1,
"Permission": 1,
"TranscodeResult": "xx",
"TranscodeType": 1,
"TranscodeProgress": 1,
"TranscodeState": 1,
"TranscodeInfo": "xx",
"DocumentType": "xx",
"DocumentSize": 1,
"UpdateTime": 1
}
],
"RequestId": "xx"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| DryRunOperation | The request would have succeeded, but the DryRun parameter was used. |
| FailedOperation | Operation failed. |
| FailedOperation.ClassStarted | Class status error. The class has already started. |
| FailedOperation.ClassTooLong | A class session cannot be longer than five hours. |
| FailedOperation.ImageArgInvalid | Image parameter error. |
| FailedOperation.OriginIdExists | The user origin ID already exists. |
| FailedOperation.RoomNotEnd | The class has not ended. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.Content | Prohibited content (pornographic, terrorist, politically sensitive) detected. |
| InvalidParameter.EndTime | The end time cannot be earlier than the current time. |
| InvalidParameter.SdkAppId | SdkAppId is incorrect. |
| InvalidParameter.StartTime | The start time cannot be earlier than the current time. |
| InvalidParameterValue | Invalid parameter value. |
| LimitExceeded | The quota limit is reached. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | Too many requests. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resource. |
| ResourceInsufficient.Record | Insufficient storage space. |
| ResourceInsufficient.Room | Failed to enter the class. Please check your resource usage in the console. |
| ResourceNotFound | The resource doesn’t exist. |
| ResourceNotFound.Document | The file does not exist. |
| ResourceNotFound.Room | The room does not exist. |
| ResourceNotFound.User | The user does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourceUnavailable.RoomStatistics | Getting room data. Please wait. |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
Yes
No
Was this page helpful?