ListClasses - 获取课程列表

调用ListClasses获取课程列表。可基于应用ID和课程状态,分页查询应用对应的所有课程列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

应用唯一标识,由6位小写字母、数字组成。

lq****cu
Statusinteger

课程状态

  • 0-未开课
  • 1-上课中
  • 2-已下课
  • 不传则返回所有课程。
2
PageNumberinteger

查询页码,从1开始,传空默认查询第1页。

1
PageSizeinteger

每页显示个数,最大支持50,参数为空默认显示个数为10。

25

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

ER52****O9CA
Resultobject

查询课程列表返回的结果。

TotalCountinteger

课程总数。

1000
PageTotalinteger

课程总页数。

100
HasMoreboolean

是否还有下一页。

true
ClassListarray

课程列表信息。

object
ClassIdstring

课程唯一标识。

AE35****T95F
Titlestring

课程标题,支持中英文,最大长度32个字符。

PPT制作培训
CreateUserIdstring

创建人用户ID,仅支持英文和数字,最大长度36个字符。

34***45
CreateNicknamestring

创建人用户昵称,支持中英文,最大长度32个字符。

随风
Statusinteger

课堂状态

  • 0:未开始
  • 1:上课中
  • 2:已下课。
2
StartTimeLong

开始上课时间戳,单位:毫秒。

16****450
EndTimeLong

下课时间戳,单位:毫秒。

16****950
RoomIdstring

房间ID。可用于查询房间详情信息,和端上SDK接入时作为参数传入。

AE35-****-T95F
LiveIdstring

直播ID。可用于查询直播详情,和端上调用直播相关接口时作为参数传入。

b7f2****ebb3
ConfIdstring

连麦会议ID。可用于RTC入会,获取会议详情。

fb0f-****-4cb1
WhiteboardIdstring

白板ID。可用于查询白板信息,和端上接入白板SDK时作为参数传入。

fgej**2
WhiteboardRecordIdstring

白板录制ID。可用于端上获取白板录制内容并播放。

eofg**rt

示例

请求示例

http(s)://[Endpoint]/?Action=ListClasses
&AppId=lq****cu
&Status=2
&PageNumber=1
&PageSize=25
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "ER52****O9CA",
    "Result": {
        "TotalCount": 1000,
        "PageTotal": 100,
        "HasMore": true,
        "ClassList": [
            {
                "ClassId": "AE35****T95F",
                "Title": "PPT制作培训",
                "CreateUserId": "34***45",
                "CreateNickname": "随风",
                "Status": 2,
                "RoomId": "AE35-****-T95F",
                "LiveId": "b7f2****ebb3",
                "ConfId": "fb0f-****-4cb1",
                "WhiteboardId": "fgej**2",
                "WhiteboardRecordId": "eofg**rt"
            }
        ]
    }
}

XML格式

<ListClassesResponse>
    <RequestId>ER52****O9CA</RequestId>
    <Result>
        <TotalCount>1000</TotalCount>
        <PageTotal>100</PageTotal>
        <HasMore>true</HasMore>
        <ClassList>
            <ClassId>AE35****T95F</ClassId>
            <Title>PPT制作培训</Title>
            <CreateUserId>34***45</CreateUserId>
            <CreateNickname>随风</CreateNickname>
            <Status>2</Status>
            <RoomId>AE35-****-T95F</RoomId>
            <LiveId>b7f2****ebb3</LiveId>
            <ConfId>fb0f-****-4cb1</ConfId>
            <WhiteboardId>fgej**2</WhiteboardId>
            <WhiteboardRecordId>eofg**rt</WhiteboardRecordId>
        </ClassList>
    </Result>
</ListClassesResponse>

错误码

访问错误中心查看更多错误码。

阿里云首页 低代码音视频工厂 相关技术圈