API 中心

文档中心 API 中心实时互动-教育版数据结构

数据结构

最近更新时间：2024-04-18 01:23:21

我的收藏

本页目录：

AnswerInfo

房间问答答案详情

被如下接口引用：DescribeAnswerList。

名称	类型	描述
Name	String	用户名示例值：1
Answer	Integer	答案（按照位表示是否选择，如0x1表示选择A，0x11表示选择AB）示例值：1
CostTime	Integer	答题用时示例值：1
UserId	String	用户ID 示例值：1j2d32s121JtGYss9bg4T
IsCorrect	Integer	答案是否正确（1正确0错误）示例值：1

AnswerStat

每个选项答题人数统计

被如下接口引用：DescribeQuestionList。

名称	类型	描述
Answer	Integer	选项（按照位表示是否选择，如0x1表示选择A，0x11表示选择AB）示例值：1
Count	Integer	答题人数示例值：1

AppConfig

应用配置信息

被如下接口引用：DescribeAppDetail。

名称	类型	描述
ApplicationId	String	应用ID 示例值：3571863
AppName	String	应用名称注意：此字段可能返回 null，表示取不到有效值。示例值：demo
State	Integer	应用状态 1正常 2停用注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppVersion	Integer	1试用 2轻量版 3标准版 4旗舰版注意：此字段可能返回 null，表示取不到有效值。示例值：2
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2024-01-19 15:58:21
Callback	String	回调注意：此字段可能返回 null，表示取不到有效值。示例值：http://callback.qcloud.com
CallbackKey	String	回调Key 注意：此字段可能返回 null，表示取不到有效值。示例值：nflhhtF0

AppCustomContent

应用自定义内容

被如下接口引用：SetAppCustomContent。

名称	类型	必选	描述
Scene	String	是	场景参数，一个应用下可以设置多个不同场景。示例值：abc
LogoUrl	String	否	logo地址，用于上课时展示的课堂或平台图标，支持开发商自定义业务品牌展示。示例值：abc
HomeUrl	String	否	HomeUrl：主页地址，用于上课结束后课堂跳转，支持跳转到自己的业务系统。如果配置为空则下课后关闭课堂页面。示例值：abc
JsUrl	String	否	JsUrl ：自定义js。针对应用用于开发上自定义课堂界面、模块功能、监控操作，支持数据请求与响应处理。示例值：abc
CssUrl	String	否	Css : 自定义的css。针对应用用于支持课堂界面的、模块的UI渲染修改、皮肤配色修改、功能模块的隐藏和展示。示例值：abc

BackgroundPictureConfig

背景图片配置

被如下接口引用：GetWatermark。

名称	类型	描述
Url	String	背景图片的url 注意：此字段可能返回 null，表示取不到有效值。示例值：url

BatchUserInfo

批量注册用户信息

被如下接口引用：BatchRegister。

名称	类型	描述
SdkAppId	Integer	低代码互动课堂的SdkAppId。示例值：123
UserId	String	用户ID。注意：此字段可能返回 null，表示取不到有效值。示例值：58HJKL908
OriginId	String	用户在客户系统的Id。若用户注册时该字段为空，则默认为 UserId 值一致。注意：此字段可能返回 null，表示取不到有效值。示例值：58Hlop908

BatchUserRequest

用户注册请求信息

被如下接口引用：BatchRegister。

名称	类型	必选	描述
SdkAppId	Integer	是	低代码互动课堂的SdkAppId。示例值：123
Name	String	否	用户名称。示例值：user123
OriginId	String	否	用户在客户系统的Id，需要在同一应用下唯一。入参为空时默认赋值为UserId 。示例值：user123
Avatar	String	否	用户头像。示例值：http://user.com？pic=123

ClassScoreItem

课堂评分字段

被如下接口引用：DescribeScoreList。

名称	类型	描述
RoomId	Integer	课堂iD 注意：此字段可能返回 null，表示取不到有效值。示例值：123456
UserId	String	用户ID 注意：此字段可能返回 null，表示取不到有效值。示例值：abc123
CreateTime	Integer	评分时间注意：此字段可能返回 null，表示取不到有效值。示例值：1704038400
Score	Integer	课堂评分注意：此字段可能返回 null，表示取不到有效值。示例值：100
ScoreMsg	String	课堂评价注意：此字段可能返回 null，表示取不到有效值。示例值：优秀

CustomMsgContent

自定义消息

被如下接口引用：GetRoomMessage, SendRoomNormalMessage。

名称	类型	必选	描述
Data	String	否	自定义消息数据。注意：此字段可能返回 null，表示取不到有效值。示例值：你好
Desc	String	否	自定义消息描述信息。注意：此字段可能返回 null，表示取不到有效值。示例值：自定义消息描述
Ext	String	否	扩展字段。注意：此字段可能返回 null，表示取不到有效值。示例值：CHAT

DocumentInfo

文档信息

被如下接口引用：BatchDescribeDocument, DescribeDocuments, DescribeDocumentsByRoom。

名称	类型	描述
DocumentId	String	文档Id 注意：此字段可能返回 null，表示取不到有效值。示例值：abc
DocumentUrl	String	文档原址url 注意：此字段可能返回 null，表示取不到有效值。示例值：abc
DocumentName	String	文档名称注意：此字段可能返回 null，表示取不到有效值。示例值：abc
Owner	String	文档所有者UserId 注意：此字段可能返回 null，表示取不到有效值。示例值：abc
SdkAppId	Integer	应用Id 注意：此字段可能返回 null，表示取不到有效值。示例值：123
Permission	Integer	文档权限，0：私有课件 1：公共课件注意：此字段可能返回 null，表示取不到有效值。示例值：1
TranscodeResult	String	转码结果，无需转码为空，转码成功为结果url，转码失败为错误码注意：此字段可能返回 null，表示取不到有效值。示例值：90890
TranscodeType	Integer	转码类型注意：此字段可能返回 null，表示取不到有效值。示例值：1
TranscodeProgress	Integer	转码进度， 0 - 100 表示（0% - 100%）注意：此字段可能返回 null，表示取不到有效值。示例值：1
TranscodeState	Integer	转码状态，0为无需转码，1为正在转码，2为转码失败，3为转码成功注意：此字段可能返回 null，表示取不到有效值。示例值：0
TranscodeInfo	String	转码失败后的错误信息注意：此字段可能返回 null，表示取不到有效值。示例值：9092
DocumentType	String	文档类型注意：此字段可能返回 null，表示取不到有效值。示例值：mp4
DocumentSize	Integer	文档大小，单位：字节注意：此字段可能返回 null，表示取不到有效值。示例值：1
UpdateTime	Integer	更新的UNIX时间戳注意：此字段可能返回 null，表示取不到有效值。示例值：1000
Pages	Integer	课件页数注意：此字段可能返回 null，表示取不到有效值。示例值：1
Width	Integer	宽，仅在静态转码的课件有效注意：此字段可能返回 null，表示取不到有效值。示例值：1
Height	Integer	高，仅在静态转码的课件有效注意：此字段可能返回 null，表示取不到有效值。示例值：1
Cover	String	封面，仅转码的课件会生成封面注意：此字段可能返回 null，表示取不到有效值。示例值：KPLowMp
Preview	String	课件预览地址注意：此字段可能返回 null，表示取不到有效值。示例值：abc
Resolution	String	文档的分辨率注意：此字段可能返回 null，表示取不到有效值。示例值：793x1122
MinScaleResolution	String	转码后文档的最小分辨率，和创建文档时传入的参数一致。注意：此字段可能返回 null，表示取不到有效值。示例值：1280x720

EventDataInfo

房间事件对应的信息。

被如下接口引用：GetRoomEvent。

名称	类型	描述
RoomId	Integer	事件发生的房间号。注意：此字段可能返回 null，表示取不到有效值。示例值：123456
UserId	String	事件发生的用户。注意：此字段可能返回 null，表示取不到有效值。示例值：test
Device	Integer	用户设备类型。0: Unknown; 1: Windows; 2: macOS; 3: Android; 4: iOS; 5: Web; 6: Mobile webpage; 7: Weixin Mini Program. 注意：此字段可能返回 null，表示取不到有效值。示例值：5
Duration	Integer	录制时长。单位：秒注意：此字段可能返回 null，表示取不到有效值。示例值：5
RecordSize	Integer	录制文件大小注意：此字段可能返回 null，表示取不到有效值。示例值：12334
RecordUrl	String	录制url 注意：此字段可能返回 null，表示取不到有效值。示例值：https://url/f0.mp4

EventInfo

房间事件信息。

被如下接口引用：GetRoomEvent。

名称	类型	描述
Timestamp	Integer	事件发生的秒级unix时间戳。示例值：123456
EventType	String	事件类型,有以下值: RoomStart:房间开始 RoomEnd:房间结束 MemberJoin:成员加入 MemberQuit:成员退出 RecordFinish:录制结束 CameraOn: 摄像头打开 CameraOff: 摄像头关闭 MicOn: 麦克风打开 MicOff: 麦克风关闭 ScreenOn: 屏幕共享打开 ScreenOff: 屏幕共享关闭 VisibleOn: 页面可见 VisibleOff: 页面不可见示例值：RoomStart
EventData	EventDataInfo	事件详细内容，包含房间号,成员类型事件包含用户Id。注意：此字段可能返回 null，表示取不到有效值。示例值：{"RoomId":1234}

FaceMsgContent

表情消息

被如下接口引用：SendRoomNormalMessage。

名称	类型	必选	描述
Index	Integer	是	表情索引，用户自定义。示例值：1
Data	String	否	额外数据。示例值："face"

GroupBaseInfo

批量创建群组基础信息

被如下接口引用：BatchCreateGroupWithMembers。

名称	类型	必选	描述
GroupName	String	是	待创建群组名示例值：test
TeacherId	String	否	群组主讲人ID 示例值：abc

GroupInfo

获取群组列表返回的群组信息

被如下接口引用：DescribeGroupList。

名称	类型	描述
GroupId	String	群组ID 注意：此字段可能返回 null，表示取不到有效值。示例值：fdghdhdfh
GroupName	String	群组名称注意：此字段可能返回 null，表示取不到有效值。示例值：test
TeacherId	String	群组主讲人ID 注意：此字段可能返回 null，表示取不到有效值。示例值：abc
GroupType	Integer	群组类型 0-基础群组 1-组合群组，若为1时会返回子群组ID列表注意：此字段可能返回 null，表示取不到有效值。示例值：群组类型
SubGroupIds	String	子群组ID列表，如有。注意：此字段可能返回 null，表示取不到有效值。示例值：23423,1212

ImageInfo

单张图片信息

被如下接口引用：SendRoomNormalMessage。

名称	类型	必选	描述
Type	Integer	是	图片类型： 1-原图 2-大图 3-缩略图示例值：2
Size	Integer	是	图片数据大小，单位：字节。示例值：1024
Width	Integer	是	图片宽度，单位为像素。示例值：2448
Height	Integer	是	图片高度，单位为像素。示例值：3264
URL	String	是	图片下载地址。示例值：http://xxx/3200490432214177468_144115198371610486_D61040894AC3DE44CDFFFB3EC7EB720F/198

ImageMsgContent

图片消息

被如下接口引用：SendRoomNormalMessage。

名称	类型	必选	描述
UUID	String	是	图片的唯一标识，客户端用于索引图片的键值。示例值：1853095_D61040894AC3DE44CDFFFB3EC7EB720F
ImageFormat	Integer	是	图片格式。 JPG = 1 GIF = 2 PNG = 3 BMP = 4 其他 = 255 示例值：3
ImageInfoList	Array of ImageInfo	是	图片信息

MemberRecord

成员记录信息。

被如下接口引用：DescribeCurrentMemberList, DescribeRoomStatistics。

名称	类型	描述
UserId	String	用户ID。示例值：abc
UserName	String	用户名称。示例值：abc
PresentTime	Integer	在线时长，单位秒。示例值：1
Camera	Integer	是否开启摄像头。示例值：1
Mic	Integer	是否开启麦克风。示例值：1
Silence	Integer	是否禁言。示例值：1
AnswerQuestions	Integer	回答问题数量。示例值：1
HandUps	Integer	举手数量。示例值：1
FirstJoinTimestamp	Integer	首次进入房间的unix时间戳。示例值：1234657
LastQuitTimestamp	Integer	最后一次退出房间的unix时间戳。示例值：1234657
Rewords	Integer	奖励次数。示例值：1
IPAddress	String	用户IP。示例值：1.1.1.1
Location	String	用户位置信息。示例值：城市(国家)
Device	Integer	用户设备平台信息。0:unknown 1:windows 2:mac 3:android 4:ios 5:web 6:h5 7:miniprogram （小程序）示例值：5
PerMemberMicCount	Integer	每个成员上麦次数。示例值：1
PerMemberMessageCount	Integer	每个成员发送消息数量。示例值：2
Role	Integer	用户角色。0代表学生；1代表老师； 2助教；3巡课。示例值：1
GroupId	String	上课班号示例值：abc
SubGroupId	Array of String	子上课班号注意：此字段可能返回 null，表示取不到有效值。示例值：['a','b']
Stage	Integer	用户的上台状态注意：此字段可能返回 null，表示取不到有效值。示例值：0
CurrentState	Integer	用户状态。0为未到，1为在线，2为离线，3为被踢，4为永久被踢，5为暂时掉线注意：此字段可能返回 null，表示取不到有效值。示例值：0

MessageItem

单条消息体内容

被如下接口引用：GetRoomMessage。

名称	类型	描述
MessageType	Integer	消息类型。0表示文本消息，1表示图片消息注意：此字段可能返回 null，表示取不到有效值。示例值：0
TextMessage	String	文本消息内容。message type为0时有效。注意：此字段可能返回 null，表示取不到有效值。示例值：text
ImageMessage	String	图片消息URL。 message type为1时有效。注意：此字段可能返回 null，表示取不到有效值。示例值：url
CustomMessage	CustomMsgContent	自定义消息内容。message type为2时有效。注意：此字段可能返回 null，表示取不到有效值。示例值：{"Data":"data","Desc":"custom_message","Ext":"CHAT"}

MessageList

历史消息列表

被如下接口引用：GetRoomMessage。

名称	类型	描述
Timestamp	Integer	消息时间戳注意：此字段可能返回 null，表示取不到有效值。示例值：1676879993
FromAccount	String	消息发送者注意：此字段可能返回 null，表示取不到有效值。示例值：Kbghad78
Seq	Integer	消息序列号，当前课堂内唯一且单调递增注意：此字段可能返回 null，表示取不到有效值。示例值：87650890
MessageBody	Array of MessageItem	历史消息列表注意：此字段可能返回 null，表示取不到有效值。

MsgBody

自定义消息结构

被如下接口引用：SendRoomNormalMessage。

名称	类型	必选	描述
MsgType	String	是	TIM 消息对象类型，目前支持的消息对象包括： TIMTextElem（文本消息） TIMFaceElem（表情消息） TIMImageElem（图像消息） TIMCustomElem（自定义消息）示例值：TIMImageElem
TextMsgContent	TextMsgContent	否	文本消息，当MsgType 为TIMTextElem（文本消息）必选。
FaceMsgContent	FaceMsgContent	否	表情消息，当MsgType 为TIMFaceElem（表情消息）必选。
ImageMsgContent	ImageMsgContent	否	图像消息，当MsgType为TIMImageElem（图像消息）必选。
CustomMsgContent	CustomMsgContent	否	自定义消息，TIMCustomElem（自定义消息）必选。

MutedAccountList

禁言用户信息数组，内容包括被禁言的成员 ID，及其被禁言到的时间（使用 UTC 时间，即世界协调时间）

被如下接口引用：DescribeRoomForbiddenUser。

名称	类型	描述
MemberAccount	String	用户 ID 注意：此字段可能返回 null，表示取不到有效值。示例值：2WqeRoOMJKQqnnL1lILRFHpdFla
MutedUntil	Integer	禁言到的时间（使用 UTC 时间，即世界协调时间）注意：此字段可能返回 null，表示取不到有效值。示例值：1458115189

QuestionInfo

房间问答问题详情

被如下接口引用：DescribeQuestionList。

名称	类型	描述
QuestionId	String	问题ID 示例值：a304828e-c109-436e-aada-59aec20b7aab
QuestionContent	String	问题内容示例值：测试题
Duration	Integer	倒计时答题设置的秒数（0 表示不计时）示例值：1
CorrectAnswer	Integer	正确答案（按照位表示是否选择，如0x1表示选择A，0x11表示选择AB）示例值：1
AnswerStats	Array of AnswerStat	每个选项答题人数统计注意：此字段可能返回 null，表示取不到有效值。

RoomInfo

批量创建房间的房间信息

被如下接口引用：BatchCreateRoom。

名称	类型	必选	描述
Name	String	是	房间名称。示例值：房间名称
StartTime	Integer	是	预定的房间开始时间，unix时间戳。示例值：1659600138
EndTime	Integer	是	预定的房间结束时间，unix时间戳。示例值：1659600138
Resolution	Integer	是	分辨率。可以有如下取值： 1 标清 2 高清 3 全高清示例值：1
MaxMicNumber	Integer	是	设置房间/课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。示例值：1
SubType	String	是	房间子类型，可以有以下取值： videodoc 文档+视频 video 纯视频示例值：videodoc
TeacherId	String	否	老师ID。通过[注册用户]接口获取的UserId。示例值：1jmPi2qddazF5PTgJtGYss9bg4T
AutoMic	Integer	否	进入课堂时是否自动连麦。可以有以下取值： 0 不自动连麦（需要手动申请上麦，默认值） 1 自动连麦示例值：1
TurnOffMic	Integer	否	释放音视频权限后是否自动取消连麦。可以有以下取值： 0 自动取消连麦（默认值） 1 保持连麦状态示例值：1
AudioQuality	Integer	否	高音质模式。可以有以下取值： 0 不开启高音质（默认值） 1 开启高音质示例值：1
DisableRecord	Integer	否	上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。示例值：1
Assistants	Array of String	否	助教Id列表。通过[注册用户]接口获取的UserId。示例值：[azsdasfsdfsd,asefawefew]
RTCAudienceNumber	Integer	否	rtc人数。示例值：1
AudienceType	Integer	否	观看类型。示例值：1
RecordLayout	Integer	否	录制布局。示例值：1
GroupId	String	否	房间绑定的群组ID 示例值：xfdfgdf
EnableDirectControl	Integer	否	打开学生麦克风/摄像头的授权开关示例值：0
InteractionMode	Integer	否	开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教示例值：0
VideoOrientation	Integer	否	横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型示例值：0
IsGradingRequiredPostClass	Integer	否	开启课后评分。 0：不开启(默认) 1：开启示例值：0
RoomType	Integer	否	房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展) 注：大班课的布局(layout)只有三分屏示例值：0
EndDelayTime	Integer	否	拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟示例值：0
LiveType	Integer	否	直播类型：0 常规（默认）1 伪直播示例值：0
RecordLiveUrl	String	否	伪直播回放链接示例值：https://1101910181.vod2.myqcloud.com/6casjaisjaidcq1101910181/d26589e12312512121842/f0.mp4
EnableAutoStart	Integer	否	是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效示例值：0
RecordBackground	String	否	录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道示例值：https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/desktop-02_219090_210001.png
RecordScene	String	否	录制自定义场景，仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。示例值：{"scene":"test","lng":"zh","type":"h5","subjectId":"57","customToken":"sajdlfjasdglweqirouoiu"}

RoomItem

房间列表

被如下接口引用：GetRooms。

名称	类型	描述
Name	String	名称注意：此字段可能返回 null，表示取不到有效值。示例值：room
RoomId	Integer	房间ID 注意：此字段可能返回 null，表示取不到有效值。示例值：12234
Status	Integer	房间状态。0 未开始；1进行中；2 已结束；3已过期注意：此字段可能返回 null，表示取不到有效值。示例值：0
StartTime	Integer	开始时间注意：此字段可能返回 null，表示取不到有效值。示例值：1708928949
EndTime	Integer	结束时间注意：此字段可能返回 null，表示取不到有效值。示例值：1708929949
RealStartTime	Integer	实际开始时间注意：此字段可能返回 null，表示取不到有效值。示例值：1708928949
RealEndTime	Integer	实际结束时间注意：此字段可能返回 null，表示取不到有效值。示例值：1708929949
Resolution	Integer	分辨率。1 标清 2 高清 3 全高清注意：此字段可能返回 null，表示取不到有效值。示例值：1
MaxRTCMember	Integer	最大允许连麦人数注意：此字段可能返回 null，表示取不到有效值。示例值：16
ReplayUrl	String	房间录制地址。已废弃，使用新字段 RecordUrl 注意：此字段可能返回 null，表示取不到有效值。示例值：http://class.qcloudclass.com?classId=123456
RecordUrl	String	录制地址（协议为https)。仅在房间结束后存在。注意：此字段可能返回 null，表示取不到有效值。示例值：https://class.qcloudclass.com?classId=123456
MaxMicNumber	Integer	最高房间内人数（不包括老师），0表示不限制，默认为0 注意：此字段可能返回 null，表示取不到有效值。示例值：16
EnableDirectControl	Integer	打开学生麦克风/摄像头的授权开关注意：此字段可能返回 null，表示取不到有效值。示例值：1
InteractionMode	Integer	开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教注意：此字段可能返回 null，表示取不到有效值。示例值：0
VideoOrientation	Integer	横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型注意：此字段可能返回 null，表示取不到有效值。示例值：0
IsGradingRequiredPostClass	Integer	开启课后评分。 0：不开启(默认) 1：开启注意：此字段可能返回 null，表示取不到有效值。示例值：0
RoomType	Integer	房间类型。0:小班课（默认值）；1:大班课；2:1V1（后续扩展）注：大班课的布局(layout)只有三分屏注意：此字段可能返回 null，表示取不到有效值。示例值：0
EndDelayTime	Integer	拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟注意：此字段可能返回 null，表示取不到有效值。示例值：0
LiveType	Integer	直播类型：0 常规（默认）1 伪直播注意：此字段可能返回 null，表示取不到有效值。示例值：0
RecordLiveUrl	String	伪直播回放链接注意：此字段可能返回 null，表示取不到有效值。示例值：https://class.qcloudclass.com?classId=123456
EnableAutoStart	Integer	是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效注意：此字段可能返回 null，表示取不到有效值。示例值：0
RecordBackground	String	录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道注意：此字段可能返回 null，表示取不到有效值。示例值：https://picture.com?picid=123456
RecordScene	String	录制自定义场景，仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。注意：此字段可能返回 null，表示取不到有效值。示例值：{"scene":"test","lng":"zh","type":"h5","subjectId":"57","customToken":"sajdlfjasdglweqioiu"}
RecordLang	String	录制自定义语言，仅recordlayout=9的时候此参数有效示例值：en

SceneItem

场景配置

被如下接口引用：DescribeAppDetail。

名称	类型	描述
Scene	String	场景名称示例值：default
LogoUrl	String	logo地址注意：此字段可能返回 null，表示取不到有效值。示例值：https://tcic-test-1257307760.file.myqcloud.com/customcontent/3571863/default_1709023088_default_1705651176_default.png
HomeUrl	String	主页地址注意：此字段可能返回 null，表示取不到有效值。示例值：https://de-class.qcloudtiw.com/login.html
JSUrl	String	自定义的js 注意：此字段可能返回 null，表示取不到有效值。示例值：https://1257307760.file.myqcloud.com/customcontent/2540731/test_1617001147_custom_new.js
CSSUrl	String	自定义的css 注意：此字段可能返回 null，表示取不到有效值。示例值：https://1257307760.file.myqcloud.com/customcontent/2261473/test_1611219710_custom.css

TextMarkConfig

文字水印配置

被如下接口引用：GetWatermark。

名称	类型	描述
Text	String	文字水印内容注意：此字段可能返回 null，表示取不到有效值。示例值：text
Color	String	文字水印颜色注意：此字段可能返回 null，表示取不到有效值。示例值：黑

TextMsgContent

文本消息

被如下接口引用：SendRoomNormalMessage。

名称	类型	必选	描述
Text	String	是	文本消息。示例值："你好"

TransferItem

转存配置

被如下接口引用：DescribeAppDetail。

名称	类型	描述
State	Integer	转存状态， 1正常 2停用注意：此字段可能返回 null，表示取不到有效值。示例值：1

UserInfo

用户信息结构体

被如下接口引用：DescribeSdkAppIdUsers。

名称	类型	描述
SdkAppId	Integer	应用Id。注意：此字段可能返回 null，表示取不到有效值。示例值：123456
UserId	String	用户Id。注意：此字段可能返回 null，表示取不到有效值。示例值：2CvDgjRNjylAsBZB4iZc0F6koXe
Name	String	用户昵称。注意：此字段可能返回 null，表示取不到有效值。示例值：abc
Avatar	String	用户头像Url。注意：此字段可能返回 null，表示取不到有效值。示例值：abc
OriginId	String	用户在客户系统的Id 注意：此字段可能返回 null，表示取不到有效值。示例值：2CvDgjRNjylAsBZB4iZc0F6koXe

WatermarkConfig

水印配置

被如下接口引用：GetWatermark。

名称	类型	描述
Url	String	水印图片的url 注意：此字段可能返回 null，表示取不到有效值。示例值：url
Width	Float	水印宽。为比例值注意：此字段可能返回 null，表示取不到有效值。示例值：0.5
Height	Float	水印高。为比例值注意：此字段可能返回 null，表示取不到有效值。示例值：0.5
LocationX	Float	水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间。注意：此字段可能返回 null，表示取不到有效值。示例值：50
LocationY	Float	水印Y偏移, 取值:0-100, 表示区域Y方向的百分比。比如50，则表示位于Y轴中间。注意：此字段可能返回 null，表示取不到有效值。示例值：50

上一篇: 指定用户给房间中发送消息下一篇: 错误码