tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Low-code Interactive Classroom
    Documentation
    Download PDF

    Data Types

    Last updated: 2024-04-01 19:55:36
    Download PDF

      AnswerInfo

      The answer to a quiz question.

      Used by actions: DescribeAnswerList.

      Name Type Description
      Name String The username.
      Answer Integer The answer. Bits are used to indicate the options chosen. For example, 0x1 indicates that option A is chosen; 0x11 indicates that A and B are chosen, and so on.
      CostTime Integer The time used.
      UserId String The user ID.
      IsCorrect Integer Whether the answer is correct. 1: Correct; 0: Incorrect.

      AnswerStat

      The statistics for each type of answer.

      Used by actions: DescribeQuestionList.

      Name Type Description
      Answer Integer The answer. Bits are used to indicate the options chosen. For example, 0x1 indicates that option A is chosen; 0x11 indicates that A and B are chosen, and so on.
      Count Integer The number of users that submitted the answer.

      AppCustomContent

      Custom application content
      Used by actions: SetAppCustomContent.

      Used by actions: SetAppCustomContent.

      Name Type Required Description
      Scene String Yes Multiple scenarios can be set for an application.
      LogoUrl String No Logo URL
      HomeUrl String No Homepage URL, which can be used for redirection
      JsUrl String No Custom JS URL
      CssUrl String No Custom CSS URL

      BackgroundPictureConfig

      Background image settings.

      Used by actions: GetWatermark.

      Name Type Description
      Url String The URL of the background image.
      Note: This field may return null, indicating that no valid values can be obtained.

      BatchUserInfo

      The information of registered users.
      Used by actions: BatchRegister.

      Used by actions: BatchRegister.

      Name Type Description
      SdkAppId Integer The SDKAppID assigned by LCIC.
      UserId String
      Note: This field may return null, indicating that no valid values can be obtained.
      OriginId String
      Note: This field may return null, indicating that no valid values can be obtained.

      BatchUserRequest

      The information of the users to register.
      Used by actions: BatchRegister.

      Used by actions: BatchRegister.

      Name Type Required Description
      SdkAppId Integer Yes The SDKAppID assigned by LCIC. Note: This field may return null, indicating that no valid values can be obtained.
      Name String No The username. Note: This field may return null, indicating that no valid values can be obtained.
      OriginId String No The user’s ID in your system, which must be unique across the same application. Note: This field may return null, indicating that no valid values can be obtained.
      Avatar String No The user’s profile photo. Note: This field may return null, indicating that no valid values can be obtained.

      CustomMsgContent

      Used by actions: GetRoomMessage.

      Name Type Required Description
      Data String No Custom message data.
      Desc String No Customize the message description information.
      Ext String No Extended Fields

      DocumentInfo

      Document Information.
      Used by actions: DescribeDocumentsByRoom.

      Used by actions: BatchDescribeDocument, DescribeDocuments, DescribeDocumentsByRoom.

      Name Type Description
      DocumentId String The document ID. Note: This field may return null, indicating that no valid values can be obtained.
      DocumentUrl String The document's original URL. Note: This field may return null, indicating that no valid values can be obtained.
      DocumentName String The document title. Note: This field may return null, indicating that no valid values can be obtained.
      Owner String The user ID of the document's owner. Note: This field may return null, indicating that no valid values can be obtained.
      SdkAppId Integer The application ID. Note: This field may return null, indicating that no valid values can be obtained.
      Permission Integer The document access type. 0: Private; 1: Public. Note: This field may return null, indicating that no valid values can be obtained.
      TranscodeResult String The transcoding result. If the file is not transcoded, this parameter will be empty. If it is successfully transcoded, this parameter will be the URL of the transcoded file. If transcoding fails, this parameter will indicate the error code. Note: This field may return null, indicating that no valid values can be obtained.
      TranscodeType Integer The transcoding type. Note: This field may return null, indicating that no valid values can be obtained.
      TranscodeProgress Integer The transcoding progress. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.
      TranscodeState Integer The transcoding status. 0: The file is not transcoded. 1: The file is being transcoded. 2: Transcoding failed. 3: Transcoding is successful. Note: This field may return null, indicating that no valid values can be obtained.
      TranscodeInfo String The error message for failed transcoding. Note: This field may return null, indicating that no valid values can be obtained.
      DocumentType String The document type. Note: This field may return null, indicating that no valid values can be obtained.
      DocumentSize Integer The document size (bytes). Note: This field may return null, indicating that no valid values can be obtained.
      UpdateTime Integer The time (Unix timestamp) when the document was last updated. Note: This field may return null, indicating that no valid values can be obtained.
      Pages Integer The number of pages.
      Note: This field may return null, indicating that no valid values can be obtained.
      Width Integer The width. This parameter is valid only if static document transcoding is used.
      Note: This field may return null, indicating that no valid values can be obtained.
      Height Integer The height. This parameter is valid only if static document transcoding is used.
      Note: This field may return null, indicating that no valid values can be obtained.
      Cover String The thumbnail. Only transcoded courseware has thumbnails.
      Note: This field may return null, indicating that no valid values can be obtained.
      Preview String Document preview address

      EventDataInfo

      The information of a room event.

      Used by actions: GetRoomEvent.

      Name Type Description
      RoomId Integer The room ID.
      Note: This field may return null, indicating that no valid values can be obtained.
      UserId String The ID of the user to whom the event occurred.
      Note: This field may return null, indicating that no valid values can be obtained.
      Device Integer User device type. 0: Unknown; 1: Windows; 2: macOS; 3: Android; 4: iOS; 5: Web; 6: Mobile webpage; 7: Wechat Mini Program.
      Duration Integer Recording time. Unit: seconds
      RecordSize Integer Recorded file size
      RecordUrl String Recording url

      EventInfo

      The event information.

      Used by actions: GetRoomEvent.

      Name Type Description
      Timestamp Integer The Unix timestamp (seconds) when the event occurred.
      EventType String The event type. Valid values:
      RoomStart: The class started. RoomEnd: The class ended. MemberJoin: A user joined. MemberQuit: A user left. RecordFinish: Recording is finished.
      ·Camera0n·: The camera is turned on.
      Camera0ff: The camera is turned off.
      MicOn: The mic is turned on.
      MicOff: The mic is turned off.
      ScreenOn: Screen sharing is enabled.
      ScreenOff: Screen sharing is disabled.
      VisibleOn: The page is visible.
      VisibleOff: The page is invisible.
      EventData EventDataInfo The details of the event, including the room ID and the user to whom the event occurred.
      Note: This field may return null, indicating that no valid values can be obtained.

      GroupBaseInfo

      The information of the groups to create.
      Used by actions: BatchCreateGroupWithMembers.

      Used by actions: BatchCreateGroupWithMembers.

      Name Type Required Description
      GroupName String Yes The group names. Note: This field may return null, indicating that no valid values can be obtained.
      TeacherId String No The user ID of the teacher. Note: This field may return null, indicating that no valid values can be obtained.

      GroupInfo

      The information of the groups queried.
      Used by actions: DescribeGroupList.

      Used by actions: DescribeGroupList.

      Name Type Description
      GroupId String
      Note: This field may return null, indicating that no valid values can be obtained.
      GroupName String
      Note: This field may return null, indicating that no valid values can be obtained.
      TeacherId String
      Note: This field may return null, indicating that no valid values can be obtained.
      GroupType Integer
      Note: This field may return null, indicating that no valid values can be obtained.
      SubGroupIds String
      Note: This field may return null, indicating that no valid values can be obtained.

      MemberRecord

      Member record information
      Used by actions: DescribeCurrentMemberList, DescribeRoomStatistics.

      Used by actions: DescribeCurrentMemberList, DescribeRoomStatistics.

      Name Type Description
      UserId String User ID
      UserName String Username
      PresentTime Integer Online duration, in seconds
      Camera Integer Whether the camera is enabled
      Mic Integer Whether the mic is enabled
      Silence Integer Whether the user is muted
      AnswerQuestions Integer Number of questions answered by the user
      HandUps Integer Number of hand raising times
      FirstJoinTimestamp Integer First time that the user entered the room, in UNIX timestamp format
      LastQuitTimestamp Integer Last time that the user left the room, in UNIX timestamp format
      Rewords Integer Number of rewards received
      IPAddress String The user's IP address.
      Location String The user's location.
      Device Integer The user's device type. 0: Unknown; 1: Windows; 2: macOS; 3: Android; 4: iOS; 5: Web; 6: Mobile webpage; 7: Weixin Mini Program.
      PerMemberMicCount Integer The number of times a user turned their mic on.
      PerMemberMessageCount Integer The number of messages sent by a user.
      Role Integer The user role. 0: Student; 1: Teacher; 2: Teaching Assistant; 3: Spectator.
      GroupId String The class number.
      SubGroupId Array of String The sub-class number.
      Note: This field may return null, indicating that no valid values can be obtained.
      Stage Integer Whether the user is on the stage.
      Note: This field may return null, indicating that no valid values can be obtained.
      CurrentState Integer User status. 0 is not present, 1 is online, 2 is offline, 3 is kicked, 4 is permanently kicked, 5 is temporarily offline

      MessageItem

      The information of a message.

      Used by actions: GetRoomMessage.

      Name Type Description
      MessageType Integer The message type. 0: Text; 1: Image.
      Note: This field may return null, indicating that no valid values can be obtained.
      TextMessage String The text. This parameter is valid if MessageType is 0.
      Note: This field may return null, indicating that no valid values can be obtained.
      ImageMessage String The image URL. This parameter is valid if MessageType is 1.
      Note: This field may return null, indicating that no valid values can be obtained.
      CustomMessage CustomMsgContent Customize the message content. Vaild when message type=2.

      MessageList

      The list of historical messages.

      Used by actions: GetRoomMessage.

      Name Type Description
      Timestamp Integer The message timestamp.
      Note: This field may return null, indicating that no valid values can be obtained.
      FromAccount String The sender.
      Note: This field may return null, indicating that no valid values can be obtained.
      Seq Integer The message sequence, which is unique across a class. The earlier a message is sent, the lower the sequence.
      Note: This field may return null, indicating that no valid values can be obtained.
      MessageBody Array of MessageItem The message content.
      Note: This field may return null, indicating that no valid values can be obtained.

      QuestionInfo

      A quiz question in a room.

      Used by actions: DescribeQuestionList.

      Name Type Description
      QuestionId String The question ID.
      QuestionContent String The question.
      Duration Integer The time limit for the question. If you set this parameter to 0, there will not be a time limit.
      CorrectAnswer Integer The correct answer. Bits are used to indicate the options that should be chosen. For example, 0x1 indicates option A; 0x11 indicates A and B, and so on.
      AnswerStats Array of AnswerStat The statistics for each type of answer.
      Note: This field may return null, indicating that no valid values can be obtained.

      RoomInfo

      The information of the room to create.
      Used by actions: BatchCreateRoom.

      Used by actions: BatchCreateRoom.

      Name Type Required Description
      Name String Yes The room name.
      StartTime Integer Yes The room start time (Unix timestamp).
      EndTime Integer Yes The room end time (Unix timestamp).
      Resolution Integer Yes The resolution. Valid values: 1: SD; 2: HD; 3: FHD.
      MaxMicNumber Integer Yes The maximum number of mic-on users (excluding the teacher). Value range: 0-16.
      SubType String Yes The room subtype. Valid values: videodoc: Document + Video; video: Video only; coteaching: Dual-teacher.
      TeacherId String No The user ID of the teacher. User IDs are returned by the user registration APIs.
      AutoMic Integer No Whether to automatically turn the mic on when a user enters the room. Valid values: 0 (default): No; 1: Yes.
      TurnOffMic Integer No Whether to disconnect communication after audio/video permissions are revoked. Valid values: 0 (default): Yes; 1: No.
      AudioQuality Integer No Whether to enable the high audio quality mode. Valid values: 0 (default): No; 1: Yes.
      DisableRecord Integer No Whether to disable auto recording. Valid values: 0 (default): No; 1: Yes. If this parameter is 0, recording will start when the class starts and stops when the class ends.
      Assistants Array of String No The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.
      RTCAudienceNumber Integer No The number of RTC users.
      AudienceType Integer No The audience type.
      RecordLayout Integer No The recording layout.
      GroupId String No The ID of the group to bind. Note: This field may return null, indicating that no valid values can be obtained.
      EnableDirectControl Integer No Whether the students' consent is required to control their cameras/microphones.
      InteractionMode Integer No Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and teaching assistants
      VideoOrientation Integer No Horizontal and vertical screen. 0: Horizontal screen to open broadcast (default); 1: Vertical screen to open broadcast, currently only support mobile pure video type
      IsGradingRequiredPostClass Integer No Whether the room is enabled for grading after the lesson. 0: not enabled 1: enabled
      RoomType Integer No Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
      EndDelayTime Integer No Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes
      LiveType Integer No Live type: 0 regular (default) 1 Simulated Live
      RecordLiveUrl String No Simulated Live link
      EnableAutoStart Integer No Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid
      RecordBackground String No Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being
      RecordScene String No Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.

      RoomItem

      The room list.

      Used by actions: GetRooms.

      Name Type Description
      Name String The name.
      Note: This field may return null, indicating that no valid values can be obtained.
      RoomId Integer The room ID.
      Note: This field may return null, indicating that no valid values can be obtained.
      Status Integer The room status. 0: Not started; 1: Started; 2: Ended.
      Note: This field may return null, indicating that no valid values can be obtained.
      StartTime Integer The scheduled start time.
      Note: This field may return null, indicating that no valid values can be obtained.
      EndTime Integer The scheduled end time.
      Note: This field may return null, indicating that no valid values can be obtained.
      RealStartTime Integer The actual start time.
      Note: This field may return null, indicating that no valid values can be obtained.
      RealEndTime Integer The actual end time.
      Note: This field may return null, indicating that no valid values can be obtained.
      Resolution Integer The resolution. 1: SD.
      2: HD
      3: FHD
      Note: This field may return null, indicating that no valid values can be obtained.
      MaxRTCMember Integer The maximum number of mic-on users allowed.
      Note: This field may return null, indicating that no valid values can be obtained.
      ReplayUrl String The URL of the room's recording. This parameter has been deprecated. Please use RecordUrl instead.
      Note: This field may return null, indicating that no valid values can be obtained.
      RecordUrl String The recording URL (HTTPS), which is generated only after a room ends.
      Note: This field may return null, indicating that no valid values can be obtained.
      MaxMicNumber Integer The maximum number of users allowed (including teachers) in the room. The default value is 0, which indicates that no limit is set.
      Note: This field may return null, indicating that no valid values can be obtained.
      EnableDirectControl Integer Whether the students' consent is required to control their cameras/microphones.
      Note: This field may return null, indicating that no valid value was found.
      InteractionMode Integer
      VideoOrientation Integer
      IsGradingRequiredPostClass Integer
      RoomType Integer Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
      EndDelayTime Integer
      LiveType Integer
      RecordLiveUrl String
      EnableAutoStart Integer
      RecordBackground String
      RecordScene String
      RecordLang String

      TextMarkConfig

      The watermark text.
      Used by actions: GetWatermark.

      Used by actions: GetWatermark.

      Name Type Description
      Text String The watermark text. Note: This field may return null, indicating that no valid values can be obtained.
      Color String The watermark text color. Note: This field may return null, indicating that no valid values can be obtained.

      UserInfo

      The user information.
      Used by actions: DescribeSdkAppIdUsers.

      Used by actions: DescribeSdkAppIdUsers.

      Name Type Description
      SdkAppId Integer
      Note: This field may return null, indicating that no valid values can be obtained.
      UserId String
      Note: This field may return null, indicating that no valid values can be obtained.
      Name String
      Note: This field may return null, indicating that no valid values can be obtained.
      Avatar String
      Note: This field may return null, indicating that no valid values can be obtained.
      OriginId String User's Id in the client system

      WatermarkConfig

      Watermark settings.
      Used by actions: GetWatermark.

      Used by actions: GetWatermark.

      Name Type Description
      Url String The URL of the watermark image. Note: This field may return null, indicating that no valid values can be obtained.
      Width Float The watermark width, which is expressed as a percentage of the video width. Note: This field may return null, indicating that no valid values can be obtained.
      Height Float The watermark height, which is expressed as a percentage of the video height. Note: This field may return null, indicating that no valid values can be obtained.
      LocationX Float The horizontal offset of the watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle horizontally. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.
      LocationY Float The vertical offset of the watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle vertically. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy