文档

GetClassDetail - 获取课程详情

更新时间:

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

调试

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

调试

授权信息

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

请求参数

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

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

7m***q
ClassIdstring

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

A55-****-Y34O
UserIdstring

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

as****hs

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultobject

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

ClassIdstring

课程唯一标识。

A55-****-Y34O
Titlestring

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

ClassTitle001
CreateUserIdstring

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

as****hs
CreateNicknamestring

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

nickname001
Statusinteger

课程状态。取值:

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

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

1632794405000
EndTimeLong

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

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

正常返回示例

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"
    }
}

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>

错误码

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

  • 本页导读 (1)