1. 接口描述
接口请求域名: lcic.tencentcloudapi.com 。
获取课堂的所有编辑版本(含源版本)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeEditVersions。 |
| Version | 是 | String | 公共参数,本接口取值:2022-08-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| SdkAppId | 是 | Integer | 应用ID 示例值:3520371 |
| RoomId | 是 | Integer | 课堂ID 示例值:326744409 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClassId | Integer | 课堂ID 示例值:326744409 |
| LatestVersionNo | Integer | 当前课堂最新的版本号 示例值:2 |
| MainVersion | Integer | 当前课堂设置的主版本号 示例值:2 |
| Versions | Array of EditVersions | 当前课堂所有版本信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取当前可以全部版本信息
输入示例
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEditVersions
<公共请求参数>
{
"SdkAppId": 3520371,
"RoomId": 326744409
}
输出示例
{
"Response": {
"ClassId": 326744409,
"LatestVersionNo": 2,
"MainVersion": 2,
"Versions": [
{
"CreatedAtMs": 0,
"CreatorUserId": "",
"FailReason": "",
"IsMain": false,
"IsSource": true,
"KeepDurationSec": 0,
"Status": "READY",
"Version": 1
}
],
"RequestId": "25cb9f60-9f9a-4152-9523-232a482c041e"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.ClassEnded | 房间状态错误,房间已结束。 |
| FailedOperation.ClassExpired | 房间状态错误,房间已过期。 |
| FailedOperation.ClassStarted | 课堂状态错误,课堂已开始。 |
| FailedOperation.ClassTooLong | 预约课堂的时长不能超过72小时(不影响实际上课)。 |
| FailedOperation.ImageArgInvalid | 图片参数错误。 |
| FailedOperation.OriginIdExists | 源账号已存在。 |
| FailedOperation.PostpaidNotAvailable | 创建课堂失败。未开启“后付费”功能,字幕转写服务无法使用 |
| FailedOperation.RequestTimedOut | 请求超时 |
| FailedOperation.RoomNotEnd | 房间暂未结束。 |
| FailedOperation.UserIsAlreadyInGroup | 该成员已被添加到群组,请先在群组中删除该成员。 |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ClassID | 无效ClassID |
| InvalidParameter.ClassIDs | ClassIDs超过最大值 |
| InvalidParameter.Content | 文案涉及敏感词,请调整后重新输入。 |
| InvalidParameter.CssOrJs | css/js地址无法访问 |
| InvalidParameter.DisableRecord | DisableRecord参数错误 |
| InvalidParameter.EndTime | 结束时间不能早于开始时间。 |
| InvalidParameter.GroupMemberOverLimit | 操作的群组成员超过限制 |
| InvalidParameter.GroupParamInvalid | 参数错误,主讲人与成员都为空 |
| InvalidParameter.GroupTeacherNotMember | 主讲人不能同时是群组成员 |
| InvalidParameter.GroupTeachersNotExist | 群组主讲老师不存在 |
| InvalidParameter.GroupTypeInvalid | 群组类型错误 |
| InvalidParameter.LiveType | LiveType参数错误 |
| InvalidParameter.MaxMicNumber | MaxMicNumber参数错误 |
| InvalidParameter.MaxRTCMember | MaxRTCMember参数错误 |
| InvalidParameter.RecordLayout | RecordLayout参数错误 |
| InvalidParameter.ReplayLayout | ReplayLayout参数错误 |
| InvalidParameter.RoomTypeInvalid | room类型错误 |
| InvalidParameter.SchoolID | SchoolID参数错误 |
| InvalidParameter.SdkAppId | SdkAppId参数错误。 |
| InvalidParameter.StartTime | 开始时间不能早于当前时间。 |
| InvalidParameter.UserSchoolMismatch | UserID和SchoolID不匹配 |
| InvalidParameterCombination | 无效参数组合 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.ClassDocumentLimit | 绑定的课件超出限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceInsufficient.Record | 录制功能因存储超量或账号欠费而受限。 |
| ResourceInsufficient.Room | 打开课堂失败,请前往控制台查看用量情况。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.Document | 文档不存在。 |
| ResourceNotFound.GroupNotExist | 群组不存在 |
| ResourceNotFound.GroupPartUsersNotExist | 用户ID不存在 |
| ResourceNotFound.Room | 房间不存在。 |
| ResourceNotFound.User | 用户不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceUnavailable.RoomStatistics | 房间统计结果计算中,请稍候。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.Version | 套餐包版本不支持 |