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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListClasses

系统规定参数。取值:ListClasses

AppId String lq****cu

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

Status Integer 2

课程状态

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

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

PageSize Integer 25

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

返回数据

名称 类型 示例值 描述
RequestId String ER52****O9CA

Id of the request

Result Object

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

TotalCount Integer 1000

课程总数。

PageTotal Integer 100

课程总页数。

HasMore Boolean true

是否还有下一页。

ClassList Array of ClassList

课程列表信息。

ClassId String AE35****T95F

课程唯一标识。

Title String PPT制作培训

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

CreateUserId String 34***45

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

CreateNickname String 随风

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

Status Integer 2

课堂状态

  • 0:未开始
  • 1:上课中
  • 2:已下课。
StartTime Long 16****450

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

EndTime Long 16****950

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

RoomId String AE35-****-T95F

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

LiveId String b7f2****ebb3

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

ConfId String fb0f-****-4cb1

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

WhiteboardId String fgej**2

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

WhiteboardRecordId String eofg**rt

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

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/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>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
    } ]
  }
}

错误码

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