调用GetClassDetail获取课程详情。可用于查询课程状态,以及相关联的直播,连麦,白板等ID信息。通过这些ID,可进一步查询对应的直播,连麦,白板的详情。

调试

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

请求参数

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

系统规定参数。取值:GetClassDetail

AppId String 7m***q

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

ClassId String A55-****-Y34O

课程唯一标识,由调用CreateClass返回。

UserId String as****hs

操作人用户ID,仅支持英文字母和数字,长度最多36个字符。

返回数据

名称 类型 示例值 描述
RequestId String FE22D613-D3C6-4A58-87CA-F21FC85AA08E

请求ID。

Result Object

获取课堂详情的返回结果。

ClassId String A55-****-Y34O

课程唯一标识。

Title String ClassTitle001

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

CreateUserId String as****hs

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

CreateNickname String nickname001

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

Status Integer 2

课程状态。取值:

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

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

EndTime Long 1632797405000

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

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=GetClassDetail
&AppId=7m***q
&ClassId=A55-****-Y34O
&UserId=as****hs
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetClassDetailResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <ClassId>A55-****-Y34O</ClassId>
        <Title>ClassTitle001</Title>
        <CreateUserId>as****hs</CreateUserId>
        <CreateNickname>nickname001</CreateNickname>
        <Status>2</Status>
        <StartTime>1632794405000</StartTime>
        <EndTime>1632797405000</EndTime>
        <RoomId>AE35-****-T95F</RoomId>
        <LiveId>b7f2****ebb3</LiveId>
        <ConfId>fb0f-****-4cb1</ConfId>
        <WhiteboardId>fgej**2</WhiteboardId>
        <WhiteboardRecordId>eofg**rt</WhiteboardRecordId>
    </Result>
</GetClassDetailResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
  "Result" : {
    "ClassId" : "A55-****-Y34O",
    "Title" : "ClassTitle001",
    "CreateUserId" : "as****hs",
    "CreateNickname" : "nickname001",
    "Status" : 2,
    "StartTime" : 1632794405000,
    "EndTime" : 1632797405000,
    "RoomId" : "AE35-****-T95F",
    "LiveId" : "b7f2****ebb3",
    "ConfId" : "fb0f-****-4cb1",
    "WhiteboardId" : "fgej**2",
    "WhiteboardRecordId" : "eofg**rt"
  }
}

错误码

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