v20220817

package
v1.0.939 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// CAM签名/鉴权错误。
	AUTHFAILURE = "AuthFailure"

	// DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
	DRYRUNOPERATION = "DryRunOperation"

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// 房间状态错误,房间已结束。
	FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"

	// 房间状态错误,房间已过期。
	FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"

	// 课堂状态错误,课堂已开始。
	FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"

	// 课堂时长不能超过5小时。
	FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"

	// 图片参数错误。
	FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"

	// 源账号已存在。
	FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"

	// 请求超时
	FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"

	// 房间暂未结束。
	FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"

	// 该成员已被添加到群组,请先在群组中删除该成员。
	FAILEDOPERATION_USERISALREADYINGROUP = "FailedOperation.UserIsAlreadyInGroup"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 内容包含非法信息(如色情,恐暴,政治等)。
	INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"

	// css/js地址无法访问
	INVALIDPARAMETER_CSSORJS = "InvalidParameter.CssOrJs"

	// 结束时间不能早于开始时间。
	INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"

	// 操作的群组成员超过限制
	INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"

	// 参数错误,主讲人与成员都为空
	INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"

	// 主讲人不能同时是群组成员
	INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"

	// 群组主讲老师不存在
	INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"

	// 群组类型错误
	INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"

	// room类型错误
	INVALIDPARAMETER_ROOMTYPEINVALID = "InvalidParameter.RoomTypeInvalid"

	// SdkAppId参数错误。
	INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

	// 开始时间不能早于当前时间。
	INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// 超过配额限制。
	LIMITEXCEEDED = "LimitExceeded"

	// 缺少参数错误。
	MISSINGPARAMETER = "MissingParameter"

	// 操作被拒绝。
	OPERATIONDENIED = "OperationDenied"

	// 地域错误
	REGIONERROR = "RegionError"

	// 请求的次数超过了频率限制。
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// 资源被占用。
	RESOURCEINUSE = "ResourceInUse"

	// 资源不足。
	RESOURCEINSUFFICIENT = "ResourceInsufficient"

	// 存储空间已无剩余,无法使用存储功能。
	RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"

	// 打开课堂失败,请前往控制台查看用量情况。
	RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"

	// 资源不存在。
	RESOURCENOTFOUND = "ResourceNotFound"

	// 文档不存在。
	RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

	// 群组不存在
	RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"

	// 用户ID不存在
	RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"

	// 房间不存在。
	RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

	// 用户不存在。
	RESOURCENOTFOUND_USER = "ResourceNotFound.User"

	// 资源不可用。
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// 房间统计结果计算中,请稍候。
	RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"

	// 资源售罄。
	RESOURCESSOLDOUT = "ResourcesSoldOut"

	// 未授权操作。
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// 未知参数错误。
	UNKNOWNPARAMETER = "UnknownParameter"

	// 操作不支持。
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source
const APIVersion = "2022-08-17"

Variables

This section is empty.

Functions

This section is empty.

Types

type AddGroupMemberRequest added in v1.0.597

type AddGroupMemberRequest struct {
	*tchttp.BaseRequest

	// 群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 成员列表,最大值200
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewAddGroupMemberRequest added in v1.0.597

func NewAddGroupMemberRequest() (request *AddGroupMemberRequest)

func (*AddGroupMemberRequest) FromJsonString added in v1.0.597

func (r *AddGroupMemberRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AddGroupMemberRequest) ToJsonString added in v1.0.597

func (r *AddGroupMemberRequest) ToJsonString() string

type AddGroupMemberRequestParams added in v1.0.597

type AddGroupMemberRequestParams struct {
	// 群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 成员列表,最大值200
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type AddGroupMemberResponse added in v1.0.597

type AddGroupMemberResponse struct {
	*tchttp.BaseResponse
	Response *AddGroupMemberResponseParams `json:"Response"`
}

func NewAddGroupMemberResponse added in v1.0.597

func NewAddGroupMemberResponse() (response *AddGroupMemberResponse)

func (*AddGroupMemberResponse) FromJsonString added in v1.0.597

func (r *AddGroupMemberResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AddGroupMemberResponse) ToJsonString added in v1.0.597

func (r *AddGroupMemberResponse) ToJsonString() string

type AddGroupMemberResponseParams added in v1.0.597

type AddGroupMemberResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type AnswerInfo added in v1.0.629

type AnswerInfo struct {
	// 用户名
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 答案(按照位表示是否选择,如0x1表示选择A,0x11表示选择AB)
	Answer *uint64 `json:"Answer,omitnil,omitempty" name:"Answer"`

	// 答题用时
	CostTime *uint64 `json:"CostTime,omitnil,omitempty" name:"CostTime"`

	// 用户ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 答案是否正确(1正确0错误)
	IsCorrect *uint64 `json:"IsCorrect,omitnil,omitempty" name:"IsCorrect"`
}

type AnswerStat added in v1.0.629

type AnswerStat struct {
	// 选项(按照位表示是否选择,如0x1表示选择A,0x11表示选择AB)
	Answer *int64 `json:"Answer,omitnil,omitempty" name:"Answer"`

	// 答题人数
	Count *int64 `json:"Count,omitnil,omitempty" name:"Count"`
}

type AppConfig added in v1.0.580

type AppConfig struct {
	// 应用ID
	ApplicationId *string `json:"ApplicationId,omitnil,omitempty" name:"ApplicationId"`

	// 应用名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 应用状态 1正常 2停用
	// 注意:此字段可能返回 null,表示取不到有效值。
	State *int64 `json:"State,omitnil,omitempty" name:"State"`

	// 1试用 2轻量版 3标准版 4旗舰版
	// 注意:此字段可能返回 null,表示取不到有效值。
	AppVersion *int64 `json:"AppVersion,omitnil,omitempty" name:"AppVersion"`

	// 创建时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedAt *string `json:"CreatedAt,omitnil,omitempty" name:"CreatedAt"`

	// 回调
	// 注意:此字段可能返回 null,表示取不到有效值。
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// 回调Key
	// 注意:此字段可能返回 null,表示取不到有效值。
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`
}

type AppCustomContent added in v1.0.514

type AppCustomContent struct {
	// 场景参数,一个应用下可以设置多个不同场景。
	Scene *string `json:"Scene,omitnil,omitempty" name:"Scene"`

	// logo地址,用于上课时展示的课堂或平台图标,支持开发商自定义业务品牌展示。
	LogoUrl *string `json:"LogoUrl,omitnil,omitempty" name:"LogoUrl"`

	// HomeUrl:主页地址,用于上课结束后课堂跳转,支持跳转到自己的业务系统。如果配置为空则下课后关闭课堂页面。
	HomeUrl *string `json:"HomeUrl,omitnil,omitempty" name:"HomeUrl"`

	// JsUrl :自定义js。针对应用用于开发上自定义课堂界面、模块功能、监控操作,支持数据请求与响应处理。
	JsUrl *string `json:"JsUrl,omitnil,omitempty" name:"JsUrl"`

	// Css : 自定义的css。针对应用用于支持课堂界面的、模块的UI渲染修改、皮肤配色修改、功能模块的隐藏和展示。
	CssUrl *string `json:"CssUrl,omitnil,omitempty" name:"CssUrl"`
}

type BackgroundPictureConfig added in v1.0.591

type BackgroundPictureConfig struct {
	// 背景图片的url
	// 注意:此字段可能返回 null,表示取不到有效值。
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`
}

type BatchAddGroupMemberRequest added in v1.0.597

type BatchAddGroupMemberRequest struct {
	*tchttp.BaseRequest

	// 待添加群组ID列表,最大值100
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 待添加成员列表,最大值200
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewBatchAddGroupMemberRequest added in v1.0.597

func NewBatchAddGroupMemberRequest() (request *BatchAddGroupMemberRequest)

func (*BatchAddGroupMemberRequest) FromJsonString added in v1.0.597

func (r *BatchAddGroupMemberRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchAddGroupMemberRequest) ToJsonString added in v1.0.597

func (r *BatchAddGroupMemberRequest) ToJsonString() string

type BatchAddGroupMemberRequestParams added in v1.0.597

type BatchAddGroupMemberRequestParams struct {
	// 待添加群组ID列表,最大值100
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 待添加成员列表,最大值200
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type BatchAddGroupMemberResponse added in v1.0.597

type BatchAddGroupMemberResponse struct {
	*tchttp.BaseResponse
	Response *BatchAddGroupMemberResponseParams `json:"Response"`
}

func NewBatchAddGroupMemberResponse added in v1.0.597

func NewBatchAddGroupMemberResponse() (response *BatchAddGroupMemberResponse)

func (*BatchAddGroupMemberResponse) FromJsonString added in v1.0.597

func (r *BatchAddGroupMemberResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchAddGroupMemberResponse) ToJsonString added in v1.0.597

func (r *BatchAddGroupMemberResponse) ToJsonString() string

type BatchAddGroupMemberResponseParams added in v1.0.597

type BatchAddGroupMemberResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchCreateGroupWithMembersRequest added in v1.0.597

type BatchCreateGroupWithMembersRequest struct {
	*tchttp.BaseRequest

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 批量创建群组基础信息,最大长度限制256
	GroupBaseInfos []*GroupBaseInfo `json:"GroupBaseInfos,omitnil,omitempty" name:"GroupBaseInfos"`

	// 群组绑定的成员列表,一次性最多200个
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewBatchCreateGroupWithMembersRequest added in v1.0.597

func NewBatchCreateGroupWithMembersRequest() (request *BatchCreateGroupWithMembersRequest)

func (*BatchCreateGroupWithMembersRequest) FromJsonString added in v1.0.597

func (r *BatchCreateGroupWithMembersRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateGroupWithMembersRequest) ToJsonString added in v1.0.597

func (r *BatchCreateGroupWithMembersRequest) ToJsonString() string

type BatchCreateGroupWithMembersRequestParams added in v1.0.597

type BatchCreateGroupWithMembersRequestParams struct {
	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 批量创建群组基础信息,最大长度限制256
	GroupBaseInfos []*GroupBaseInfo `json:"GroupBaseInfos,omitnil,omitempty" name:"GroupBaseInfos"`

	// 群组绑定的成员列表,一次性最多200个
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type BatchCreateGroupWithMembersResponse added in v1.0.597

type BatchCreateGroupWithMembersResponse struct {
	*tchttp.BaseResponse
	Response *BatchCreateGroupWithMembersResponseParams `json:"Response"`
}

func NewBatchCreateGroupWithMembersResponse added in v1.0.597

func NewBatchCreateGroupWithMembersResponse() (response *BatchCreateGroupWithMembersResponse)

func (*BatchCreateGroupWithMembersResponse) FromJsonString added in v1.0.597

func (r *BatchCreateGroupWithMembersResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateGroupWithMembersResponse) ToJsonString added in v1.0.597

func (r *BatchCreateGroupWithMembersResponse) ToJsonString() string

type BatchCreateGroupWithMembersResponseParams added in v1.0.597

type BatchCreateGroupWithMembersResponseParams struct {
	// 新创建群组ID列表,与输入创建参数顺序一致
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchCreateRoomRequest added in v1.0.591

type BatchCreateRoomRequest struct {
	*tchttp.BaseRequest

	// 低代码平台的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 创建房间ID列表
	RoomInfos []*RoomInfo `json:"RoomInfos,omitnil,omitempty" name:"RoomInfos"`
}

func NewBatchCreateRoomRequest added in v1.0.591

func NewBatchCreateRoomRequest() (request *BatchCreateRoomRequest)

func (*BatchCreateRoomRequest) FromJsonString added in v1.0.591

func (r *BatchCreateRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateRoomRequest) ToJsonString added in v1.0.591

func (r *BatchCreateRoomRequest) ToJsonString() string

type BatchCreateRoomRequestParams added in v1.0.591

type BatchCreateRoomRequestParams struct {
	// 低代码平台的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 创建房间ID列表
	RoomInfos []*RoomInfo `json:"RoomInfos,omitnil,omitempty" name:"RoomInfos"`
}

Predefined struct for user

type BatchCreateRoomResponse added in v1.0.591

type BatchCreateRoomResponse struct {
	*tchttp.BaseResponse
	Response *BatchCreateRoomResponseParams `json:"Response"`
}

func NewBatchCreateRoomResponse added in v1.0.591

func NewBatchCreateRoomResponse() (response *BatchCreateRoomResponse)

func (*BatchCreateRoomResponse) FromJsonString added in v1.0.591

func (r *BatchCreateRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateRoomResponse) ToJsonString added in v1.0.591

func (r *BatchCreateRoomResponse) ToJsonString() string

type BatchCreateRoomResponseParams added in v1.0.591

type BatchCreateRoomResponseParams struct {
	// 创建成功课堂ID,与传入课堂信息顺序一致
	RoomIds []*uint64 `json:"RoomIds,omitnil,omitempty" name:"RoomIds"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchDeleteGroupMemberRequest added in v1.0.597

type BatchDeleteGroupMemberRequest struct {
	*tchttp.BaseRequest

	// 待添加群组ID列表,最大值100
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 待添加成员列表,最大值256
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewBatchDeleteGroupMemberRequest added in v1.0.597

func NewBatchDeleteGroupMemberRequest() (request *BatchDeleteGroupMemberRequest)

func (*BatchDeleteGroupMemberRequest) FromJsonString added in v1.0.597

func (r *BatchDeleteGroupMemberRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDeleteGroupMemberRequest) ToJsonString added in v1.0.597

func (r *BatchDeleteGroupMemberRequest) ToJsonString() string

type BatchDeleteGroupMemberRequestParams added in v1.0.597

type BatchDeleteGroupMemberRequestParams struct {
	// 待添加群组ID列表,最大值100
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 待添加成员列表,最大值256
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type BatchDeleteGroupMemberResponse added in v1.0.597

type BatchDeleteGroupMemberResponse struct {
	*tchttp.BaseResponse
	Response *BatchDeleteGroupMemberResponseParams `json:"Response"`
}

func NewBatchDeleteGroupMemberResponse added in v1.0.597

func NewBatchDeleteGroupMemberResponse() (response *BatchDeleteGroupMemberResponse)

func (*BatchDeleteGroupMemberResponse) FromJsonString added in v1.0.597

func (r *BatchDeleteGroupMemberResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDeleteGroupMemberResponse) ToJsonString added in v1.0.597

func (r *BatchDeleteGroupMemberResponse) ToJsonString() string

type BatchDeleteGroupMemberResponseParams added in v1.0.597

type BatchDeleteGroupMemberResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchDeleteRecordRequest added in v1.0.591

type BatchDeleteRecordRequest struct {
	*tchttp.BaseRequest

	// 房间ID列表
	RoomIds []*int64 `json:"RoomIds,omitnil,omitempty" name:"RoomIds"`

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewBatchDeleteRecordRequest added in v1.0.591

func NewBatchDeleteRecordRequest() (request *BatchDeleteRecordRequest)

func (*BatchDeleteRecordRequest) FromJsonString added in v1.0.591

func (r *BatchDeleteRecordRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDeleteRecordRequest) ToJsonString added in v1.0.591

func (r *BatchDeleteRecordRequest) ToJsonString() string

type BatchDeleteRecordRequestParams added in v1.0.591

type BatchDeleteRecordRequestParams struct {
	// 房间ID列表
	RoomIds []*int64 `json:"RoomIds,omitnil,omitempty" name:"RoomIds"`

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type BatchDeleteRecordResponse added in v1.0.591

type BatchDeleteRecordResponse struct {
	*tchttp.BaseResponse
	Response *BatchDeleteRecordResponseParams `json:"Response"`
}

func NewBatchDeleteRecordResponse added in v1.0.591

func NewBatchDeleteRecordResponse() (response *BatchDeleteRecordResponse)

func (*BatchDeleteRecordResponse) FromJsonString added in v1.0.591

func (r *BatchDeleteRecordResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDeleteRecordResponse) ToJsonString added in v1.0.591

func (r *BatchDeleteRecordResponse) ToJsonString() string

type BatchDeleteRecordResponseParams added in v1.0.591

type BatchDeleteRecordResponseParams struct {
	// 本次操作删除成功的房间ID列表。如果入参列表中某个房间ID的录制文件已经删除,则出参列表中无对应的房间ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RoomIds []*int64 `json:"RoomIds,omitnil,omitempty" name:"RoomIds"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchDescribeDocumentRequest added in v1.0.644

type BatchDescribeDocumentRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页查询当前页数,从1开始递增
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大200
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 课件权限。[0]:获取owner的私有课件;[1]:获取owner的公开课件; [0,1]:则获取owner的私有课件和公开课件;[2]:获取owner的私有课件和所有人(包括owner)的公开课件
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 课件所有者的user_id,不填默认获取SdkAppId下所有课件
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 课件名称搜索词
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`

	// 课件id列表,从列表中查询,忽略错误的id
	DocumentId []*string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewBatchDescribeDocumentRequest added in v1.0.644

func NewBatchDescribeDocumentRequest() (request *BatchDescribeDocumentRequest)

func (*BatchDescribeDocumentRequest) FromJsonString added in v1.0.644

func (r *BatchDescribeDocumentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDescribeDocumentRequest) ToJsonString added in v1.0.644

func (r *BatchDescribeDocumentRequest) ToJsonString() string

type BatchDescribeDocumentRequestParams added in v1.0.644

type BatchDescribeDocumentRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页查询当前页数,从1开始递增
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大200
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 课件权限。[0]:获取owner的私有课件;[1]:获取owner的公开课件; [0,1]:则获取owner的私有课件和公开课件;[2]:获取owner的私有课件和所有人(包括owner)的公开课件
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 课件所有者的user_id,不填默认获取SdkAppId下所有课件
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 课件名称搜索词
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`

	// 课件id列表,从列表中查询,忽略错误的id
	DocumentId []*string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type BatchDescribeDocumentResponse added in v1.0.644

type BatchDescribeDocumentResponse struct {
	*tchttp.BaseResponse
	Response *BatchDescribeDocumentResponseParams `json:"Response"`
}

func NewBatchDescribeDocumentResponse added in v1.0.644

func NewBatchDescribeDocumentResponse() (response *BatchDescribeDocumentResponse)

func (*BatchDescribeDocumentResponse) FromJsonString added in v1.0.644

func (r *BatchDescribeDocumentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDescribeDocumentResponse) ToJsonString added in v1.0.644

func (r *BatchDescribeDocumentResponse) ToJsonString() string

type BatchDescribeDocumentResponseParams added in v1.0.644

type BatchDescribeDocumentResponseParams struct {
	// 符合查询条件文档总数
	Total *int64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 文档信息列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Documents []*DocumentInfo `json:"Documents,omitnil,omitempty" name:"Documents"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchRegisterRequest added in v1.0.586

type BatchRegisterRequest struct {
	*tchttp.BaseRequest

	// 批量注册用户信息列表
	Users []*BatchUserRequest `json:"Users,omitnil,omitempty" name:"Users"`
}

func NewBatchRegisterRequest added in v1.0.586

func NewBatchRegisterRequest() (request *BatchRegisterRequest)

func (*BatchRegisterRequest) FromJsonString added in v1.0.586

func (r *BatchRegisterRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchRegisterRequest) ToJsonString added in v1.0.586

func (r *BatchRegisterRequest) ToJsonString() string

type BatchRegisterRequestParams added in v1.0.586

type BatchRegisterRequestParams struct {
	// 批量注册用户信息列表
	Users []*BatchUserRequest `json:"Users,omitnil,omitempty" name:"Users"`
}

Predefined struct for user

type BatchRegisterResponse added in v1.0.586

type BatchRegisterResponse struct {
	*tchttp.BaseResponse
	Response *BatchRegisterResponseParams `json:"Response"`
}

func NewBatchRegisterResponse added in v1.0.586

func NewBatchRegisterResponse() (response *BatchRegisterResponse)

func (*BatchRegisterResponse) FromJsonString added in v1.0.586

func (r *BatchRegisterResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchRegisterResponse) ToJsonString added in v1.0.586

func (r *BatchRegisterResponse) ToJsonString() string

type BatchRegisterResponseParams added in v1.0.586

type BatchRegisterResponseParams struct {
	// 注册成功的用户列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Users []*BatchUserInfo `json:"Users,omitnil,omitempty" name:"Users"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchUserInfo added in v1.0.586

type BatchUserInfo struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 用户在客户系统的Id。 若用户注册时该字段为空,则默认为 UserId 值一致。
	// 注意:此字段可能返回 null,表示取不到有效值。
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`
}

type BatchUserRequest added in v1.0.586

type BatchUserRequest struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 用户在客户系统的Id,需要在同一应用下唯一。入参为空时默认赋值为UserId
	// 。
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`

	// 用户头像。
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

type BindDocumentToRoomRequest added in v1.0.517

type BindDocumentToRoomRequest struct {
	*tchttp.BaseRequest

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 文档ID。
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// 绑定类型。后台可透传到客户端,默认为0。客户端可以根据这个字段实现业务逻辑。
	BindType *uint64 `json:"BindType,omitnil,omitempty" name:"BindType"`
}

func NewBindDocumentToRoomRequest added in v1.0.517

func NewBindDocumentToRoomRequest() (request *BindDocumentToRoomRequest)

func (*BindDocumentToRoomRequest) FromJsonString added in v1.0.517

func (r *BindDocumentToRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindDocumentToRoomRequest) ToJsonString added in v1.0.517

func (r *BindDocumentToRoomRequest) ToJsonString() string

type BindDocumentToRoomRequestParams added in v1.0.517

type BindDocumentToRoomRequestParams struct {
	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 文档ID。
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// 绑定类型。后台可透传到客户端,默认为0。客户端可以根据这个字段实现业务逻辑。
	BindType *uint64 `json:"BindType,omitnil,omitempty" name:"BindType"`
}

Predefined struct for user

type BindDocumentToRoomResponse added in v1.0.517

type BindDocumentToRoomResponse struct {
	*tchttp.BaseResponse
	Response *BindDocumentToRoomResponseParams `json:"Response"`
}

func NewBindDocumentToRoomResponse added in v1.0.517

func NewBindDocumentToRoomResponse() (response *BindDocumentToRoomResponse)

func (*BindDocumentToRoomResponse) FromJsonString added in v1.0.517

func (r *BindDocumentToRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindDocumentToRoomResponse) ToJsonString added in v1.0.517

func (r *BindDocumentToRoomResponse) ToJsonString() string

type BindDocumentToRoomResponseParams added in v1.0.517

type BindDocumentToRoomResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ClassScoreItem added in v1.0.764

type ClassScoreItem struct {
	// 课堂iD
	// 注意:此字段可能返回 null,表示取不到有效值。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 用户ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 评分时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 课堂评分
	// 注意:此字段可能返回 null,表示取不到有效值。
	Score *uint64 `json:"Score,omitnil,omitempty" name:"Score"`

	// 课堂评价
	// 注意:此字段可能返回 null,表示取不到有效值。
	ScoreMsg *string `json:"ScoreMsg,omitnil,omitempty" name:"ScoreMsg"`
}

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) AddGroupMember added in v1.0.597

func (c *Client) AddGroupMember(request *AddGroupMemberRequest) (response *AddGroupMemberResponse, err error)

AddGroupMember 此接口用于添加成员列表到指定群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) AddGroupMemberWithContext added in v1.0.597

func (c *Client) AddGroupMemberWithContext(ctx context.Context, request *AddGroupMemberRequest) (response *AddGroupMemberResponse, err error)

AddGroupMember 此接口用于添加成员列表到指定群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchAddGroupMember added in v1.0.597

func (c *Client) BatchAddGroupMember(request *BatchAddGroupMemberRequest) (response *BatchAddGroupMemberResponse, err error)

BatchAddGroupMember 此接口用于批量添加成员列表到指定群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchAddGroupMemberWithContext added in v1.0.597

func (c *Client) BatchAddGroupMemberWithContext(ctx context.Context, request *BatchAddGroupMemberRequest) (response *BatchAddGroupMemberResponse, err error)

BatchAddGroupMember 此接口用于批量添加成员列表到指定群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchCreateGroupWithMembers added in v1.0.597

func (c *Client) BatchCreateGroupWithMembers(request *BatchCreateGroupWithMembersRequest) (response *BatchCreateGroupWithMembersResponse, err error)

BatchCreateGroupWithMembers 此接口用于批量创建群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchCreateGroupWithMembersWithContext added in v1.0.597

func (c *Client) BatchCreateGroupWithMembersWithContext(ctx context.Context, request *BatchCreateGroupWithMembersRequest) (response *BatchCreateGroupWithMembersResponse, err error)

BatchCreateGroupWithMembers 此接口用于批量创建群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchCreateRoom added in v1.0.591

func (c *Client) BatchCreateRoom(request *BatchCreateRoomRequest) (response *BatchCreateRoomResponse, err error)

BatchCreateRoom 批量创建房间接口

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchCreateRoomWithContext added in v1.0.591

func (c *Client) BatchCreateRoomWithContext(ctx context.Context, request *BatchCreateRoomRequest) (response *BatchCreateRoomResponse, err error)

BatchCreateRoom 批量创建房间接口

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchDeleteGroupMember added in v1.0.597

func (c *Client) BatchDeleteGroupMember(request *BatchDeleteGroupMemberRequest) (response *BatchDeleteGroupMemberResponse, err error)

BatchDeleteGroupMember 此接口用于批量删除成员列表到指定群组列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) BatchDeleteGroupMemberWithContext added in v1.0.597

func (c *Client) BatchDeleteGroupMemberWithContext(ctx context.Context, request *BatchDeleteGroupMemberRequest) (response *BatchDeleteGroupMemberResponse, err error)

BatchDeleteGroupMember 此接口用于批量删除成员列表到指定群组列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) BatchDeleteRecord added in v1.0.591

func (c *Client) BatchDeleteRecord(request *BatchDeleteRecordRequest) (response *BatchDeleteRecordResponse, err error)

BatchDeleteRecord 批量删除多个房间的录制文件

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) BatchDeleteRecordWithContext added in v1.0.591

func (c *Client) BatchDeleteRecordWithContext(ctx context.Context, request *BatchDeleteRecordRequest) (response *BatchDeleteRecordResponse, err error)

BatchDeleteRecord 批量删除多个房间的录制文件

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) BatchDescribeDocument added in v1.0.644

func (c *Client) BatchDescribeDocument(request *BatchDescribeDocumentRequest) (response *BatchDescribeDocumentResponse, err error)

BatchDescribeDocument 批量获取文档详情

可能返回的错误码:

INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) BatchDescribeDocumentWithContext added in v1.0.644

func (c *Client) BatchDescribeDocumentWithContext(ctx context.Context, request *BatchDescribeDocumentRequest) (response *BatchDescribeDocumentResponse, err error)

BatchDescribeDocument 批量获取文档详情

可能返回的错误码:

INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) BatchRegister added in v1.0.586

func (c *Client) BatchRegister(request *BatchRegisterRequest) (response *BatchRegisterResponse, err error)

BatchRegister 如果批量注册的用户已存在,则会被覆盖。一次最多注册1000个用户。默认请求频率限制:10次/秒

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) BatchRegisterWithContext added in v1.0.586

func (c *Client) BatchRegisterWithContext(ctx context.Context, request *BatchRegisterRequest) (response *BatchRegisterResponse, err error)

BatchRegister 如果批量注册的用户已存在,则会被覆盖。一次最多注册1000个用户。默认请求频率限制:10次/秒

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) BindDocumentToRoom added in v1.0.517

func (c *Client) BindDocumentToRoom(request *BindDocumentToRoomRequest) (response *BindDocumentToRoomResponse, err error)

BindDocumentToRoom 绑定文档到房间

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) BindDocumentToRoomWithContext added in v1.0.517

func (c *Client) BindDocumentToRoomWithContext(ctx context.Context, request *BindDocumentToRoomRequest) (response *BindDocumentToRoomResponse, err error)

BindDocumentToRoom 绑定文档到房间

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) CreateDocument added in v1.0.514

func (c *Client) CreateDocument(request *CreateDocumentRequest) (response *CreateDocumentResponse, err error)

CreateDocument 创建房间内可以使用的文档。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateDocumentWithContext added in v1.0.514

func (c *Client) CreateDocumentWithContext(ctx context.Context, request *CreateDocumentRequest) (response *CreateDocumentResponse, err error)

CreateDocument 创建房间内可以使用的文档。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateGroupWithMembers added in v1.0.597

func (c *Client) CreateGroupWithMembers(request *CreateGroupWithMembersRequest) (response *CreateGroupWithMembersResponse, err error)

CreateGroupWithMembers 此接口根据成员列表创建群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateGroupWithMembersWithContext added in v1.0.597

func (c *Client) CreateGroupWithMembersWithContext(ctx context.Context, request *CreateGroupWithMembersRequest) (response *CreateGroupWithMembersResponse, err error)

CreateGroupWithMembers 此接口根据成员列表创建群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateGroupWithSubGroup added in v1.0.597

func (c *Client) CreateGroupWithSubGroup(request *CreateGroupWithSubGroupRequest) (response *CreateGroupWithSubGroupResponse, err error)

CreateGroupWithSubGroup 此接口会聚合子群组创建联合群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateGroupWithSubGroupWithContext added in v1.0.597

func (c *Client) CreateGroupWithSubGroupWithContext(ctx context.Context, request *CreateGroupWithSubGroupRequest) (response *CreateGroupWithSubGroupResponse, err error)

CreateGroupWithSubGroup 此接口会聚合子群组创建联合群组

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateRoom

func (c *Client) CreateRoom(request *CreateRoomRequest) (response *CreateRoomResponse, err error)

CreateRoom 创建房间

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_ROOMTYPEINVALID = "InvalidParameter.RoomTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateRoomWithContext

func (c *Client) CreateRoomWithContext(ctx context.Context, request *CreateRoomRequest) (response *CreateRoomResponse, err error)

CreateRoom 创建房间

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_ROOMTYPEINVALID = "InvalidParameter.RoomTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateSupervisor

func (c *Client) CreateSupervisor(request *CreateSupervisorRequest) (response *CreateSupervisorResponse, err error)

CreateSupervisor 创建巡课

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateSupervisorWithContext

func (c *Client) CreateSupervisorWithContext(ctx context.Context, request *CreateSupervisorRequest) (response *CreateSupervisorResponse, err error)

CreateSupervisor 创建巡课

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) DeleteAppCustomContent added in v1.0.614

func (c *Client) DeleteAppCustomContent(request *DeleteAppCustomContentRequest) (response *DeleteAppCustomContentResponse, err error)

DeleteAppCustomContent 删除设置自定义元素。如果参数scenes为空则删除所有自定义元素,否则删除指定的scene自定义元素。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DeleteAppCustomContentWithContext added in v1.0.614

func (c *Client) DeleteAppCustomContentWithContext(ctx context.Context, request *DeleteAppCustomContentRequest) (response *DeleteAppCustomContentResponse, err error)

DeleteAppCustomContent 删除设置自定义元素。如果参数scenes为空则删除所有自定义元素,否则删除指定的scene自定义元素。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DeleteDocument added in v1.0.591

func (c *Client) DeleteDocument(request *DeleteDocumentRequest) (response *DeleteDocumentResponse, err error)

DeleteDocument 删除文档

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

func (*Client) DeleteDocumentWithContext added in v1.0.591

func (c *Client) DeleteDocumentWithContext(ctx context.Context, request *DeleteDocumentRequest) (response *DeleteDocumentResponse, err error)

DeleteDocument 删除文档

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

func (*Client) DeleteGroup added in v1.0.597

func (c *Client) DeleteGroup(request *DeleteGroupRequest) (response *DeleteGroupResponse, err error)

DeleteGroup 此接口用于删除指定群组,支持批量操作。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteGroupMember added in v1.0.597

func (c *Client) DeleteGroupMember(request *DeleteGroupMemberRequest) (response *DeleteGroupMemberResponse, err error)

DeleteGroupMember 此接口用于删除群组中指定成员

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DeleteGroupMemberWithContext added in v1.0.597

func (c *Client) DeleteGroupMemberWithContext(ctx context.Context, request *DeleteGroupMemberRequest) (response *DeleteGroupMemberResponse, err error)

DeleteGroupMember 此接口用于删除群组中指定成员

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DeleteGroupWithContext added in v1.0.597

func (c *Client) DeleteGroupWithContext(ctx context.Context, request *DeleteGroupRequest) (response *DeleteGroupResponse, err error)

DeleteGroup 此接口用于删除指定群组,支持批量操作。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteRecord added in v1.0.591

func (c *Client) DeleteRecord(request *DeleteRecordRequest) (response *DeleteRecordResponse, err error)

DeleteRecord 删除指定房间的录制文件

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteRecordWithContext added in v1.0.591

func (c *Client) DeleteRecordWithContext(ctx context.Context, request *DeleteRecordRequest) (response *DeleteRecordResponse, err error)

DeleteRecord 删除指定房间的录制文件

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteRoom added in v1.0.516

func (c *Client) DeleteRoom(request *DeleteRoomRequest) (response *DeleteRoomResponse, err error)

DeleteRoom 删除房间

可能返回的错误码:

FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DeleteRoomWithContext added in v1.0.516

func (c *Client) DeleteRoomWithContext(ctx context.Context, request *DeleteRoomRequest) (response *DeleteRoomResponse, err error)

DeleteRoom 删除房间

可能返回的错误码:

FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DeleteSupervisor added in v1.0.641

func (c *Client) DeleteSupervisor(request *DeleteSupervisorRequest) (response *DeleteSupervisorResponse, err error)

DeleteSupervisor 删除巡课

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) DeleteSupervisorWithContext added in v1.0.641

func (c *Client) DeleteSupervisorWithContext(ctx context.Context, request *DeleteSupervisorRequest) (response *DeleteSupervisorResponse, err error)

DeleteSupervisor 删除巡课

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) DeleteUser added in v1.0.726

func (c *Client) DeleteUser(request *DeleteUserRequest) (response *DeleteUserResponse, err error)

DeleteUser 删除已注册用户。注:如果该成员已被添加到群组,请先在群组中删除该成员。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
FAILEDOPERATION_USERISALREADYINGROUP = "FailedOperation.UserIsAlreadyInGroup"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_CSSORJS = "InvalidParameter.CssOrJs"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REGIONERROR = "RegionError"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteUserWithContext added in v1.0.726

func (c *Client) DeleteUserWithContext(ctx context.Context, request *DeleteUserRequest) (response *DeleteUserResponse, err error)

DeleteUser 删除已注册用户。注:如果该成员已被添加到群组,请先在群组中删除该成员。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
FAILEDOPERATION_USERISALREADYINGROUP = "FailedOperation.UserIsAlreadyInGroup"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_CSSORJS = "InvalidParameter.CssOrJs"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REGIONERROR = "RegionError"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAnswerList added in v1.0.629

func (c *Client) DescribeAnswerList(request *DescribeAnswerListRequest) (response *DescribeAnswerListResponse, err error)

DescribeAnswerList 获取房间答题详情

可能返回的错误码:

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAnswerListWithContext added in v1.0.629

func (c *Client) DescribeAnswerListWithContext(ctx context.Context, request *DescribeAnswerListRequest) (response *DescribeAnswerListResponse, err error)

DescribeAnswerList 获取房间答题详情

可能返回的错误码:

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAppDetail added in v1.0.579

func (c *Client) DescribeAppDetail(request *DescribeAppDetailRequest) (response *DescribeAppDetailResponse, err error)

DescribeAppDetail 获取应用详情

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DescribeAppDetailWithContext added in v1.0.579

func (c *Client) DescribeAppDetailWithContext(ctx context.Context, request *DescribeAppDetailRequest) (response *DescribeAppDetailResponse, err error)

DescribeAppDetail 获取应用详情

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DescribeCurrentMemberList added in v1.0.595

func (c *Client) DescribeCurrentMemberList(request *DescribeCurrentMemberListRequest) (response *DescribeCurrentMemberListResponse, err error)

DescribeCurrentMemberList 获取当前房间的成员列表,房间结束或过期后无法使用。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DescribeCurrentMemberListWithContext added in v1.0.595

func (c *Client) DescribeCurrentMemberListWithContext(ctx context.Context, request *DescribeCurrentMemberListRequest) (response *DescribeCurrentMemberListResponse, err error)

DescribeCurrentMemberList 获取当前房间的成员列表,房间结束或过期后无法使用。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DescribeDeveloper added in v1.0.622

func (c *Client) DescribeDeveloper(request *DescribeDeveloperRequest) (response *DescribeDeveloperResponse, err error)

DescribeDeveloper 开发商信息获取

可能返回的错误码:

FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDeveloperWithContext added in v1.0.622

func (c *Client) DescribeDeveloperWithContext(ctx context.Context, request *DescribeDeveloperRequest) (response *DescribeDeveloperResponse, err error)

DescribeDeveloper 开发商信息获取

可能返回的错误码:

FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDocument added in v1.0.591

func (c *Client) DescribeDocument(request *DescribeDocumentRequest) (response *DescribeDocumentResponse, err error)

DescribeDocument 获取文档信息

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

func (*Client) DescribeDocumentWithContext added in v1.0.591

func (c *Client) DescribeDocumentWithContext(ctx context.Context, request *DescribeDocumentRequest) (response *DescribeDocumentResponse, err error)

DescribeDocument 获取文档信息

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

func (*Client) DescribeDocuments added in v1.0.641

func (c *Client) DescribeDocuments(request *DescribeDocumentsRequest) (response *DescribeDocumentsResponse, err error)

DescribeDocuments 有新接口替换

批量获取文档信息(已废弃,替代接口BatchDescribeDocument)

可能返回的错误码:

INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeDocumentsByRoom added in v1.0.591

func (c *Client) DescribeDocumentsByRoom(request *DescribeDocumentsByRoomRequest) (response *DescribeDocumentsByRoomResponse, err error)

DescribeDocumentsByRoom 此接口获取指定房间下课件列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDocumentsByRoomWithContext added in v1.0.591

func (c *Client) DescribeDocumentsByRoomWithContext(ctx context.Context, request *DescribeDocumentsByRoomRequest) (response *DescribeDocumentsByRoomResponse, err error)

DescribeDocumentsByRoom 此接口获取指定房间下课件列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDocumentsWithContext added in v1.0.641

func (c *Client) DescribeDocumentsWithContext(ctx context.Context, request *DescribeDocumentsRequest) (response *DescribeDocumentsResponse, err error)

DescribeDocuments 有新接口替换

批量获取文档信息(已废弃,替代接口BatchDescribeDocument)

可能返回的错误码:

INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeGroup added in v1.0.597

func (c *Client) DescribeGroup(request *DescribeGroupRequest) (response *DescribeGroupResponse, err error)

DescribeGroup 此接口用于获取群组详情

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupList added in v1.0.597

func (c *Client) DescribeGroupList(request *DescribeGroupListRequest) (response *DescribeGroupListResponse, err error)

DescribeGroupList 获取群组列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupListWithContext added in v1.0.597

func (c *Client) DescribeGroupListWithContext(ctx context.Context, request *DescribeGroupListRequest) (response *DescribeGroupListResponse, err error)

DescribeGroupList 获取群组列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupMemberList added in v1.0.597

func (c *Client) DescribeGroupMemberList(request *DescribeGroupMemberListRequest) (response *DescribeGroupMemberListResponse, err error)

DescribeGroupMemberList 此接口用于获取群组成员列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupMemberListWithContext added in v1.0.597

func (c *Client) DescribeGroupMemberListWithContext(ctx context.Context, request *DescribeGroupMemberListRequest) (response *DescribeGroupMemberListResponse, err error)

DescribeGroupMemberList 此接口用于获取群组成员列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupWithContext added in v1.0.597

func (c *Client) DescribeGroupWithContext(ctx context.Context, request *DescribeGroupRequest) (response *DescribeGroupResponse, err error)

DescribeGroup 此接口用于获取群组详情

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeQuestionList added in v1.0.629

func (c *Client) DescribeQuestionList(request *DescribeQuestionListRequest) (response *DescribeQuestionListResponse, err error)

DescribeQuestionList 获取房间提问列表

可能返回的错误码:

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeQuestionListWithContext added in v1.0.629

func (c *Client) DescribeQuestionListWithContext(ctx context.Context, request *DescribeQuestionListRequest) (response *DescribeQuestionListResponse, err error)

DescribeQuestionList 获取房间提问列表

可能返回的错误码:

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeRoom

func (c *Client) DescribeRoom(request *DescribeRoomRequest) (response *DescribeRoomResponse, err error)

DescribeRoom 获取房间配置信息

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DescribeRoomForbiddenUser added in v1.0.787

func (c *Client) DescribeRoomForbiddenUser(request *DescribeRoomForbiddenUserRequest) (response *DescribeRoomForbiddenUserResponse, err error)

DescribeRoomForbiddenUser 根据房间ID获取群组中被禁言的用户列表。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRoomForbiddenUserWithContext added in v1.0.787

func (c *Client) DescribeRoomForbiddenUserWithContext(ctx context.Context, request *DescribeRoomForbiddenUserRequest) (response *DescribeRoomForbiddenUserResponse, err error)

DescribeRoomForbiddenUser 根据房间ID获取群组中被禁言的用户列表。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeRoomStatistics added in v1.0.517

func (c *Client) DescribeRoomStatistics(request *DescribeRoomStatisticsRequest) (response *DescribeRoomStatisticsResponse, err error)

DescribeRoomStatistics 获取房间统计信息,仅可在房间结束后调用。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"

func (*Client) DescribeRoomStatisticsWithContext added in v1.0.517

func (c *Client) DescribeRoomStatisticsWithContext(ctx context.Context, request *DescribeRoomStatisticsRequest) (response *DescribeRoomStatisticsResponse, err error)

DescribeRoomStatistics 获取房间统计信息,仅可在房间结束后调用。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"

func (*Client) DescribeRoomWithContext

func (c *Client) DescribeRoomWithContext(ctx context.Context, request *DescribeRoomRequest) (response *DescribeRoomResponse, err error)

DescribeRoom 获取房间配置信息

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DescribeScoreList added in v1.0.764

func (c *Client) DescribeScoreList(request *DescribeScoreListRequest) (response *DescribeScoreListResponse, err error)

DescribeScoreList 获取课堂评分列表

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeScoreListWithContext added in v1.0.764

func (c *Client) DescribeScoreListWithContext(ctx context.Context, request *DescribeScoreListRequest) (response *DescribeScoreListResponse, err error)

DescribeScoreList 获取课堂评分列表

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSdkAppIdUsers added in v1.0.591

func (c *Client) DescribeSdkAppIdUsers(request *DescribeSdkAppIdUsersRequest) (response *DescribeSdkAppIdUsersResponse, err error)

DescribeSdkAppIdUsers 此接口用于获取指定应用ID下用户列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSdkAppIdUsersWithContext added in v1.0.591

func (c *Client) DescribeSdkAppIdUsersWithContext(ctx context.Context, request *DescribeSdkAppIdUsersRequest) (response *DescribeSdkAppIdUsersResponse, err error)

DescribeSdkAppIdUsers 此接口用于获取指定应用ID下用户列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSupervisors added in v1.0.629

func (c *Client) DescribeSupervisors(request *DescribeSupervisorsRequest) (response *DescribeSupervisorsResponse, err error)

DescribeSupervisors 获取巡课列表

可能返回的错误码:

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSupervisorsWithContext added in v1.0.629

func (c *Client) DescribeSupervisorsWithContext(ctx context.Context, request *DescribeSupervisorsRequest) (response *DescribeSupervisorsResponse, err error)

DescribeSupervisors 获取巡课列表

可能返回的错误码:

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeUser

func (c *Client) DescribeUser(request *DescribeUserRequest) (response *DescribeUserResponse, err error)

DescribeUser 获取用户信息

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) DescribeUserWithContext

func (c *Client) DescribeUserWithContext(ctx context.Context, request *DescribeUserRequest) (response *DescribeUserResponse, err error)

DescribeUser 获取用户信息

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) EndRoom added in v1.0.641

func (c *Client) EndRoom(request *EndRoomRequest) (response *EndRoomResponse, err error)

EndRoom 结束房间的直播

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) EndRoomWithContext added in v1.0.641

func (c *Client) EndRoomWithContext(ctx context.Context, request *EndRoomRequest) (response *EndRoomResponse, err error)

EndRoom 结束房间的直播

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ForbidSendMsg added in v1.0.787

func (c *Client) ForbidSendMsg(request *ForbidSendMsgRequest) (response *ForbidSendMsgResponse, err error)

ForbidSendMsg 禁止指定房间中某些用户在一段时间内发言。

取消对某些用户的禁言。

被禁言用户退出房间之后再进入同一房间,禁言仍然有效。

可能返回的错误码:

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) ForbidSendMsgWithContext added in v1.0.787

func (c *Client) ForbidSendMsgWithContext(ctx context.Context, request *ForbidSendMsgRequest) (response *ForbidSendMsgResponse, err error)

ForbidSendMsg 禁止指定房间中某些用户在一段时间内发言。

取消对某些用户的禁言。

被禁言用户退出房间之后再进入同一房间,禁言仍然有效。

可能返回的错误码:

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) GetRoomEvent added in v1.0.620

func (c *Client) GetRoomEvent(request *GetRoomEventRequest) (response *GetRoomEventResponse, err error)

GetRoomEvent 获取房间事件,仅在课堂结束1小时内有效。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) GetRoomEventWithContext added in v1.0.620

func (c *Client) GetRoomEventWithContext(ctx context.Context, request *GetRoomEventRequest) (response *GetRoomEventResponse, err error)

GetRoomEvent 获取房间事件,仅在课堂结束1小时内有效。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) GetRoomMessage added in v1.0.604

func (c *Client) GetRoomMessage(request *GetRoomMessageRequest) (response *GetRoomMessageResponse, err error)

GetRoomMessage 获取房间历史消息(房间历史消息保存7天)

可能返回的错误码:

FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetRoomMessageWithContext added in v1.0.604

func (c *Client) GetRoomMessageWithContext(ctx context.Context, request *GetRoomMessageRequest) (response *GetRoomMessageResponse, err error)

GetRoomMessage 获取房间历史消息(房间历史消息保存7天)

可能返回的错误码:

FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetRooms added in v1.0.634

func (c *Client) GetRooms(request *GetRoomsRequest) (response *GetRoomsResponse, err error)

GetRooms 获取房间列表

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetRoomsWithContext added in v1.0.634

func (c *Client) GetRoomsWithContext(ctx context.Context, request *GetRoomsRequest) (response *GetRoomsResponse, err error)

GetRooms 获取房间列表

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetWatermark added in v1.0.591

func (c *Client) GetWatermark(request *GetWatermarkRequest) (response *GetWatermarkResponse, err error)

GetWatermark 获取水印设置

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) GetWatermarkWithContext added in v1.0.591

func (c *Client) GetWatermarkWithContext(ctx context.Context, request *GetWatermarkRequest) (response *GetWatermarkResponse, err error)

GetWatermark 获取水印设置

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) KickUserFromRoom added in v1.0.657

func (c *Client) KickUserFromRoom(request *KickUserFromRoomRequest) (response *KickUserFromRoomResponse, err error)

KickUserFromRoom 从房间里面踢出用户

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) KickUserFromRoomWithContext added in v1.0.657

func (c *Client) KickUserFromRoomWithContext(ctx context.Context, request *KickUserFromRoomRequest) (response *KickUserFromRoomResponse, err error)

KickUserFromRoom 从房间里面踢出用户

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) LoginOriginId

func (c *Client) LoginOriginId(request *LoginOriginIdRequest) (response *LoginOriginIdResponse, err error)

LoginOriginId 使用源账号登录,源账号为注册时填入的originId

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) LoginOriginIdWithContext

func (c *Client) LoginOriginIdWithContext(ctx context.Context, request *LoginOriginIdRequest) (response *LoginOriginIdResponse, err error)

LoginOriginId 使用源账号登录,源账号为注册时填入的originId

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) LoginUser

func (c *Client) LoginUser(request *LoginUserRequest) (response *LoginUserResponse, err error)

LoginUser 登录

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) LoginUserWithContext

func (c *Client) LoginUserWithContext(ctx context.Context, request *LoginUserRequest) (response *LoginUserResponse, err error)

LoginUser 登录

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) ModifyApp added in v1.0.517

func (c *Client) ModifyApp(request *ModifyAppRequest) (response *ModifyAppResponse, err error)

ModifyApp 修改应用

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) ModifyAppWithContext added in v1.0.517

func (c *Client) ModifyAppWithContext(ctx context.Context, request *ModifyAppRequest) (response *ModifyAppResponse, err error)

ModifyApp 修改应用

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) ModifyGroup added in v1.0.597

func (c *Client) ModifyGroup(request *ModifyGroupRequest) (response *ModifyGroupResponse, err error)

ModifyGroup 此接口修改群组信息

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyGroupWithContext added in v1.0.597

func (c *Client) ModifyGroupWithContext(ctx context.Context, request *ModifyGroupRequest) (response *ModifyGroupResponse, err error)

ModifyGroup 此接口修改群组信息

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyRoom added in v1.0.586

func (c *Client) ModifyRoom(request *ModifyRoomRequest) (response *ModifyRoomResponse, err error)

ModifyRoom 修改房间

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) ModifyRoomWithContext added in v1.0.586

func (c *Client) ModifyRoomWithContext(ctx context.Context, request *ModifyRoomRequest) (response *ModifyRoomResponse, err error)

ModifyRoom 修改房间

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) ModifyUserProfile added in v1.0.591

func (c *Client) ModifyUserProfile(request *ModifyUserProfileRequest) (response *ModifyUserProfileResponse, err error)

ModifyUserProfile 此接口用于修改用户配置,如头像,昵称/用户名等。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyUserProfileWithContext added in v1.0.591

func (c *Client) ModifyUserProfileWithContext(ctx context.Context, request *ModifyUserProfileRequest) (response *ModifyUserProfileResponse, err error)

ModifyUserProfile 此接口用于修改用户配置,如头像,昵称/用户名等。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) RegisterUser

func (c *Client) RegisterUser(request *RegisterUserRequest) (response *RegisterUserResponse, err error)

RegisterUser 注册用户

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) RegisterUserWithContext

func (c *Client) RegisterUserWithContext(ctx context.Context, request *RegisterUserRequest) (response *RegisterUserResponse, err error)

RegisterUser 注册用户

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) SendRoomNormalMessage added in v1.0.769

func (c *Client) SendRoomNormalMessage(request *SendRoomNormalMessageRequest) (response *SendRoomNormalMessageResponse, err error)

SendRoomNormalMessage 1、按照指定身份发送消息,目前支持表情消息、图片消息、文本消息。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) SendRoomNormalMessageWithContext added in v1.0.769

func (c *Client) SendRoomNormalMessageWithContext(ctx context.Context, request *SendRoomNormalMessageRequest) (response *SendRoomNormalMessageResponse, err error)

SendRoomNormalMessage 1、按照指定身份发送消息,目前支持表情消息、图片消息、文本消息。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) SendRoomNotificationMessage added in v1.0.769

func (c *Client) SendRoomNotificationMessage(request *SendRoomNotificationMessageRequest) (response *SendRoomNotificationMessageResponse, err error)

SendRoomNotificationMessage App 管理员可以通过该接口在群组中发送通知、公告等。目前仅支持文本消息。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) SendRoomNotificationMessageWithContext added in v1.0.769

func (c *Client) SendRoomNotificationMessageWithContext(ctx context.Context, request *SendRoomNotificationMessageRequest) (response *SendRoomNotificationMessageResponse, err error)

SendRoomNotificationMessage App 管理员可以通过该接口在群组中发送通知、公告等。目前仅支持文本消息。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) SetAppCustomContent added in v1.0.514

func (c *Client) SetAppCustomContent(request *SetAppCustomContentRequest) (response *SetAppCustomContentResponse, err error)

SetAppCustomContent 设置应用的自定义内容,包括应用图标,自定义的代码等。如果已存在,则为更新。更新js、css内容后,要生效也需要调用该接口

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CSSORJS = "InvalidParameter.CssOrJs"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) SetAppCustomContentWithContext added in v1.0.514

func (c *Client) SetAppCustomContentWithContext(ctx context.Context, request *SetAppCustomContentRequest) (response *SetAppCustomContentResponse, err error)

SetAppCustomContent 设置应用的自定义内容,包括应用图标,自定义的代码等。如果已存在,则为更新。更新js、css内容后,要生效也需要调用该接口

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CSSORJS = "InvalidParameter.CssOrJs"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) SetWatermark added in v1.0.591

func (c *Client) SetWatermark(request *SetWatermarkRequest) (response *SetWatermarkResponse, err error)

SetWatermark 设置水印

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) SetWatermarkWithContext added in v1.0.591

func (c *Client) SetWatermarkWithContext(ctx context.Context, request *SetWatermarkRequest) (response *SetWatermarkResponse, err error)

SetWatermark 设置水印

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) StartRoom added in v1.0.641

func (c *Client) StartRoom(request *StartRoomRequest) (response *StartRoomResponse, err error)

StartRoom 开始房间的直播。 说明:开始房间接口调用之前需要有用户进入课堂初始化课堂信息。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) StartRoomWithContext added in v1.0.641

func (c *Client) StartRoomWithContext(ctx context.Context, request *StartRoomRequest) (response *StartRoomResponse, err error)

StartRoom 开始房间的直播。 说明:开始房间接口调用之前需要有用户进入课堂初始化课堂信息。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UnbindDocumentFromRoom added in v1.0.517

func (c *Client) UnbindDocumentFromRoom(request *UnbindDocumentFromRoomRequest) (response *UnbindDocumentFromRoomResponse, err error)

UnbindDocumentFromRoom 文档从房间解绑

可能返回的错误码:

RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) UnbindDocumentFromRoomWithContext added in v1.0.517

func (c *Client) UnbindDocumentFromRoomWithContext(ctx context.Context, request *UnbindDocumentFromRoomRequest) (response *UnbindDocumentFromRoomResponse, err error)

UnbindDocumentFromRoom 文档从房间解绑

可能返回的错误码:

RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

type CreateDocumentRequest added in v1.0.514

type CreateDocumentRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 文档地址。
	DocumentUrl *string `json:"DocumentUrl,omitnil,omitempty" name:"DocumentUrl"`

	// 文档名称。
	DocumentName *string `json:"DocumentName,omitnil,omitempty" name:"DocumentName"`

	// 文档所有者的Id
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 转码类型,可以有如下取值:
	// 0 无需转码(默认),bmp,jpg,jpeg,png,gif
	// 1 需要转码的文档,ppt,pptx,pdf,doc,docx,xls,xlsx
	// 2 需要转码的视频,mp4,3pg,mpeg,avi,flv,wmv,rm,h264等
	// 2 需要转码的音频,mp3,wav,wma,aac,flac,opus
	TranscodeType *uint64 `json:"TranscodeType,omitnil,omitempty" name:"TranscodeType"`

	// 权限,可以有如下取值:
	// 0 私有文档(默认)
	// 1 公共文档
	Permission *uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 文档后缀名。
	DocumentType *string `json:"DocumentType,omitnil,omitempty" name:"DocumentType"`

	// 文档大小,单位 字节
	DocumentSize *uint64 `json:"DocumentSize,omitnil,omitempty" name:"DocumentSize"`

	// 是否对不支持元素开启自动处理的功能。默认关闭。
	// 自动处理的元素如下:
	// 1. 墨迹:移除不支持的墨迹(例如WPS墨迹)
	// 2. 自动翻页:移除PPT上所有自动翻页设置,并设置为单击鼠标翻页
	// 3. 已损坏音视频:移除PPT上对损坏音视频的引用
	AutoHandleUnsupportedElement *bool `json:"AutoHandleUnsupportedElement,omitnil,omitempty" name:"AutoHandleUnsupportedElement"`

	// 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
	MinScaleResolution *string `json:"MinScaleResolution,omitnil,omitempty" name:"MinScaleResolution"`
}

func NewCreateDocumentRequest added in v1.0.514

func NewCreateDocumentRequest() (request *CreateDocumentRequest)

func (*CreateDocumentRequest) FromJsonString added in v1.0.514

func (r *CreateDocumentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateDocumentRequest) ToJsonString added in v1.0.514

func (r *CreateDocumentRequest) ToJsonString() string

type CreateDocumentRequestParams added in v1.0.514

type CreateDocumentRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 文档地址。
	DocumentUrl *string `json:"DocumentUrl,omitnil,omitempty" name:"DocumentUrl"`

	// 文档名称。
	DocumentName *string `json:"DocumentName,omitnil,omitempty" name:"DocumentName"`

	// 文档所有者的Id
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 转码类型,可以有如下取值:
	// 0 无需转码(默认),bmp,jpg,jpeg,png,gif
	// 1 需要转码的文档,ppt,pptx,pdf,doc,docx,xls,xlsx
	// 2 需要转码的视频,mp4,3pg,mpeg,avi,flv,wmv,rm,h264等
	// 2 需要转码的音频,mp3,wav,wma,aac,flac,opus
	TranscodeType *uint64 `json:"TranscodeType,omitnil,omitempty" name:"TranscodeType"`

	// 权限,可以有如下取值:
	// 0 私有文档(默认)
	// 1 公共文档
	Permission *uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 文档后缀名。
	DocumentType *string `json:"DocumentType,omitnil,omitempty" name:"DocumentType"`

	// 文档大小,单位 字节
	DocumentSize *uint64 `json:"DocumentSize,omitnil,omitempty" name:"DocumentSize"`

	// 是否对不支持元素开启自动处理的功能。默认关闭。
	// 自动处理的元素如下:
	// 1. 墨迹:移除不支持的墨迹(例如WPS墨迹)
	// 2. 自动翻页:移除PPT上所有自动翻页设置,并设置为单击鼠标翻页
	// 3. 已损坏音视频:移除PPT上对损坏音视频的引用
	AutoHandleUnsupportedElement *bool `json:"AutoHandleUnsupportedElement,omitnil,omitempty" name:"AutoHandleUnsupportedElement"`

	// 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
	MinScaleResolution *string `json:"MinScaleResolution,omitnil,omitempty" name:"MinScaleResolution"`
}

Predefined struct for user

type CreateDocumentResponse added in v1.0.514

type CreateDocumentResponse struct {
	*tchttp.BaseResponse
	Response *CreateDocumentResponseParams `json:"Response"`
}

func NewCreateDocumentResponse added in v1.0.514

func NewCreateDocumentResponse() (response *CreateDocumentResponse)

func (*CreateDocumentResponse) FromJsonString added in v1.0.514

func (r *CreateDocumentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateDocumentResponse) ToJsonString added in v1.0.514

func (r *CreateDocumentResponse) ToJsonString() string

type CreateDocumentResponseParams added in v1.0.514

type CreateDocumentResponseParams struct {
	// 文档ID。
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateGroupWithMembersRequest added in v1.0.597

type CreateGroupWithMembersRequest struct {
	*tchttp.BaseRequest

	// 待创建群组名称
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 默认绑定主讲老师ID
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 群组成员列表,一次性最多200个
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewCreateGroupWithMembersRequest added in v1.0.597

func NewCreateGroupWithMembersRequest() (request *CreateGroupWithMembersRequest)

func (*CreateGroupWithMembersRequest) FromJsonString added in v1.0.597

func (r *CreateGroupWithMembersRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateGroupWithMembersRequest) ToJsonString added in v1.0.597

func (r *CreateGroupWithMembersRequest) ToJsonString() string

type CreateGroupWithMembersRequestParams added in v1.0.597

type CreateGroupWithMembersRequestParams struct {
	// 待创建群组名称
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 默认绑定主讲老师ID
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 群组成员列表,一次性最多200个
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type CreateGroupWithMembersResponse added in v1.0.597

type CreateGroupWithMembersResponse struct {
	*tchttp.BaseResponse
	Response *CreateGroupWithMembersResponseParams `json:"Response"`
}

func NewCreateGroupWithMembersResponse added in v1.0.597

func NewCreateGroupWithMembersResponse() (response *CreateGroupWithMembersResponse)

func (*CreateGroupWithMembersResponse) FromJsonString added in v1.0.597

func (r *CreateGroupWithMembersResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateGroupWithMembersResponse) ToJsonString added in v1.0.597

func (r *CreateGroupWithMembersResponse) ToJsonString() string

type CreateGroupWithMembersResponseParams added in v1.0.597

type CreateGroupWithMembersResponseParams struct {
	// 创建成功群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateGroupWithSubGroupRequest added in v1.0.597

type CreateGroupWithSubGroupRequest struct {
	*tchttp.BaseRequest

	// 待创建的新群组名
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 子群组ID列表,子群组ID不能重复,最多40个
	SubGroupIds []*string `json:"SubGroupIds,omitnil,omitempty" name:"SubGroupIds"`

	// 群组默认主讲老师ID
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`
}

func NewCreateGroupWithSubGroupRequest added in v1.0.597

func NewCreateGroupWithSubGroupRequest() (request *CreateGroupWithSubGroupRequest)

func (*CreateGroupWithSubGroupRequest) FromJsonString added in v1.0.597

func (r *CreateGroupWithSubGroupRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateGroupWithSubGroupRequest) ToJsonString added in v1.0.597

func (r *CreateGroupWithSubGroupRequest) ToJsonString() string

type CreateGroupWithSubGroupRequestParams added in v1.0.597

type CreateGroupWithSubGroupRequestParams struct {
	// 待创建的新群组名
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 子群组ID列表,子群组ID不能重复,最多40个
	SubGroupIds []*string `json:"SubGroupIds,omitnil,omitempty" name:"SubGroupIds"`

	// 群组默认主讲老师ID
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`
}

Predefined struct for user

type CreateGroupWithSubGroupResponse added in v1.0.597

type CreateGroupWithSubGroupResponse struct {
	*tchttp.BaseResponse
	Response *CreateGroupWithSubGroupResponseParams `json:"Response"`
}

func NewCreateGroupWithSubGroupResponse added in v1.0.597

func NewCreateGroupWithSubGroupResponse() (response *CreateGroupWithSubGroupResponse)

func (*CreateGroupWithSubGroupResponse) FromJsonString added in v1.0.597

func (r *CreateGroupWithSubGroupResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateGroupWithSubGroupResponse) ToJsonString added in v1.0.597

func (r *CreateGroupWithSubGroupResponse) ToJsonString() string

type CreateGroupWithSubGroupResponseParams added in v1.0.597

type CreateGroupWithSubGroupResponseParams struct {
	// 新创建群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateRoomRequest

type CreateRoomRequest struct {
	*tchttp.BaseRequest

	// 房间名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 预定的房间开始时间,unix时间戳(秒)。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 预定的房间结束时间,unix时间戳(秒)。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分辨率。可以有如下取值:
	// 1 标清
	// 2 高清
	// 3 全高清
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// 房间子类型,可以有以下取值:
	// videodoc 文档+视频
	// video 纯视频
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 进入课堂时是否自动连麦。可以有以下取值:
	// 0 不自动连麦(需要手动申请上麦,默认值)
	// 1 自动连麦
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// 释放音视频权限后是否自动取消连麦。可以有以下取值:
	// 0 自动取消连麦(默认值)
	// 1 保持连麦状态
	TurnOffMic *uint64 `json:"TurnOffMic,omitnil,omitempty" name:"TurnOffMic"`

	// 声音音质。可以有以下取值:
	// 0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。
	// 1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// 上课后是否禁止自动录制。可以有以下取值:
	// 0 不禁止录制(自动开启录制,默认值)
	// 1 禁止录制
	// 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// rtc人数。
	RTCAudienceNumber *uint64 `json:"RTCAudienceNumber,omitnil,omitempty" name:"RTCAudienceNumber"`

	// 观看类型。互动观看 (默认)
	AudienceType *uint64 `json:"AudienceType,omitnil,omitempty" name:"AudienceType"`

	// 录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
	RecordLayout *uint64 `json:"RecordLayout,omitnil,omitempty" name:"RecordLayout"`

	// 房间绑定的群组ID,非空时限制组成员进入
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值:
	// 0 不允许直接控制(需同意,默认值)
	// 1 允许直接控制(无需同意)
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// 开启专注模式。
	// 0 收看全部角色音视频(默认)
	// 1 只看老师和助教
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
	VideoOrientation *uint64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// 开启课后评分。 0:不开启(默认)  1:开启
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放)
	// 注:大班课的布局(layout)只有三分屏
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// 直播类型:0 常规(默认)1 伪直播
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// 伪直播链接
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// 录制自定义场景,仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// 录制自定义语言,仅recordlayout=9的时候此参数有效
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

func NewCreateRoomRequest

func NewCreateRoomRequest() (request *CreateRoomRequest)

func (*CreateRoomRequest) FromJsonString

func (r *CreateRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateRoomRequest) ToJsonString

func (r *CreateRoomRequest) ToJsonString() string

type CreateRoomRequestParams

type CreateRoomRequestParams struct {
	// 房间名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 预定的房间开始时间,unix时间戳(秒)。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 预定的房间结束时间,unix时间戳(秒)。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分辨率。可以有如下取值:
	// 1 标清
	// 2 高清
	// 3 全高清
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// 房间子类型,可以有以下取值:
	// videodoc 文档+视频
	// video 纯视频
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 进入课堂时是否自动连麦。可以有以下取值:
	// 0 不自动连麦(需要手动申请上麦,默认值)
	// 1 自动连麦
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// 释放音视频权限后是否自动取消连麦。可以有以下取值:
	// 0 自动取消连麦(默认值)
	// 1 保持连麦状态
	TurnOffMic *uint64 `json:"TurnOffMic,omitnil,omitempty" name:"TurnOffMic"`

	// 声音音质。可以有以下取值:
	// 0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。
	// 1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// 上课后是否禁止自动录制。可以有以下取值:
	// 0 不禁止录制(自动开启录制,默认值)
	// 1 禁止录制
	// 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// rtc人数。
	RTCAudienceNumber *uint64 `json:"RTCAudienceNumber,omitnil,omitempty" name:"RTCAudienceNumber"`

	// 观看类型。互动观看 (默认)
	AudienceType *uint64 `json:"AudienceType,omitnil,omitempty" name:"AudienceType"`

	// 录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
	RecordLayout *uint64 `json:"RecordLayout,omitnil,omitempty" name:"RecordLayout"`

	// 房间绑定的群组ID,非空时限制组成员进入
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值:
	// 0 不允许直接控制(需同意,默认值)
	// 1 允许直接控制(无需同意)
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// 开启专注模式。
	// 0 收看全部角色音视频(默认)
	// 1 只看老师和助教
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
	VideoOrientation *uint64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// 开启课后评分。 0:不开启(默认)  1:开启
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放)
	// 注:大班课的布局(layout)只有三分屏
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// 直播类型:0 常规(默认)1 伪直播
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// 伪直播链接
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// 录制自定义场景,仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// 录制自定义语言,仅recordlayout=9的时候此参数有效
	//
	// Deprecated: RecordLang is deprecated.
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

Predefined struct for user

type CreateRoomResponse

type CreateRoomResponse struct {
	*tchttp.BaseResponse
	Response *CreateRoomResponseParams `json:"Response"`
}

func NewCreateRoomResponse

func NewCreateRoomResponse() (response *CreateRoomResponse)

func (*CreateRoomResponse) FromJsonString

func (r *CreateRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateRoomResponse) ToJsonString

func (r *CreateRoomResponse) ToJsonString() string

type CreateRoomResponseParams

type CreateRoomResponseParams struct {
	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateSupervisorRequest

type CreateSupervisorRequest struct {
	*tchttp.BaseRequest

	// 应用ID。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户ID列表。
	Users []*string `json:"Users,omitnil,omitempty" name:"Users"`
}

func NewCreateSupervisorRequest

func NewCreateSupervisorRequest() (request *CreateSupervisorRequest)

func (*CreateSupervisorRequest) FromJsonString

func (r *CreateSupervisorRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSupervisorRequest) ToJsonString

func (r *CreateSupervisorRequest) ToJsonString() string

type CreateSupervisorRequestParams

type CreateSupervisorRequestParams struct {
	// 应用ID。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户ID列表。
	Users []*string `json:"Users,omitnil,omitempty" name:"Users"`
}

Predefined struct for user

type CreateSupervisorResponse

type CreateSupervisorResponse struct {
	*tchttp.BaseResponse
	Response *CreateSupervisorResponseParams `json:"Response"`
}

func NewCreateSupervisorResponse

func NewCreateSupervisorResponse() (response *CreateSupervisorResponse)

func (*CreateSupervisorResponse) FromJsonString

func (r *CreateSupervisorResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSupervisorResponse) ToJsonString

func (r *CreateSupervisorResponse) ToJsonString() string

type CreateSupervisorResponseParams

type CreateSupervisorResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CustomMsgContent added in v1.0.889

type CustomMsgContent struct {
	// 自定义消息数据。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Data *string `json:"Data,omitnil,omitempty" name:"Data"`

	// 自定义消息描述信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"`

	// 扩展字段。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Ext *string `json:"Ext,omitnil,omitempty" name:"Ext"`
}

type DeleteAppCustomContentRequest added in v1.0.614

type DeleteAppCustomContentRequest struct {
	*tchttp.BaseRequest

	// 应用ID。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 指定需要删除的已设置的scene场景自定义元素,如果为空则删除应用下已设置的所有自定义元素。
	Scenes []*string `json:"Scenes,omitnil,omitempty" name:"Scenes"`
}

func NewDeleteAppCustomContentRequest added in v1.0.614

func NewDeleteAppCustomContentRequest() (request *DeleteAppCustomContentRequest)

func (*DeleteAppCustomContentRequest) FromJsonString added in v1.0.614

func (r *DeleteAppCustomContentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteAppCustomContentRequest) ToJsonString added in v1.0.614

func (r *DeleteAppCustomContentRequest) ToJsonString() string

type DeleteAppCustomContentRequestParams added in v1.0.614

type DeleteAppCustomContentRequestParams struct {
	// 应用ID。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 指定需要删除的已设置的scene场景自定义元素,如果为空则删除应用下已设置的所有自定义元素。
	Scenes []*string `json:"Scenes,omitnil,omitempty" name:"Scenes"`
}

Predefined struct for user

type DeleteAppCustomContentResponse added in v1.0.614

type DeleteAppCustomContentResponse struct {
	*tchttp.BaseResponse
	Response *DeleteAppCustomContentResponseParams `json:"Response"`
}

func NewDeleteAppCustomContentResponse added in v1.0.614

func NewDeleteAppCustomContentResponse() (response *DeleteAppCustomContentResponse)

func (*DeleteAppCustomContentResponse) FromJsonString added in v1.0.614

func (r *DeleteAppCustomContentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteAppCustomContentResponse) ToJsonString added in v1.0.614

func (r *DeleteAppCustomContentResponse) ToJsonString() string

type DeleteAppCustomContentResponseParams added in v1.0.614

type DeleteAppCustomContentResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteDocumentRequest added in v1.0.591

type DeleteDocumentRequest struct {
	*tchttp.BaseRequest

	// 文档ID。
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewDeleteDocumentRequest added in v1.0.591

func NewDeleteDocumentRequest() (request *DeleteDocumentRequest)

func (*DeleteDocumentRequest) FromJsonString added in v1.0.591

func (r *DeleteDocumentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteDocumentRequest) ToJsonString added in v1.0.591

func (r *DeleteDocumentRequest) ToJsonString() string

type DeleteDocumentRequestParams added in v1.0.591

type DeleteDocumentRequestParams struct {
	// 文档ID。
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type DeleteDocumentResponse added in v1.0.591

type DeleteDocumentResponse struct {
	*tchttp.BaseResponse
	Response *DeleteDocumentResponseParams `json:"Response"`
}

func NewDeleteDocumentResponse added in v1.0.591

func NewDeleteDocumentResponse() (response *DeleteDocumentResponse)

func (*DeleteDocumentResponse) FromJsonString added in v1.0.591

func (r *DeleteDocumentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteDocumentResponse) ToJsonString added in v1.0.591

func (r *DeleteDocumentResponse) ToJsonString() string

type DeleteDocumentResponseParams added in v1.0.591

type DeleteDocumentResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteGroupMemberRequest added in v1.0.597

type DeleteGroupMemberRequest struct {
	*tchttp.BaseRequest

	// 群组ID,联合群组无法删除群组成员
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 成员列表,最大值200
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewDeleteGroupMemberRequest added in v1.0.597

func NewDeleteGroupMemberRequest() (request *DeleteGroupMemberRequest)

func (*DeleteGroupMemberRequest) FromJsonString added in v1.0.597

func (r *DeleteGroupMemberRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteGroupMemberRequest) ToJsonString added in v1.0.597

func (r *DeleteGroupMemberRequest) ToJsonString() string

type DeleteGroupMemberRequestParams added in v1.0.597

type DeleteGroupMemberRequestParams struct {
	// 群组ID,联合群组无法删除群组成员
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 成员列表,最大值200
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type DeleteGroupMemberResponse added in v1.0.597

type DeleteGroupMemberResponse struct {
	*tchttp.BaseResponse
	Response *DeleteGroupMemberResponseParams `json:"Response"`
}

func NewDeleteGroupMemberResponse added in v1.0.597

func NewDeleteGroupMemberResponse() (response *DeleteGroupMemberResponse)

func (*DeleteGroupMemberResponse) FromJsonString added in v1.0.597

func (r *DeleteGroupMemberResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteGroupMemberResponse) ToJsonString added in v1.0.597

func (r *DeleteGroupMemberResponse) ToJsonString() string

type DeleteGroupMemberResponseParams added in v1.0.597

type DeleteGroupMemberResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteGroupRequest added in v1.0.597

type DeleteGroupRequest struct {
	*tchttp.BaseRequest

	// 待删除群组ID列表
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDeleteGroupRequest added in v1.0.597

func NewDeleteGroupRequest() (request *DeleteGroupRequest)

func (*DeleteGroupRequest) FromJsonString added in v1.0.597

func (r *DeleteGroupRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteGroupRequest) ToJsonString added in v1.0.597

func (r *DeleteGroupRequest) ToJsonString() string

type DeleteGroupRequestParams added in v1.0.597

type DeleteGroupRequestParams struct {
	// 待删除群组ID列表
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DeleteGroupResponse added in v1.0.597

type DeleteGroupResponse struct {
	*tchttp.BaseResponse
	Response *DeleteGroupResponseParams `json:"Response"`
}

func NewDeleteGroupResponse added in v1.0.597

func NewDeleteGroupResponse() (response *DeleteGroupResponse)

func (*DeleteGroupResponse) FromJsonString added in v1.0.597

func (r *DeleteGroupResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteGroupResponse) ToJsonString added in v1.0.597

func (r *DeleteGroupResponse) ToJsonString() string

type DeleteGroupResponseParams added in v1.0.597

type DeleteGroupResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteRecordRequest added in v1.0.591

type DeleteRecordRequest struct {
	*tchttp.BaseRequest

	// 房间Id。
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 低代码互动课堂的SdkAppId。
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDeleteRecordRequest added in v1.0.591

func NewDeleteRecordRequest() (request *DeleteRecordRequest)

func (*DeleteRecordRequest) FromJsonString added in v1.0.591

func (r *DeleteRecordRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRecordRequest) ToJsonString added in v1.0.591

func (r *DeleteRecordRequest) ToJsonString() string

type DeleteRecordRequestParams added in v1.0.591

type DeleteRecordRequestParams struct {
	// 房间Id。
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 低代码互动课堂的SdkAppId。
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DeleteRecordResponse added in v1.0.591

type DeleteRecordResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRecordResponseParams `json:"Response"`
}

func NewDeleteRecordResponse added in v1.0.591

func NewDeleteRecordResponse() (response *DeleteRecordResponse)

func (*DeleteRecordResponse) FromJsonString added in v1.0.591

func (r *DeleteRecordResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRecordResponse) ToJsonString added in v1.0.591

func (r *DeleteRecordResponse) ToJsonString() string

type DeleteRecordResponseParams added in v1.0.591

type DeleteRecordResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteRoomRequest added in v1.0.516

type DeleteRoomRequest struct {
	*tchttp.BaseRequest

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewDeleteRoomRequest added in v1.0.516

func NewDeleteRoomRequest() (request *DeleteRoomRequest)

func (*DeleteRoomRequest) FromJsonString added in v1.0.516

func (r *DeleteRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRoomRequest) ToJsonString added in v1.0.516

func (r *DeleteRoomRequest) ToJsonString() string

type DeleteRoomRequestParams added in v1.0.516

type DeleteRoomRequestParams struct {
	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type DeleteRoomResponse added in v1.0.516

type DeleteRoomResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRoomResponseParams `json:"Response"`
}

func NewDeleteRoomResponse added in v1.0.516

func NewDeleteRoomResponse() (response *DeleteRoomResponse)

func (*DeleteRoomResponse) FromJsonString added in v1.0.516

func (r *DeleteRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRoomResponse) ToJsonString added in v1.0.516

func (r *DeleteRoomResponse) ToJsonString() string

type DeleteRoomResponseParams added in v1.0.516

type DeleteRoomResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteSupervisorRequest added in v1.0.641

type DeleteSupervisorRequest struct {
	*tchttp.BaseRequest

	// 应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户ID列表
	Users []*string `json:"Users,omitnil,omitempty" name:"Users"`
}

func NewDeleteSupervisorRequest added in v1.0.641

func NewDeleteSupervisorRequest() (request *DeleteSupervisorRequest)

func (*DeleteSupervisorRequest) FromJsonString added in v1.0.641

func (r *DeleteSupervisorRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteSupervisorRequest) ToJsonString added in v1.0.641

func (r *DeleteSupervisorRequest) ToJsonString() string

type DeleteSupervisorRequestParams added in v1.0.641

type DeleteSupervisorRequestParams struct {
	// 应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户ID列表
	Users []*string `json:"Users,omitnil,omitempty" name:"Users"`
}

Predefined struct for user

type DeleteSupervisorResponse added in v1.0.641

type DeleteSupervisorResponse struct {
	*tchttp.BaseResponse
	Response *DeleteSupervisorResponseParams `json:"Response"`
}

func NewDeleteSupervisorResponse added in v1.0.641

func NewDeleteSupervisorResponse() (response *DeleteSupervisorResponse)

func (*DeleteSupervisorResponse) FromJsonString added in v1.0.641

func (r *DeleteSupervisorResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteSupervisorResponse) ToJsonString added in v1.0.641

func (r *DeleteSupervisorResponse) ToJsonString() string

type DeleteSupervisorResponseParams added in v1.0.641

type DeleteSupervisorResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteUserRequest added in v1.0.726

type DeleteUserRequest struct {
	*tchttp.BaseRequest

	// 待删除用户的ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewDeleteUserRequest added in v1.0.726

func NewDeleteUserRequest() (request *DeleteUserRequest)

func (*DeleteUserRequest) FromJsonString added in v1.0.726

func (r *DeleteUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteUserRequest) ToJsonString added in v1.0.726

func (r *DeleteUserRequest) ToJsonString() string

type DeleteUserRequestParams added in v1.0.726

type DeleteUserRequestParams struct {
	// 待删除用户的ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type DeleteUserResponse added in v1.0.726

type DeleteUserResponse struct {
	*tchttp.BaseResponse
	Response *DeleteUserResponseParams `json:"Response"`
}

func NewDeleteUserResponse added in v1.0.726

func NewDeleteUserResponse() (response *DeleteUserResponse)

func (*DeleteUserResponse) FromJsonString added in v1.0.726

func (r *DeleteUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteUserResponse) ToJsonString added in v1.0.726

func (r *DeleteUserResponse) ToJsonString() string

type DeleteUserResponseParams added in v1.0.726

type DeleteUserResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeAnswerListRequest added in v1.0.629

type DescribeAnswerListRequest struct {
	*tchttp.BaseRequest

	// 问题ID
	QuestionId *string `json:"QuestionId,omitnil,omitempty" name:"QuestionId"`

	// 1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 100
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeAnswerListRequest added in v1.0.629

func NewDescribeAnswerListRequest() (request *DescribeAnswerListRequest)

func (*DescribeAnswerListRequest) FromJsonString added in v1.0.629

func (r *DescribeAnswerListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAnswerListRequest) ToJsonString added in v1.0.629

func (r *DescribeAnswerListRequest) ToJsonString() string

type DescribeAnswerListRequestParams added in v1.0.629

type DescribeAnswerListRequestParams struct {
	// 问题ID
	QuestionId *string `json:"QuestionId,omitnil,omitempty" name:"QuestionId"`

	// 1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 100
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeAnswerListResponse added in v1.0.629

type DescribeAnswerListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAnswerListResponseParams `json:"Response"`
}

func NewDescribeAnswerListResponse added in v1.0.629

func NewDescribeAnswerListResponse() (response *DescribeAnswerListResponse)

func (*DescribeAnswerListResponse) FromJsonString added in v1.0.629

func (r *DescribeAnswerListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAnswerListResponse) ToJsonString added in v1.0.629

func (r *DescribeAnswerListResponse) ToJsonString() string

type DescribeAnswerListResponseParams added in v1.0.629

type DescribeAnswerListResponseParams struct {
	// 符合查询条件的房间答案总数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 房间提问答案列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	AnswerInfo []*AnswerInfo `json:"AnswerInfo,omitnil,omitempty" name:"AnswerInfo"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeAppDetailRequest added in v1.0.579

type DescribeAppDetailRequest struct {
	*tchttp.BaseRequest

	// 应用ID。低代码互动课堂的SdkAppId。
	ApplicationId *string `json:"ApplicationId,omitnil,omitempty" name:"ApplicationId"`

	// 开发商ID
	DeveloperId *string `json:"DeveloperId,omitnil,omitempty" name:"DeveloperId"`
}

func NewDescribeAppDetailRequest added in v1.0.579

func NewDescribeAppDetailRequest() (request *DescribeAppDetailRequest)

func (*DescribeAppDetailRequest) FromJsonString added in v1.0.579

func (r *DescribeAppDetailRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAppDetailRequest) ToJsonString added in v1.0.579

func (r *DescribeAppDetailRequest) ToJsonString() string

type DescribeAppDetailRequestParams added in v1.0.579

type DescribeAppDetailRequestParams struct {
	// 应用ID。低代码互动课堂的SdkAppId。
	ApplicationId *string `json:"ApplicationId,omitnil,omitempty" name:"ApplicationId"`

	// 开发商ID
	DeveloperId *string `json:"DeveloperId,omitnil,omitempty" name:"DeveloperId"`
}

Predefined struct for user

type DescribeAppDetailResponse added in v1.0.579

type DescribeAppDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAppDetailResponseParams `json:"Response"`
}

func NewDescribeAppDetailResponse added in v1.0.579

func NewDescribeAppDetailResponse() (response *DescribeAppDetailResponse)

func (*DescribeAppDetailResponse) FromJsonString added in v1.0.579

func (r *DescribeAppDetailResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAppDetailResponse) ToJsonString added in v1.0.579

func (r *DescribeAppDetailResponse) ToJsonString() string

type DescribeAppDetailResponseParams added in v1.0.579

type DescribeAppDetailResponseParams struct {
	// SDK 对应的AppId
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 应用配置
	AppConfig *AppConfig `json:"AppConfig,omitnil,omitempty" name:"AppConfig"`

	// 场景配置
	SceneConfig []*SceneItem `json:"SceneConfig,omitnil,omitempty" name:"SceneConfig"`

	// 转存配置
	TransferConfig *TransferItem `json:"TransferConfig,omitnil,omitempty" name:"TransferConfig"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeCurrentMemberListRequest added in v1.0.595

type DescribeCurrentMemberListRequest struct {
	*tchttp.BaseRequest

	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 分页查询当前页数,从1开始递增。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大1000。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeCurrentMemberListRequest added in v1.0.595

func NewDescribeCurrentMemberListRequest() (request *DescribeCurrentMemberListRequest)

func (*DescribeCurrentMemberListRequest) FromJsonString added in v1.0.595

func (r *DescribeCurrentMemberListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCurrentMemberListRequest) ToJsonString added in v1.0.595

func (r *DescribeCurrentMemberListRequest) ToJsonString() string

type DescribeCurrentMemberListRequestParams added in v1.0.595

type DescribeCurrentMemberListRequestParams struct {
	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 分页查询当前页数,从1开始递增。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大1000。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeCurrentMemberListResponse added in v1.0.595

type DescribeCurrentMemberListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCurrentMemberListResponseParams `json:"Response"`
}

func NewDescribeCurrentMemberListResponse added in v1.0.595

func NewDescribeCurrentMemberListResponse() (response *DescribeCurrentMemberListResponse)

func (*DescribeCurrentMemberListResponse) FromJsonString added in v1.0.595

func (r *DescribeCurrentMemberListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCurrentMemberListResponse) ToJsonString added in v1.0.595

func (r *DescribeCurrentMemberListResponse) ToJsonString() string

type DescribeCurrentMemberListResponseParams added in v1.0.595

type DescribeCurrentMemberListResponseParams struct {
	// 记录总数。当前房间的总人数。
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 成员记录列表。
	MemberRecords []*MemberRecord `json:"MemberRecords,omitnil,omitempty" name:"MemberRecords"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDeveloperRequest added in v1.0.622

type DescribeDeveloperRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeDeveloperRequest added in v1.0.622

func NewDescribeDeveloperRequest() (request *DescribeDeveloperRequest)

func (*DescribeDeveloperRequest) FromJsonString added in v1.0.622

func (r *DescribeDeveloperRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDeveloperRequest) ToJsonString added in v1.0.622

func (r *DescribeDeveloperRequest) ToJsonString() string

type DescribeDeveloperRequestParams added in v1.0.622

type DescribeDeveloperRequestParams struct {
}

Predefined struct for user

type DescribeDeveloperResponse added in v1.0.622

type DescribeDeveloperResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDeveloperResponseParams `json:"Response"`
}

func NewDescribeDeveloperResponse added in v1.0.622

func NewDescribeDeveloperResponse() (response *DescribeDeveloperResponse)

func (*DescribeDeveloperResponse) FromJsonString added in v1.0.622

func (r *DescribeDeveloperResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDeveloperResponse) ToJsonString added in v1.0.622

func (r *DescribeDeveloperResponse) ToJsonString() string

type DescribeDeveloperResponseParams added in v1.0.622

type DescribeDeveloperResponseParams struct {
	// 开发商ID
	DeveloperId *string `json:"DeveloperId,omitnil,omitempty" name:"DeveloperId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDocumentRequest added in v1.0.591

type DescribeDocumentRequest struct {
	*tchttp.BaseRequest

	// 文档Id(唯一id)
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewDescribeDocumentRequest added in v1.0.591

func NewDescribeDocumentRequest() (request *DescribeDocumentRequest)

func (*DescribeDocumentRequest) FromJsonString added in v1.0.591

func (r *DescribeDocumentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentRequest) ToJsonString added in v1.0.591

func (r *DescribeDocumentRequest) ToJsonString() string

type DescribeDocumentRequestParams added in v1.0.591

type DescribeDocumentRequestParams struct {
	// 文档Id(唯一id)
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type DescribeDocumentResponse added in v1.0.591

type DescribeDocumentResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDocumentResponseParams `json:"Response"`
}

func NewDescribeDocumentResponse added in v1.0.591

func NewDescribeDocumentResponse() (response *DescribeDocumentResponse)

func (*DescribeDocumentResponse) FromJsonString added in v1.0.591

func (r *DescribeDocumentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentResponse) ToJsonString added in v1.0.591

func (r *DescribeDocumentResponse) ToJsonString() string

type DescribeDocumentResponseParams added in v1.0.591

type DescribeDocumentResponseParams struct {
	// 文档Id
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// 文档原址url
	DocumentUrl *string `json:"DocumentUrl,omitnil,omitempty" name:"DocumentUrl"`

	// 文档名称
	DocumentName *string `json:"DocumentName,omitnil,omitempty" name:"DocumentName"`

	// 文档所有者UserId
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 应用Id
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 文档权限
	Permission *uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码
	TranscodeResult *string `json:"TranscodeResult,omitnil,omitempty" name:"TranscodeResult"`

	// 转码类型
	TranscodeType *uint64 `json:"TranscodeType,omitnil,omitempty" name:"TranscodeType"`

	// 转码进度, 0 - 100 表示(0% - 100%)
	TranscodeProgress *uint64 `json:"TranscodeProgress,omitnil,omitempty" name:"TranscodeProgress"`

	// 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功
	TranscodeState *uint64 `json:"TranscodeState,omitnil,omitempty" name:"TranscodeState"`

	// 转码失败后的错误信息
	TranscodeInfo *string `json:"TranscodeInfo,omitnil,omitempty" name:"TranscodeInfo"`

	// 文档类型
	DocumentType *string `json:"DocumentType,omitnil,omitempty" name:"DocumentType"`

	// 文档大小,单位:字节
	DocumentSize *uint64 `json:"DocumentSize,omitnil,omitempty" name:"DocumentSize"`

	// 更新的UNIX时间戳
	UpdateTime *uint64 `json:"UpdateTime,omitnil,omitempty" name:"UpdateTime"`

	// 课件页数
	Pages *uint64 `json:"Pages,omitnil,omitempty" name:"Pages"`

	// 课件预览地址
	Preview *string `json:"Preview,omitnil,omitempty" name:"Preview"`

	// 文档的分辨率
	Resolution *string `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 转码后文档的最小分辨率,和创建文档时传入的参数一致。
	MinScaleResolution *string `json:"MinScaleResolution,omitnil,omitempty" name:"MinScaleResolution"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDocumentsByRoomRequest added in v1.0.591

type DescribeDocumentsByRoomRequest struct {
	*tchttp.BaseRequest

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 低代码互动课堂的SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页查询当前页数,从1开始递增,默认值为1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大1000,默认值为100
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 课件权限。
	// [0]:获取owner的私有课件;
	// [1]:获取owner的公开课件;
	// [0,1]:则获取owner的私有课件和公开课件;
	// [2]:获取owner的私有课件和所有人(包括owner)的公开课件。
	// 默认值为[2]
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 文档所有者的user_id,不填默认获取SdkAppId下所有课件
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`
}

func NewDescribeDocumentsByRoomRequest added in v1.0.591

func NewDescribeDocumentsByRoomRequest() (request *DescribeDocumentsByRoomRequest)

func (*DescribeDocumentsByRoomRequest) FromJsonString added in v1.0.591

func (r *DescribeDocumentsByRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentsByRoomRequest) ToJsonString added in v1.0.591

func (r *DescribeDocumentsByRoomRequest) ToJsonString() string

type DescribeDocumentsByRoomRequestParams added in v1.0.591

type DescribeDocumentsByRoomRequestParams struct {
	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 低代码互动课堂的SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页查询当前页数,从1开始递增,默认值为1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大1000,默认值为100
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 课件权限。
	// [0]:获取owner的私有课件;
	// [1]:获取owner的公开课件;
	// [0,1]:则获取owner的私有课件和公开课件;
	// [2]:获取owner的私有课件和所有人(包括owner)的公开课件。
	// 默认值为[2]
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 文档所有者的user_id,不填默认获取SdkAppId下所有课件
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`
}

Predefined struct for user

type DescribeDocumentsByRoomResponse added in v1.0.591

type DescribeDocumentsByRoomResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDocumentsByRoomResponseParams `json:"Response"`
}

func NewDescribeDocumentsByRoomResponse added in v1.0.591

func NewDescribeDocumentsByRoomResponse() (response *DescribeDocumentsByRoomResponse)

func (*DescribeDocumentsByRoomResponse) FromJsonString added in v1.0.591

func (r *DescribeDocumentsByRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentsByRoomResponse) ToJsonString added in v1.0.591

func (r *DescribeDocumentsByRoomResponse) ToJsonString() string

type DescribeDocumentsByRoomResponseParams added in v1.0.591

type DescribeDocumentsByRoomResponseParams struct {
	// 文档信息列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Documents []*DocumentInfo `json:"Documents,omitnil,omitempty" name:"Documents"`

	// 符合查询条件文档总数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDocumentsRequest added in v1.0.641

type DescribeDocumentsRequest struct {
	*tchttp.BaseRequest

	// 学校id
	SchoolId *uint64 `json:"SchoolId,omitnil,omitempty" name:"SchoolId"`

	// 分页查询当前页数,从1开始递增
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大1000
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 课件权限。[0]:获取owner的私有课件;[1]:获取owner的公开课件; [0,1]:则获取owner的私有课件和公开课件;[2]:获取owner的私有课件和所有人(包括owner)的公开课件
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 课件所有者的user_id,不填默认获取school_id下所有课件
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 课件名称搜索词
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`

	// 课件id列表,从列表中查询,忽略错误的id
	DocumentId []*string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewDescribeDocumentsRequest added in v1.0.641

func NewDescribeDocumentsRequest() (request *DescribeDocumentsRequest)

func (*DescribeDocumentsRequest) FromJsonString added in v1.0.641

func (r *DescribeDocumentsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentsRequest) ToJsonString added in v1.0.641

func (r *DescribeDocumentsRequest) ToJsonString() string

type DescribeDocumentsRequestParams added in v1.0.641

type DescribeDocumentsRequestParams struct {
	// 学校id
	SchoolId *uint64 `json:"SchoolId,omitnil,omitempty" name:"SchoolId"`

	// 分页查询当前页数,从1开始递增
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大1000
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 课件权限。[0]:获取owner的私有课件;[1]:获取owner的公开课件; [0,1]:则获取owner的私有课件和公开课件;[2]:获取owner的私有课件和所有人(包括owner)的公开课件
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 课件所有者的user_id,不填默认获取school_id下所有课件
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 课件名称搜索词
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`

	// 课件id列表,从列表中查询,忽略错误的id
	DocumentId []*string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type DescribeDocumentsResponse added in v1.0.641

type DescribeDocumentsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDocumentsResponseParams `json:"Response"`
}

func NewDescribeDocumentsResponse added in v1.0.641

func NewDescribeDocumentsResponse() (response *DescribeDocumentsResponse)

func (*DescribeDocumentsResponse) FromJsonString added in v1.0.641

func (r *DescribeDocumentsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentsResponse) ToJsonString added in v1.0.641

func (r *DescribeDocumentsResponse) ToJsonString() string

type DescribeDocumentsResponseParams added in v1.0.641

type DescribeDocumentsResponseParams struct {
	// 符合查询条件文档总数
	Total *int64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 文档信息列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Documents []*DocumentInfo `json:"Documents,omitnil,omitempty" name:"Documents"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeGroupListRequest added in v1.0.597

type DescribeGroupListRequest struct {
	*tchttp.BaseRequest

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页查询当前页数,默认从1开始递增。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,默认20,最大1000。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 主讲人ID筛选群组,与MemberId有且只有一个,都传时以此字段获取
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 成员ID刷选群组,与TeacherId有且只有一个
	MemberId *string `json:"MemberId,omitnil,omitempty" name:"MemberId"`
}

func NewDescribeGroupListRequest added in v1.0.597

func NewDescribeGroupListRequest() (request *DescribeGroupListRequest)

func (*DescribeGroupListRequest) FromJsonString added in v1.0.597

func (r *DescribeGroupListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupListRequest) ToJsonString added in v1.0.597

func (r *DescribeGroupListRequest) ToJsonString() string

type DescribeGroupListRequestParams added in v1.0.597

type DescribeGroupListRequestParams struct {
	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页查询当前页数,默认从1开始递增。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,默认20,最大1000。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 主讲人ID筛选群组,与MemberId有且只有一个,都传时以此字段获取
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 成员ID刷选群组,与TeacherId有且只有一个
	MemberId *string `json:"MemberId,omitnil,omitempty" name:"MemberId"`
}

Predefined struct for user

type DescribeGroupListResponse added in v1.0.597

type DescribeGroupListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupListResponseParams `json:"Response"`
}

func NewDescribeGroupListResponse added in v1.0.597

func NewDescribeGroupListResponse() (response *DescribeGroupListResponse)

func (*DescribeGroupListResponse) FromJsonString added in v1.0.597

func (r *DescribeGroupListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupListResponse) ToJsonString added in v1.0.597

func (r *DescribeGroupListResponse) ToJsonString() string

type DescribeGroupListResponseParams added in v1.0.597

type DescribeGroupListResponseParams struct {
	// 记录总数。当前匹配群组总数。
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 群组信息列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	GroupInfos []*GroupInfo `json:"GroupInfos,omitnil,omitempty" name:"GroupInfos"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeGroupMemberListRequest added in v1.0.597

type DescribeGroupMemberListRequest struct {
	*tchttp.BaseRequest

	// 群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页值,默认1
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,默认20,最大1000
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeGroupMemberListRequest added in v1.0.597

func NewDescribeGroupMemberListRequest() (request *DescribeGroupMemberListRequest)

func (*DescribeGroupMemberListRequest) FromJsonString added in v1.0.597

func (r *DescribeGroupMemberListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupMemberListRequest) ToJsonString added in v1.0.597

func (r *DescribeGroupMemberListRequest) ToJsonString() string

type DescribeGroupMemberListRequestParams added in v1.0.597

type DescribeGroupMemberListRequestParams struct {
	// 群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页值,默认1
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,默认20,最大1000
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeGroupMemberListResponse added in v1.0.597

type DescribeGroupMemberListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupMemberListResponseParams `json:"Response"`
}

func NewDescribeGroupMemberListResponse added in v1.0.597

func NewDescribeGroupMemberListResponse() (response *DescribeGroupMemberListResponse)

func (*DescribeGroupMemberListResponse) FromJsonString added in v1.0.597

func (r *DescribeGroupMemberListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupMemberListResponse) ToJsonString added in v1.0.597

func (r *DescribeGroupMemberListResponse) ToJsonString() string

type DescribeGroupMemberListResponseParams added in v1.0.597

type DescribeGroupMemberListResponseParams struct {
	// 符合查询条件总条数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 查询成员列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeGroupRequest added in v1.0.597

type DescribeGroupRequest struct {
	*tchttp.BaseRequest

	// 群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeGroupRequest added in v1.0.597

func NewDescribeGroupRequest() (request *DescribeGroupRequest)

func (*DescribeGroupRequest) FromJsonString added in v1.0.597

func (r *DescribeGroupRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupRequest) ToJsonString added in v1.0.597

func (r *DescribeGroupRequest) ToJsonString() string

type DescribeGroupRequestParams added in v1.0.597

type DescribeGroupRequestParams struct {
	// 群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeGroupResponse added in v1.0.597

type DescribeGroupResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupResponseParams `json:"Response"`
}

func NewDescribeGroupResponse added in v1.0.597

func NewDescribeGroupResponse() (response *DescribeGroupResponse)

func (*DescribeGroupResponse) FromJsonString added in v1.0.597

func (r *DescribeGroupResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupResponse) ToJsonString added in v1.0.597

func (r *DescribeGroupResponse) ToJsonString() string

type DescribeGroupResponseParams added in v1.0.597

type DescribeGroupResponseParams struct {
	// 群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 群组名称
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// 群主主讲人ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 群组类型
	// 0-基础群组
	// 1-组合群组,若为1时会返回子群组ID
	GroupType *uint64 `json:"GroupType,omitnil,omitempty" name:"GroupType"`

	// 子群组ID列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	SubGroupIds []*string `json:"SubGroupIds,omitnil,omitempty" name:"SubGroupIds"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeQuestionListRequest added in v1.0.629

type DescribeQuestionListRequest struct {
	*tchttp.BaseRequest

	// 房间ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 分页查询当前页数,从1开始递增,默认值为1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 分页查询当前页数,从1开始递增,默认值为1
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeQuestionListRequest added in v1.0.629

func NewDescribeQuestionListRequest() (request *DescribeQuestionListRequest)

func (*DescribeQuestionListRequest) FromJsonString added in v1.0.629

func (r *DescribeQuestionListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeQuestionListRequest) ToJsonString added in v1.0.629

func (r *DescribeQuestionListRequest) ToJsonString() string

type DescribeQuestionListRequestParams added in v1.0.629

type DescribeQuestionListRequestParams struct {
	// 房间ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 分页查询当前页数,从1开始递增,默认值为1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 分页查询当前页数,从1开始递增,默认值为1
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeQuestionListResponse added in v1.0.629

type DescribeQuestionListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeQuestionListResponseParams `json:"Response"`
}

func NewDescribeQuestionListResponse added in v1.0.629

func NewDescribeQuestionListResponse() (response *DescribeQuestionListResponse)

func (*DescribeQuestionListResponse) FromJsonString added in v1.0.629

func (r *DescribeQuestionListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeQuestionListResponse) ToJsonString added in v1.0.629

func (r *DescribeQuestionListResponse) ToJsonString() string

type DescribeQuestionListResponseParams added in v1.0.629

type DescribeQuestionListResponseParams struct {
	// 符合查询条件的房间问答问题总数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 房间问答问题列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	QuestionInfo []*QuestionInfo `json:"QuestionInfo,omitnil,omitempty" name:"QuestionInfo"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRoomForbiddenUserRequest added in v1.0.787

type DescribeRoomForbiddenUserRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewDescribeRoomForbiddenUserRequest added in v1.0.787

func NewDescribeRoomForbiddenUserRequest() (request *DescribeRoomForbiddenUserRequest)

func (*DescribeRoomForbiddenUserRequest) FromJsonString added in v1.0.787

func (r *DescribeRoomForbiddenUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomForbiddenUserRequest) ToJsonString added in v1.0.787

func (r *DescribeRoomForbiddenUserRequest) ToJsonString() string

type DescribeRoomForbiddenUserRequestParams added in v1.0.787

type DescribeRoomForbiddenUserRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type DescribeRoomForbiddenUserResponse added in v1.0.787

type DescribeRoomForbiddenUserResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRoomForbiddenUserResponseParams `json:"Response"`
}

func NewDescribeRoomForbiddenUserResponse added in v1.0.787

func NewDescribeRoomForbiddenUserResponse() (response *DescribeRoomForbiddenUserResponse)

func (*DescribeRoomForbiddenUserResponse) FromJsonString added in v1.0.787

func (r *DescribeRoomForbiddenUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomForbiddenUserResponse) ToJsonString added in v1.0.787

func (r *DescribeRoomForbiddenUserResponse) ToJsonString() string

type DescribeRoomForbiddenUserResponseParams added in v1.0.787

type DescribeRoomForbiddenUserResponseParams struct {
	// 禁言用户信息数组,内容包括被禁言的成员 ID,及其被禁言到的时间(使用 UTC 时间,即世界协调时间)
	// 注意:此字段可能返回 null,表示取不到有效值。
	MutedAccountList []*MutedAccountList `json:"MutedAccountList,omitnil,omitempty" name:"MutedAccountList"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRoomRequest

type DescribeRoomRequest struct {
	*tchttp.BaseRequest

	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 请求RTMP推流链接,0:否,1:是,默认为0。
	RTMPStreamingURL *uint64 `json:"RTMPStreamingURL,omitnil,omitempty" name:"RTMPStreamingURL"`
}

func NewDescribeRoomRequest

func NewDescribeRoomRequest() (request *DescribeRoomRequest)

func (*DescribeRoomRequest) FromJsonString

func (r *DescribeRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomRequest) ToJsonString

func (r *DescribeRoomRequest) ToJsonString() string

type DescribeRoomRequestParams

type DescribeRoomRequestParams struct {
	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 请求RTMP推流链接,0:否,1:是,默认为0。
	RTMPStreamingURL *uint64 `json:"RTMPStreamingURL,omitnil,omitempty" name:"RTMPStreamingURL"`
}

Predefined struct for user

type DescribeRoomResponse

type DescribeRoomResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRoomResponseParams `json:"Response"`
}

func NewDescribeRoomResponse

func NewDescribeRoomResponse() (response *DescribeRoomResponse)

func (*DescribeRoomResponse) FromJsonString

func (r *DescribeRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomResponse) ToJsonString

func (r *DescribeRoomResponse) ToJsonString() string

type DescribeRoomResponseParams

type DescribeRoomResponseParams struct {
	// 房间名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 预定的房间开始时间,unix时间戳(秒)。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 预定的房间结束时间,unix时间戳(秒)。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 老师的UserId。
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 观看类型。互动观看 (默认)
	AudienceType *uint64 `json:"AudienceType,omitnil,omitempty" name:"AudienceType"`

	// 分辨率。可以有如下取值:
	// 1 标清
	// 2 高清
	// 3 全高清
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// 进入课堂时是否自动连麦。可以有以下取值:
	// 0 不自动连麦(需要手动申请上麦,默认值)
	// 1 自动连麦
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// 高音质模式。可以有以下取值:
	// 0 不开启高音质(默认值)
	// 1 开启高音质
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// 房间子类型,可以有以下取值:
	// videodoc 文档+视频
	// video 纯视频
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// 上课后是否禁止自动录制。可以有以下取值:
	// 0 不禁止录制(自动开启录制,默认值)
	// 1 禁止录制
	// 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// 助教UserId列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// 录制地址(协议为https)。仅在房间结束后存在。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RecordUrl *string `json:"RecordUrl,omitnil,omitempty" name:"RecordUrl"`

	// 课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 房间绑定的群组ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 打开学生麦克风/摄像头的授权开关
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// 开启专注模式。
	// 0 收看全部角色音视频(默认)
	// 1 只看老师和助教
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
	VideoOrientation *uint64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// 该房间是否开启了课后评分功能。0:未开启  1:开启
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
	// 注:大班课的布局(layout)只有三分屏
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// 录制时长
	VideoDuration *uint64 `json:"VideoDuration,omitnil,omitempty" name:"VideoDuration"`

	// 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// 直播类型:0 常规(默认)1 伪直播
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// 伪直播链接
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// RTMP推流链接
	RTMPStreamingURL *string `json:"RTMPStreamingURL,omitnil,omitempty" name:"RTMPStreamingURL"`

	// 录制自定义场景,仅recordlayout=9的时候此参数有效
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// 录制自定义语言,仅recordlayout=9的时候此参数有效
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRoomStatisticsRequest added in v1.0.517

type DescribeRoomStatisticsRequest struct {
	*tchttp.BaseRequest

	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 分页查询当前页数,从1开始递增。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大1000。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeRoomStatisticsRequest added in v1.0.517

func NewDescribeRoomStatisticsRequest() (request *DescribeRoomStatisticsRequest)

func (*DescribeRoomStatisticsRequest) FromJsonString added in v1.0.517

func (r *DescribeRoomStatisticsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomStatisticsRequest) ToJsonString added in v1.0.517

func (r *DescribeRoomStatisticsRequest) ToJsonString() string

type DescribeRoomStatisticsRequestParams added in v1.0.517

type DescribeRoomStatisticsRequestParams struct {
	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 分页查询当前页数,从1开始递增。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页数据量,最大1000。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeRoomStatisticsResponse added in v1.0.517

type DescribeRoomStatisticsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRoomStatisticsResponseParams `json:"Response"`
}

func NewDescribeRoomStatisticsResponse added in v1.0.517

func NewDescribeRoomStatisticsResponse() (response *DescribeRoomStatisticsResponse)

func (*DescribeRoomStatisticsResponse) FromJsonString added in v1.0.517

func (r *DescribeRoomStatisticsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomStatisticsResponse) ToJsonString added in v1.0.517

func (r *DescribeRoomStatisticsResponse) ToJsonString() string

type DescribeRoomStatisticsResponseParams added in v1.0.517

type DescribeRoomStatisticsResponseParams struct {
	// 峰值在线成员人数。
	PeakMemberNumber *uint64 `json:"PeakMemberNumber,omitnil,omitempty" name:"PeakMemberNumber"`

	// 累计在线人数。
	MemberNumber *uint64 `json:"MemberNumber,omitnil,omitempty" name:"MemberNumber"`

	// 记录总数。包含进入房间或者应到未到的。
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 成员记录列表。
	MemberRecords []*MemberRecord `json:"MemberRecords,omitnil,omitempty" name:"MemberRecords"`

	// 秒级unix时间戳,实际房间开始时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RealStartTime *uint64 `json:"RealStartTime,omitnil,omitempty" name:"RealStartTime"`

	// 秒级unix时间戳,实际房间结束时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RealEndTime *uint64 `json:"RealEndTime,omitnil,omitempty" name:"RealEndTime"`

	// 房间消息总数。
	MessageCount *uint64 `json:"MessageCount,omitnil,omitempty" name:"MessageCount"`

	// 房间连麦总数。
	MicCount *uint64 `json:"MicCount,omitnil,omitempty" name:"MicCount"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeScoreListRequest added in v1.0.764

type DescribeScoreListRequest struct {
	*tchttp.BaseRequest

	// 课堂ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 分页查询当前页数,从1开始递增
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 默认是10条
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeScoreListRequest added in v1.0.764

func NewDescribeScoreListRequest() (request *DescribeScoreListRequest)

func (*DescribeScoreListRequest) FromJsonString added in v1.0.764

func (r *DescribeScoreListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeScoreListRequest) ToJsonString added in v1.0.764

func (r *DescribeScoreListRequest) ToJsonString() string

type DescribeScoreListRequestParams added in v1.0.764

type DescribeScoreListRequestParams struct {
	// 课堂ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 分页查询当前页数,从1开始递增
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 默认是10条
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeScoreListResponse added in v1.0.764

type DescribeScoreListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeScoreListResponseParams `json:"Response"`
}

func NewDescribeScoreListResponse added in v1.0.764

func NewDescribeScoreListResponse() (response *DescribeScoreListResponse)

func (*DescribeScoreListResponse) FromJsonString added in v1.0.764

func (r *DescribeScoreListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeScoreListResponse) ToJsonString added in v1.0.764

func (r *DescribeScoreListResponse) ToJsonString() string

type DescribeScoreListResponseParams added in v1.0.764

type DescribeScoreListResponseParams struct {
	// 总数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 课堂评分列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Scores []*ClassScoreItem `json:"Scores,omitnil,omitempty" name:"Scores"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeSdkAppIdUsersRequest added in v1.0.591

type DescribeSdkAppIdUsersRequest struct {
	*tchttp.BaseRequest

	// 应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页,默认值为1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 分页数据限制,默认值为20
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeSdkAppIdUsersRequest added in v1.0.591

func NewDescribeSdkAppIdUsersRequest() (request *DescribeSdkAppIdUsersRequest)

func (*DescribeSdkAppIdUsersRequest) FromJsonString added in v1.0.591

func (r *DescribeSdkAppIdUsersRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSdkAppIdUsersRequest) ToJsonString added in v1.0.591

func (r *DescribeSdkAppIdUsersRequest) ToJsonString() string

type DescribeSdkAppIdUsersRequestParams added in v1.0.591

type DescribeSdkAppIdUsersRequestParams struct {
	// 应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 分页,默认值为1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 分页数据限制,默认值为20
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeSdkAppIdUsersResponse added in v1.0.591

type DescribeSdkAppIdUsersResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSdkAppIdUsersResponseParams `json:"Response"`
}

func NewDescribeSdkAppIdUsersResponse added in v1.0.591

func NewDescribeSdkAppIdUsersResponse() (response *DescribeSdkAppIdUsersResponse)

func (*DescribeSdkAppIdUsersResponse) FromJsonString added in v1.0.591

func (r *DescribeSdkAppIdUsersResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSdkAppIdUsersResponse) ToJsonString added in v1.0.591

func (r *DescribeSdkAppIdUsersResponse) ToJsonString() string

type DescribeSdkAppIdUsersResponseParams added in v1.0.591

type DescribeSdkAppIdUsersResponseParams struct {
	// 用户总数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 当前获取用户信息数组列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Users []*UserInfo `json:"Users,omitnil,omitempty" name:"Users"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeSupervisorsRequest added in v1.0.629

type DescribeSupervisorsRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 每页数据量,最大100。 不填默认20.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页查询当前页数,从1开始递增,不填默认为1。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`
}

func NewDescribeSupervisorsRequest added in v1.0.629

func NewDescribeSupervisorsRequest() (request *DescribeSupervisorsRequest)

func (*DescribeSupervisorsRequest) FromJsonString added in v1.0.629

func (r *DescribeSupervisorsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSupervisorsRequest) ToJsonString added in v1.0.629

func (r *DescribeSupervisorsRequest) ToJsonString() string

type DescribeSupervisorsRequestParams added in v1.0.629

type DescribeSupervisorsRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 每页数据量,最大100。 不填默认20.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页查询当前页数,从1开始递增,不填默认为1。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`
}

Predefined struct for user

type DescribeSupervisorsResponse added in v1.0.629

type DescribeSupervisorsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSupervisorsResponseParams `json:"Response"`
}

func NewDescribeSupervisorsResponse added in v1.0.629

func NewDescribeSupervisorsResponse() (response *DescribeSupervisorsResponse)

func (*DescribeSupervisorsResponse) FromJsonString added in v1.0.629

func (r *DescribeSupervisorsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSupervisorsResponse) ToJsonString added in v1.0.629

func (r *DescribeSupervisorsResponse) ToJsonString() string

type DescribeSupervisorsResponseParams added in v1.0.629

type DescribeSupervisorsResponseParams struct {
	// 数据总量
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 分页查询当前页数
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 当前页数据量
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 巡课列表
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUserRequest

type DescribeUserRequest struct {
	*tchttp.BaseRequest

	// 用户Id。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewDescribeUserRequest

func NewDescribeUserRequest() (request *DescribeUserRequest)

func (*DescribeUserRequest) FromJsonString

func (r *DescribeUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUserRequest) ToJsonString

func (r *DescribeUserRequest) ToJsonString() string

type DescribeUserRequestParams

type DescribeUserRequestParams struct {
	// 用户Id。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type DescribeUserResponse

type DescribeUserResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserResponseParams `json:"Response"`
}

func NewDescribeUserResponse

func NewDescribeUserResponse() (response *DescribeUserResponse)

func (*DescribeUserResponse) FromJsonString

func (r *DescribeUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUserResponse) ToJsonString

func (r *DescribeUserResponse) ToJsonString() string

type DescribeUserResponseParams

type DescribeUserResponseParams struct {
	// 应用Id。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户Id。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 用户昵称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 用户头像Url。
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`

	// 用户在客户系统的Id
	// 注意:此字段可能返回 null,表示取不到有效值。
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DocumentInfo added in v1.0.591

type DocumentInfo struct {
	// 文档Id
	// 注意:此字段可能返回 null,表示取不到有效值。
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// 文档原址url
	// 注意:此字段可能返回 null,表示取不到有效值。
	DocumentUrl *string `json:"DocumentUrl,omitnil,omitempty" name:"DocumentUrl"`

	// 文档名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	DocumentName *string `json:"DocumentName,omitnil,omitempty" name:"DocumentName"`

	// 文档所有者UserId
	// 注意:此字段可能返回 null,表示取不到有效值。
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 应用Id
	// 注意:此字段可能返回 null,表示取不到有效值。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 文档权限,0:私有课件 1:公共课件
	// 注意:此字段可能返回 null,表示取不到有效值。
	Permission *uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码
	// 注意:此字段可能返回 null,表示取不到有效值。
	TranscodeResult *string `json:"TranscodeResult,omitnil,omitempty" name:"TranscodeResult"`

	// 转码类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	TranscodeType *uint64 `json:"TranscodeType,omitnil,omitempty" name:"TranscodeType"`

	// 转码进度, 0 - 100 表示(0% - 100%)
	// 注意:此字段可能返回 null,表示取不到有效值。
	TranscodeProgress *uint64 `json:"TranscodeProgress,omitnil,omitempty" name:"TranscodeProgress"`

	// 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功
	// 注意:此字段可能返回 null,表示取不到有效值。
	TranscodeState *uint64 `json:"TranscodeState,omitnil,omitempty" name:"TranscodeState"`

	// 转码失败后的错误信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	TranscodeInfo *string `json:"TranscodeInfo,omitnil,omitempty" name:"TranscodeInfo"`

	// 文档类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	DocumentType *string `json:"DocumentType,omitnil,omitempty" name:"DocumentType"`

	// 文档大小,单位:字节
	// 注意:此字段可能返回 null,表示取不到有效值。
	DocumentSize *uint64 `json:"DocumentSize,omitnil,omitempty" name:"DocumentSize"`

	// 更新的UNIX时间戳
	// 注意:此字段可能返回 null,表示取不到有效值。
	UpdateTime *uint64 `json:"UpdateTime,omitnil,omitempty" name:"UpdateTime"`

	// 课件页数
	// 注意:此字段可能返回 null,表示取不到有效值。
	Pages *uint64 `json:"Pages,omitnil,omitempty" name:"Pages"`

	// 宽,仅在静态转码的课件有效
	// 注意:此字段可能返回 null,表示取不到有效值。
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// 高,仅在静态转码的课件有效
	// 注意:此字段可能返回 null,表示取不到有效值。
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// 封面,仅转码的课件会生成封面
	// 注意:此字段可能返回 null,表示取不到有效值。
	Cover *string `json:"Cover,omitnil,omitempty" name:"Cover"`

	// 课件预览地址
	// 注意:此字段可能返回 null,表示取不到有效值。
	Preview *string `json:"Preview,omitnil,omitempty" name:"Preview"`

	// 文档的分辨率
	// 注意:此字段可能返回 null,表示取不到有效值。
	Resolution *string `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 转码后文档的最小分辨率,和创建文档时传入的参数一致。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MinScaleResolution *string `json:"MinScaleResolution,omitnil,omitempty" name:"MinScaleResolution"`
}

type EndRoomRequest added in v1.0.641

type EndRoomRequest struct {
	*tchttp.BaseRequest

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewEndRoomRequest added in v1.0.641

func NewEndRoomRequest() (request *EndRoomRequest)

func (*EndRoomRequest) FromJsonString added in v1.0.641

func (r *EndRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EndRoomRequest) ToJsonString added in v1.0.641

func (r *EndRoomRequest) ToJsonString() string

type EndRoomRequestParams added in v1.0.641

type EndRoomRequestParams struct {
	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type EndRoomResponse added in v1.0.641

type EndRoomResponse struct {
	*tchttp.BaseResponse
	Response *EndRoomResponseParams `json:"Response"`
}

func NewEndRoomResponse added in v1.0.641

func NewEndRoomResponse() (response *EndRoomResponse)

func (*EndRoomResponse) FromJsonString added in v1.0.641

func (r *EndRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EndRoomResponse) ToJsonString added in v1.0.641

func (r *EndRoomResponse) ToJsonString() string

type EndRoomResponseParams added in v1.0.641

type EndRoomResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EventDataInfo added in v1.0.620

type EventDataInfo struct {
	// 事件发生的房间号。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 事件发生的用户。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 用户设备类型。0: Unknown; 1: Windows; 2: macOS; 3: Android; 4: iOS; 5: Web; 6: Mobile webpage; 7: Weixin Mini Program.
	// 注意:此字段可能返回 null,表示取不到有效值。
	Device *uint64 `json:"Device,omitnil,omitempty" name:"Device"`

	// 录制时长。单位:秒
	// 注意:此字段可能返回 null,表示取不到有效值。
	Duration *uint64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// 录制文件大小
	// 注意:此字段可能返回 null,表示取不到有效值。
	RecordSize *uint64 `json:"RecordSize,omitnil,omitempty" name:"RecordSize"`

	// 录制url
	// 注意:此字段可能返回 null,表示取不到有效值。
	RecordUrl *string `json:"RecordUrl,omitnil,omitempty" name:"RecordUrl"`
}

type EventInfo added in v1.0.620

type EventInfo struct {
	// 事件发生的秒级unix时间戳。
	Timestamp *uint64 `json:"Timestamp,omitnil,omitempty" name:"Timestamp"`

	// 事件类型,有以下值:
	// RoomStart:房间开始 RoomEnd:房间结束 MemberJoin:成员加入 MemberQuit:成员退出 RecordFinish:录制结束
	// CameraOn: 摄像头打开
	// CameraOff: 摄像头关闭
	// MicOn: 麦克风打开
	// MicOff: 麦克风关闭
	// ScreenOn: 屏幕共享打开
	// ScreenOff: 屏幕共享关闭
	// VisibleOn: 页面可见
	// VisibleOff: 页面不可见
	EventType *string `json:"EventType,omitnil,omitempty" name:"EventType"`

	// 事件详细内容,包含房间号,成员类型事件包含用户Id。
	// 注意:此字段可能返回 null,表示取不到有效值。
	EventData *EventDataInfo `json:"EventData,omitnil,omitempty" name:"EventData"`
}

type FaceMsgContent added in v1.0.769

type FaceMsgContent struct {
	// 表情索引,用户自定义。
	Index *int64 `json:"Index,omitnil,omitempty" name:"Index"`

	// 额外数据。
	Data *string `json:"Data,omitnil,omitempty" name:"Data"`
}

type ForbidSendMsgRequest added in v1.0.787

type ForbidSendMsgRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 需要禁言的用户账号,最多支持500个账号
	MembersAccount []*string `json:"MembersAccount,omitnil,omitempty" name:"MembersAccount"`

	// 需禁言时间,单位为秒,为0时表示取消禁言,4294967295为永久禁言。
	MuteTime *uint64 `json:"MuteTime,omitnil,omitempty" name:"MuteTime"`
}

func NewForbidSendMsgRequest added in v1.0.787

func NewForbidSendMsgRequest() (request *ForbidSendMsgRequest)

func (*ForbidSendMsgRequest) FromJsonString added in v1.0.787

func (r *ForbidSendMsgRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ForbidSendMsgRequest) ToJsonString added in v1.0.787

func (r *ForbidSendMsgRequest) ToJsonString() string

type ForbidSendMsgRequestParams added in v1.0.787

type ForbidSendMsgRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 需要禁言的用户账号,最多支持500个账号
	MembersAccount []*string `json:"MembersAccount,omitnil,omitempty" name:"MembersAccount"`

	// 需禁言时间,单位为秒,为0时表示取消禁言,4294967295为永久禁言。
	MuteTime *uint64 `json:"MuteTime,omitnil,omitempty" name:"MuteTime"`
}

Predefined struct for user

type ForbidSendMsgResponse added in v1.0.787

type ForbidSendMsgResponse struct {
	*tchttp.BaseResponse
	Response *ForbidSendMsgResponseParams `json:"Response"`
}

func NewForbidSendMsgResponse added in v1.0.787

func NewForbidSendMsgResponse() (response *ForbidSendMsgResponse)

func (*ForbidSendMsgResponse) FromJsonString added in v1.0.787

func (r *ForbidSendMsgResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ForbidSendMsgResponse) ToJsonString added in v1.0.787

func (r *ForbidSendMsgResponse) ToJsonString() string

type ForbidSendMsgResponseParams added in v1.0.787

type ForbidSendMsgResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetRoomEventRequest added in v1.0.620

type GetRoomEventRequest struct {
	*tchttp.BaseRequest

	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 应用Id。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 起始页,1开始。keyword为空时有效。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页个数。keyword为空时有效。一次性最多200条。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 搜索事件类型。有以下事件类型:
	// RoomStart:房间开始
	// RoomEnd:房间结束
	// MemberJoin:成员加入
	// MemberQuit:成员退出
	// RecordFinish:录制结束
	// CameraOn: 摄像头打开
	// CameraOff: 摄像头关闭
	// MicOn: 麦克风打开
	// MicOff: 麦克风关闭
	// ScreenOn: 屏幕共享打开
	// ScreenOff: 屏幕共享关闭
	// VisibleOn: 页面可见
	// VisibleOff: 页面不可见
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`
}

func NewGetRoomEventRequest added in v1.0.620

func NewGetRoomEventRequest() (request *GetRoomEventRequest)

func (*GetRoomEventRequest) FromJsonString added in v1.0.620

func (r *GetRoomEventRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomEventRequest) ToJsonString added in v1.0.620

func (r *GetRoomEventRequest) ToJsonString() string

type GetRoomEventRequestParams added in v1.0.620

type GetRoomEventRequestParams struct {
	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 应用Id。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 起始页,1开始。keyword为空时有效。
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 每页个数。keyword为空时有效。一次性最多200条。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 搜索事件类型。有以下事件类型:
	// RoomStart:房间开始
	// RoomEnd:房间结束
	// MemberJoin:成员加入
	// MemberQuit:成员退出
	// RecordFinish:录制结束
	// CameraOn: 摄像头打开
	// CameraOff: 摄像头关闭
	// MicOn: 麦克风打开
	// MicOff: 麦克风关闭
	// ScreenOn: 屏幕共享打开
	// ScreenOff: 屏幕共享关闭
	// VisibleOn: 页面可见
	// VisibleOff: 页面不可见
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`
}

Predefined struct for user

type GetRoomEventResponse added in v1.0.620

type GetRoomEventResponse struct {
	*tchttp.BaseResponse
	Response *GetRoomEventResponseParams `json:"Response"`
}

func NewGetRoomEventResponse added in v1.0.620

func NewGetRoomEventResponse() (response *GetRoomEventResponse)

func (*GetRoomEventResponse) FromJsonString added in v1.0.620

func (r *GetRoomEventResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomEventResponse) ToJsonString added in v1.0.620

func (r *GetRoomEventResponse) ToJsonString() string

type GetRoomEventResponseParams added in v1.0.620

type GetRoomEventResponseParams struct {
	// 该房间的事件总数,keyword搜索不影响该值。
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 详细事件内容。包含相应的类型、发生的时间戳。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Events []*EventInfo `json:"Events,omitnil,omitempty" name:"Events"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetRoomMessageRequest added in v1.0.604

type GetRoomMessageRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 消息序列。获取该序列以前的消息(不包含该seq消息)
	Seq *int64 `json:"Seq,omitnil,omitempty" name:"Seq"`

	// 消息拉取的条数。最大数量不能超过套餐包限制。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewGetRoomMessageRequest added in v1.0.604

func NewGetRoomMessageRequest() (request *GetRoomMessageRequest)

func (*GetRoomMessageRequest) FromJsonString added in v1.0.604

func (r *GetRoomMessageRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomMessageRequest) ToJsonString added in v1.0.604

func (r *GetRoomMessageRequest) ToJsonString() string

type GetRoomMessageRequestParams added in v1.0.604

type GetRoomMessageRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 消息序列。获取该序列以前的消息(不包含该seq消息)
	Seq *int64 `json:"Seq,omitnil,omitempty" name:"Seq"`

	// 消息拉取的条数。最大数量不能超过套餐包限制。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type GetRoomMessageResponse added in v1.0.604

type GetRoomMessageResponse struct {
	*tchttp.BaseResponse
	Response *GetRoomMessageResponseParams `json:"Response"`
}

func NewGetRoomMessageResponse added in v1.0.604

func NewGetRoomMessageResponse() (response *GetRoomMessageResponse)

func (*GetRoomMessageResponse) FromJsonString added in v1.0.604

func (r *GetRoomMessageResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomMessageResponse) ToJsonString added in v1.0.604

func (r *GetRoomMessageResponse) ToJsonString() string

type GetRoomMessageResponseParams added in v1.0.604

type GetRoomMessageResponseParams struct {
	// 消息列表
	Messages []*MessageList `json:"Messages,omitnil,omitempty" name:"Messages"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetRoomsRequest added in v1.0.634

type GetRoomsRequest struct {
	*tchttp.BaseRequest

	// 低代码平台的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 开始时间。默认以当前时间减去半小时作为开始时间。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 结束时间。默认以当前时间加上半小时作为结束时间。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 分页查询当前页数,从1开始递增
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 默认是10条
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 课堂状态。默认展示所有课堂,0为未开始,1为正在上课,2为已结束,3为已过期
	Status []*uint64 `json:"Status,omitnil,omitempty" name:"Status"`
}

func NewGetRoomsRequest added in v1.0.634

func NewGetRoomsRequest() (request *GetRoomsRequest)

func (*GetRoomsRequest) FromJsonString added in v1.0.634

func (r *GetRoomsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomsRequest) ToJsonString added in v1.0.634

func (r *GetRoomsRequest) ToJsonString() string

type GetRoomsRequestParams added in v1.0.634

type GetRoomsRequestParams struct {
	// 低代码平台的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 开始时间。默认以当前时间减去半小时作为开始时间。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 结束时间。默认以当前时间加上半小时作为结束时间。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 分页查询当前页数,从1开始递增
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 默认是10条
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 课堂状态。默认展示所有课堂,0为未开始,1为正在上课,2为已结束,3为已过期
	Status []*uint64 `json:"Status,omitnil,omitempty" name:"Status"`
}

Predefined struct for user

type GetRoomsResponse added in v1.0.634

type GetRoomsResponse struct {
	*tchttp.BaseResponse
	Response *GetRoomsResponseParams `json:"Response"`
}

func NewGetRoomsResponse added in v1.0.634

func NewGetRoomsResponse() (response *GetRoomsResponse)

func (*GetRoomsResponse) FromJsonString added in v1.0.634

func (r *GetRoomsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomsResponse) ToJsonString added in v1.0.634

func (r *GetRoomsResponse) ToJsonString() string

type GetRoomsResponseParams added in v1.0.634

type GetRoomsResponseParams struct {
	// 总数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 房间列表
	Rooms []*RoomItem `json:"Rooms,omitnil,omitempty" name:"Rooms"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetWatermarkRequest added in v1.0.591

type GetWatermarkRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewGetWatermarkRequest added in v1.0.591

func NewGetWatermarkRequest() (request *GetWatermarkRequest)

func (*GetWatermarkRequest) FromJsonString added in v1.0.591

func (r *GetWatermarkRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetWatermarkRequest) ToJsonString added in v1.0.591

func (r *GetWatermarkRequest) ToJsonString() string

type GetWatermarkRequestParams added in v1.0.591

type GetWatermarkRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type GetWatermarkResponse added in v1.0.591

type GetWatermarkResponse struct {
	*tchttp.BaseResponse
	Response *GetWatermarkResponseParams `json:"Response"`
}

func NewGetWatermarkResponse added in v1.0.591

func NewGetWatermarkResponse() (response *GetWatermarkResponse)

func (*GetWatermarkResponse) FromJsonString added in v1.0.591

func (r *GetWatermarkResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetWatermarkResponse) ToJsonString added in v1.0.591

func (r *GetWatermarkResponse) ToJsonString() string

type GetWatermarkResponseParams added in v1.0.591

type GetWatermarkResponseParams struct {
	// 注意:此字段可能返回 null,表示取不到有效值。
	TeacherLogo *WatermarkConfig `json:"TeacherLogo,omitnil,omitempty" name:"TeacherLogo"`

	// 注意:此字段可能返回 null,表示取不到有效值。
	BoardLogo *WatermarkConfig `json:"BoardLogo,omitnil,omitempty" name:"BoardLogo"`

	// 背景图片配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	BackgroundPicture *BackgroundPictureConfig `json:"BackgroundPicture,omitnil,omitempty" name:"BackgroundPicture"`

	// 文字水印配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	Text *TextMarkConfig `json:"Text,omitnil,omitempty" name:"Text"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GroupBaseInfo added in v1.0.597

type GroupBaseInfo struct {
	// 待创建群组名
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// 群组主讲人ID
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`
}

type GroupInfo added in v1.0.597

type GroupInfo struct {
	// 群组ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 群组名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// 群组主讲人ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 群组类型
	// 0-基础群组
	// 1-组合群组,若为1时会返回子群组ID列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	GroupType *uint64 `json:"GroupType,omitnil,omitempty" name:"GroupType"`

	// 子群组ID列表,如有。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SubGroupIds *string `json:"SubGroupIds,omitnil,omitempty" name:"SubGroupIds"`
}

type ImageInfo added in v1.0.769

type ImageInfo struct {
	// 图片类型:
	// 1-原图
	// 2-大图
	// 3-缩略图
	Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`

	// 图片数据大小,单位:字节。
	Size *uint64 `json:"Size,omitnil,omitempty" name:"Size"`

	// 图片宽度,单位为像素。
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// 图片高度,单位为像素。
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// 图片下载地址。
	URL *string `json:"URL,omitnil,omitempty" name:"URL"`
}

type ImageMsgContent added in v1.0.769

type ImageMsgContent struct {
	// 图片的唯一标识,客户端用于索引图片的键值。
	UUID *string `json:"UUID,omitnil,omitempty" name:"UUID"`

	// 图片格式。
	// JPG = 1
	// GIF = 2
	// PNG = 3
	// BMP = 4
	// 其他 = 255
	ImageFormat *uint64 `json:"ImageFormat,omitnil,omitempty" name:"ImageFormat"`

	// 图片信息
	ImageInfoList []*ImageInfo `json:"ImageInfoList,omitnil,omitempty" name:"ImageInfoList"`
}

type KickUserFromRoomRequest added in v1.0.657

type KickUserFromRoomRequest struct {
	*tchttp.BaseRequest

	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 低代码平台的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 需要踢出成员Id
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 踢出类型:
	// 1:临时踢出,可以使用Duration参数指定污点时间,污点时间间隔内用户无法进入房间。
	// 2:永久踢出
	KickType *uint64 `json:"KickType,omitnil,omitempty" name:"KickType"`

	// 污点时间(单位秒),KickType = 1时生效,默认为0
	Duration *uint64 `json:"Duration,omitnil,omitempty" name:"Duration"`
}

func NewKickUserFromRoomRequest added in v1.0.657

func NewKickUserFromRoomRequest() (request *KickUserFromRoomRequest)

func (*KickUserFromRoomRequest) FromJsonString added in v1.0.657

func (r *KickUserFromRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*KickUserFromRoomRequest) ToJsonString added in v1.0.657

func (r *KickUserFromRoomRequest) ToJsonString() string

type KickUserFromRoomRequestParams added in v1.0.657

type KickUserFromRoomRequestParams struct {
	// 房间Id。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 低代码平台的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 需要踢出成员Id
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 踢出类型:
	// 1:临时踢出,可以使用Duration参数指定污点时间,污点时间间隔内用户无法进入房间。
	// 2:永久踢出
	KickType *uint64 `json:"KickType,omitnil,omitempty" name:"KickType"`

	// 污点时间(单位秒),KickType = 1时生效,默认为0
	Duration *uint64 `json:"Duration,omitnil,omitempty" name:"Duration"`
}

Predefined struct for user

type KickUserFromRoomResponse added in v1.0.657

type KickUserFromRoomResponse struct {
	*tchttp.BaseResponse
	Response *KickUserFromRoomResponseParams `json:"Response"`
}

func NewKickUserFromRoomResponse added in v1.0.657

func NewKickUserFromRoomResponse() (response *KickUserFromRoomResponse)

func (*KickUserFromRoomResponse) FromJsonString added in v1.0.657

func (r *KickUserFromRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*KickUserFromRoomResponse) ToJsonString added in v1.0.657

func (r *KickUserFromRoomResponse) ToJsonString() string

type KickUserFromRoomResponseParams added in v1.0.657

type KickUserFromRoomResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type LoginOriginIdRequest

type LoginOriginIdRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户在客户系统的Id,需要在同一应用下唯一。
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`
}

func NewLoginOriginIdRequest

func NewLoginOriginIdRequest() (request *LoginOriginIdRequest)

func (*LoginOriginIdRequest) FromJsonString

func (r *LoginOriginIdRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LoginOriginIdRequest) ToJsonString

func (r *LoginOriginIdRequest) ToJsonString() string

type LoginOriginIdRequestParams

type LoginOriginIdRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户在客户系统的Id,需要在同一应用下唯一。
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`
}

Predefined struct for user

type LoginOriginIdResponse

type LoginOriginIdResponse struct {
	*tchttp.BaseResponse
	Response *LoginOriginIdResponseParams `json:"Response"`
}

func NewLoginOriginIdResponse

func NewLoginOriginIdResponse() (response *LoginOriginIdResponse)

func (*LoginOriginIdResponse) FromJsonString

func (r *LoginOriginIdResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LoginOriginIdResponse) ToJsonString

func (r *LoginOriginIdResponse) ToJsonString() string

type LoginOriginIdResponseParams

type LoginOriginIdResponseParams struct {
	// 用户Id。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 登录/注册成功后返回登录态token。有效期7天。
	Token *string `json:"Token,omitnil,omitempty" name:"Token"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type LoginUserRequest

type LoginUserRequest struct {
	*tchttp.BaseRequest

	// 注册获取的用户id。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewLoginUserRequest

func NewLoginUserRequest() (request *LoginUserRequest)

func (*LoginUserRequest) FromJsonString

func (r *LoginUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LoginUserRequest) ToJsonString

func (r *LoginUserRequest) ToJsonString() string

type LoginUserRequestParams

type LoginUserRequestParams struct {
	// 注册获取的用户id。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type LoginUserResponse

type LoginUserResponse struct {
	*tchttp.BaseResponse
	Response *LoginUserResponseParams `json:"Response"`
}

func NewLoginUserResponse

func NewLoginUserResponse() (response *LoginUserResponse)

func (*LoginUserResponse) FromJsonString

func (r *LoginUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LoginUserResponse) ToJsonString

func (r *LoginUserResponse) ToJsonString() string

type LoginUserResponseParams

type LoginUserResponseParams struct {
	// 用户Id。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 注册成功后返回登录态token,有效期7天。token过期后可以通过调用“登录”或“源账号登录”进行更新。
	Token *string `json:"Token,omitnil,omitempty" name:"Token"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type MemberRecord added in v1.0.517

type MemberRecord struct {
	// 用户ID。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 用户名称。
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 在线时长,单位秒。
	PresentTime *uint64 `json:"PresentTime,omitnil,omitempty" name:"PresentTime"`

	// 是否开启摄像头。
	Camera *uint64 `json:"Camera,omitnil,omitempty" name:"Camera"`

	// 是否开启麦克风。
	Mic *uint64 `json:"Mic,omitnil,omitempty" name:"Mic"`

	// 是否禁言。
	Silence *uint64 `json:"Silence,omitnil,omitempty" name:"Silence"`

	// 回答问题数量。
	AnswerQuestions *uint64 `json:"AnswerQuestions,omitnil,omitempty" name:"AnswerQuestions"`

	// 举手数量。
	HandUps *uint64 `json:"HandUps,omitnil,omitempty" name:"HandUps"`

	// 首次进入房间的unix时间戳。
	FirstJoinTimestamp *uint64 `json:"FirstJoinTimestamp,omitnil,omitempty" name:"FirstJoinTimestamp"`

	// 最后一次退出房间的unix时间戳。
	LastQuitTimestamp *uint64 `json:"LastQuitTimestamp,omitnil,omitempty" name:"LastQuitTimestamp"`

	// 奖励次数。
	Rewords *uint64 `json:"Rewords,omitnil,omitempty" name:"Rewords"`

	// 用户IP。
	IPAddress *string `json:"IPAddress,omitnil,omitempty" name:"IPAddress"`

	// 用户位置信息。
	Location *string `json:"Location,omitnil,omitempty" name:"Location"`

	// 用户设备平台信息。0:unknown  1:windows  2:mac  3:android  4:ios  5:web   6:h5   7:miniprogram (小程序)
	Device *int64 `json:"Device,omitnil,omitempty" name:"Device"`

	// 每个成员上麦次数。
	PerMemberMicCount *int64 `json:"PerMemberMicCount,omitnil,omitempty" name:"PerMemberMicCount"`

	// 每个成员发送消息数量。
	PerMemberMessageCount *int64 `json:"PerMemberMessageCount,omitnil,omitempty" name:"PerMemberMessageCount"`

	// 用户角色。0代表学生;1代表老师; 2助教;3巡课。
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// 上课班号
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 子上课班号
	// 注意:此字段可能返回 null,表示取不到有效值。
	SubGroupId []*string `json:"SubGroupId,omitnil,omitempty" name:"SubGroupId"`

	// 用户的上台状态
	// 注意:此字段可能返回 null,表示取不到有效值。
	Stage *int64 `json:"Stage,omitnil,omitempty" name:"Stage"`

	// 用户状态。0为未到,1为在线,2为离线,3为被踢,4为永久被踢,5为暂时掉线
	// 注意:此字段可能返回 null,表示取不到有效值。
	CurrentState *uint64 `json:"CurrentState,omitnil,omitempty" name:"CurrentState"`
}

type MessageItem added in v1.0.604

type MessageItem struct {
	// 消息类型。0表示文本消息,1表示图片消息
	// 注意:此字段可能返回 null,表示取不到有效值。
	MessageType *int64 `json:"MessageType,omitnil,omitempty" name:"MessageType"`

	// 文本消息内容。message type为0时有效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TextMessage *string `json:"TextMessage,omitnil,omitempty" name:"TextMessage"`

	// 图片消息URL。 message type为1时有效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ImageMessage *string `json:"ImageMessage,omitnil,omitempty" name:"ImageMessage"`

	// 自定义消息内容。message type为2时有效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CustomMessage *CustomMsgContent `json:"CustomMessage,omitnil,omitempty" name:"CustomMessage"`
}

type MessageList added in v1.0.604

type MessageList struct {
	// 消息时间戳
	// 注意:此字段可能返回 null,表示取不到有效值。
	Timestamp *int64 `json:"Timestamp,omitnil,omitempty" name:"Timestamp"`

	// 消息发送者
	// 注意:此字段可能返回 null,表示取不到有效值。
	FromAccount *string `json:"FromAccount,omitnil,omitempty" name:"FromAccount"`

	// 消息序列号,当前课堂内唯一且单调递增
	// 注意:此字段可能返回 null,表示取不到有效值。
	Seq *int64 `json:"Seq,omitnil,omitempty" name:"Seq"`

	// 历史消息列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	MessageBody []*MessageItem `json:"MessageBody,omitnil,omitempty" name:"MessageBody"`
}

type ModifyAppRequest added in v1.0.517

type ModifyAppRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 回调地址。
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// 回调key。
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

	// 转存id
	TransferId *string `json:"TransferId,omitnil,omitempty" name:"TransferId"`

	// 转存地址
	TransferUrl *string `json:"TransferUrl,omitnil,omitempty" name:"TransferUrl"`
}

func NewModifyAppRequest added in v1.0.517

func NewModifyAppRequest() (request *ModifyAppRequest)

func (*ModifyAppRequest) FromJsonString added in v1.0.517

func (r *ModifyAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyAppRequest) ToJsonString added in v1.0.517

func (r *ModifyAppRequest) ToJsonString() string

type ModifyAppRequestParams added in v1.0.517

type ModifyAppRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 回调地址。
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// 回调key。
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

	// 转存id
	TransferId *string `json:"TransferId,omitnil,omitempty" name:"TransferId"`

	// 转存地址
	TransferUrl *string `json:"TransferUrl,omitnil,omitempty" name:"TransferUrl"`
}

Predefined struct for user

type ModifyAppResponse added in v1.0.517

type ModifyAppResponse struct {
	*tchttp.BaseResponse
	Response *ModifyAppResponseParams `json:"Response"`
}

func NewModifyAppResponse added in v1.0.517

func NewModifyAppResponse() (response *ModifyAppResponse)

func (*ModifyAppResponse) FromJsonString added in v1.0.517

func (r *ModifyAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyAppResponse) ToJsonString added in v1.0.517

func (r *ModifyAppResponse) ToJsonString() string

type ModifyAppResponseParams added in v1.0.517

type ModifyAppResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyGroupRequest added in v1.0.597

type ModifyGroupRequest struct {
	*tchttp.BaseRequest

	// 需要修改的群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 默认绑定主讲老师ID
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 待修改的群组名称
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`
}

func NewModifyGroupRequest added in v1.0.597

func NewModifyGroupRequest() (request *ModifyGroupRequest)

func (*ModifyGroupRequest) FromJsonString added in v1.0.597

func (r *ModifyGroupRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyGroupRequest) ToJsonString added in v1.0.597

func (r *ModifyGroupRequest) ToJsonString() string

type ModifyGroupRequestParams added in v1.0.597

type ModifyGroupRequestParams struct {
	// 需要修改的群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 低代码平台应用ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 默认绑定主讲老师ID
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 待修改的群组名称
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`
}

Predefined struct for user

type ModifyGroupResponse added in v1.0.597

type ModifyGroupResponse struct {
	*tchttp.BaseResponse
	Response *ModifyGroupResponseParams `json:"Response"`
}

func NewModifyGroupResponse added in v1.0.597

func NewModifyGroupResponse() (response *ModifyGroupResponse)

func (*ModifyGroupResponse) FromJsonString added in v1.0.597

func (r *ModifyGroupResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyGroupResponse) ToJsonString added in v1.0.597

func (r *ModifyGroupResponse) ToJsonString() string

type ModifyGroupResponseParams added in v1.0.597

type ModifyGroupResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyRoomRequest added in v1.0.586

type ModifyRoomRequest struct {
	*tchttp.BaseRequest

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 低代码互动课堂的SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 预定的房间开始时间,unix时间戳(秒)。直播开始后不允许修改。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 预定的房间结束时间,unix时间戳(秒)。直播开始后不允许修改。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 老师ID。直播开始后不允许修改。
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 房间名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 分辨率。可以有如下取值:
	// 1 标清
	// 2 高清
	// 3 全高清
	// 直播开始后不允许修改。
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// 进入房间时是否自动连麦。可以有以下取值:
	// 0 不自动连麦(默认值)
	// 1 自动连麦
	// 直播开始后不允许修改。
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// 高音质模式。可以有以下取值:
	// 0 不开启高音质(默认值)
	// 1 开启高音质
	// 直播开始后不允许修改。
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// 房间子类型,可以有以下取值:
	// videodoc 文档+视频
	// video 纯视频
	// 直播开始后不允许修改。
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// 禁止录制。可以有以下取值:
	// 0 不禁止录制(默认值)
	// 1 禁止录制
	// 直播开始后不允许修改。
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// 助教Id列表。直播开始后不允许修改。
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// 房间绑定的群组ID。直播开始后不允许修改。
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 打开学生麦克风/摄像头的授权开关。直播开始后不允许修改。
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// 开启专注模式。
	// 0 收看全部角色音视频(默认)
	// 1 只看老师和助教
	InteractionMode *uint64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
	VideoOrientation *uint64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// 开启课后评分。 0:不开启(默认)  1:开启
	IsGradingRequiredPostClass *uint64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数、暂未开放)
	// 注:大班课的布局(layout)只有三分屏
	RoomType *uint64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// 录制模板。仅可修改还未开始的房间。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
	RecordLayout *uint64 `json:"RecordLayout,omitnil,omitempty" name:"RecordLayout"`

	// 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// 直播方式:0 常规模式(默认)1 回放直播模式(伪直播)。 目前支持从回放直播模式(伪直播)改为常规模式,不支持从常规模式改为回放直播模式(伪直播)
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// 伪直播链接
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// 录制自定义场景,仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// 录制自定义语言,仅recordlayout=9的时候此参数有效
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

func NewModifyRoomRequest added in v1.0.586

func NewModifyRoomRequest() (request *ModifyRoomRequest)

func (*ModifyRoomRequest) FromJsonString added in v1.0.586

func (r *ModifyRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyRoomRequest) ToJsonString added in v1.0.586

func (r *ModifyRoomRequest) ToJsonString() string

type ModifyRoomRequestParams added in v1.0.586

type ModifyRoomRequestParams struct {
	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 低代码互动课堂的SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 预定的房间开始时间,unix时间戳(秒)。直播开始后不允许修改。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 预定的房间结束时间,unix时间戳(秒)。直播开始后不允许修改。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 老师ID。直播开始后不允许修改。
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 房间名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 分辨率。可以有如下取值:
	// 1 标清
	// 2 高清
	// 3 全高清
	// 直播开始后不允许修改。
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// 进入房间时是否自动连麦。可以有以下取值:
	// 0 不自动连麦(默认值)
	// 1 自动连麦
	// 直播开始后不允许修改。
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// 高音质模式。可以有以下取值:
	// 0 不开启高音质(默认值)
	// 1 开启高音质
	// 直播开始后不允许修改。
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// 房间子类型,可以有以下取值:
	// videodoc 文档+视频
	// video 纯视频
	// 直播开始后不允许修改。
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// 禁止录制。可以有以下取值:
	// 0 不禁止录制(默认值)
	// 1 禁止录制
	// 直播开始后不允许修改。
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// 助教Id列表。直播开始后不允许修改。
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// 房间绑定的群组ID。直播开始后不允许修改。
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 打开学生麦克风/摄像头的授权开关。直播开始后不允许修改。
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// 开启专注模式。
	// 0 收看全部角色音视频(默认)
	// 1 只看老师和助教
	InteractionMode *uint64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
	VideoOrientation *uint64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// 开启课后评分。 0:不开启(默认)  1:开启
	IsGradingRequiredPostClass *uint64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数、暂未开放)
	// 注:大班课的布局(layout)只有三分屏
	RoomType *uint64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// 录制模板。仅可修改还未开始的房间。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
	RecordLayout *uint64 `json:"RecordLayout,omitnil,omitempty" name:"RecordLayout"`

	// 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// 直播方式:0 常规模式(默认)1 回放直播模式(伪直播)。 目前支持从回放直播模式(伪直播)改为常规模式,不支持从常规模式改为回放直播模式(伪直播)
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// 伪直播链接
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// 录制自定义场景,仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// 录制自定义语言,仅recordlayout=9的时候此参数有效
	//
	// Deprecated: RecordLang is deprecated.
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

Predefined struct for user

type ModifyRoomResponse added in v1.0.586

type ModifyRoomResponse struct {
	*tchttp.BaseResponse
	Response *ModifyRoomResponseParams `json:"Response"`
}

func NewModifyRoomResponse added in v1.0.586

func NewModifyRoomResponse() (response *ModifyRoomResponse)

func (*ModifyRoomResponse) FromJsonString added in v1.0.586

func (r *ModifyRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyRoomResponse) ToJsonString added in v1.0.586

func (r *ModifyRoomResponse) ToJsonString() string

type ModifyRoomResponseParams added in v1.0.586

type ModifyRoomResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyUserProfileRequest added in v1.0.591

type ModifyUserProfileRequest struct {
	*tchttp.BaseRequest

	// 待修改用户ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 待修改的用户名
	Nickname *string `json:"Nickname,omitnil,omitempty" name:"Nickname"`

	// 待修改头像url
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

func NewModifyUserProfileRequest added in v1.0.591

func NewModifyUserProfileRequest() (request *ModifyUserProfileRequest)

func (*ModifyUserProfileRequest) FromJsonString added in v1.0.591

func (r *ModifyUserProfileRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUserProfileRequest) ToJsonString added in v1.0.591

func (r *ModifyUserProfileRequest) ToJsonString() string

type ModifyUserProfileRequestParams added in v1.0.591

type ModifyUserProfileRequestParams struct {
	// 待修改用户ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 待修改的用户名
	Nickname *string `json:"Nickname,omitnil,omitempty" name:"Nickname"`

	// 待修改头像url
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

Predefined struct for user

type ModifyUserProfileResponse added in v1.0.591

type ModifyUserProfileResponse struct {
	*tchttp.BaseResponse
	Response *ModifyUserProfileResponseParams `json:"Response"`
}

func NewModifyUserProfileResponse added in v1.0.591

func NewModifyUserProfileResponse() (response *ModifyUserProfileResponse)

func (*ModifyUserProfileResponse) FromJsonString added in v1.0.591

func (r *ModifyUserProfileResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUserProfileResponse) ToJsonString added in v1.0.591

func (r *ModifyUserProfileResponse) ToJsonString() string

type ModifyUserProfileResponseParams added in v1.0.591

type ModifyUserProfileResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type MsgBody added in v1.0.769

type MsgBody struct {
	// TIM 消息对象类型,目前支持的消息对象包括:
	// TIMTextElem(文本消息)
	// TIMFaceElem(表情消息)
	// TIMImageElem(图像消息)
	// TIMCustomElem(自定义消息)
	MsgType *string `json:"MsgType,omitnil,omitempty" name:"MsgType"`

	// 文本消息,当MsgType 为TIMTextElem(文本消息)必选。
	TextMsgContent *TextMsgContent `json:"TextMsgContent,omitnil,omitempty" name:"TextMsgContent"`

	// 表情消息,当MsgType 为TIMFaceElem(表情消息)必选。
	FaceMsgContent *FaceMsgContent `json:"FaceMsgContent,omitnil,omitempty" name:"FaceMsgContent"`

	// 图像消息,当MsgType为TIMImageElem(图像消息)必选。
	ImageMsgContent *ImageMsgContent `json:"ImageMsgContent,omitnil,omitempty" name:"ImageMsgContent"`

	// 自定义消息,TIMCustomElem(自定义消息)必选。
	CustomMsgContent *CustomMsgContent `json:"CustomMsgContent,omitnil,omitempty" name:"CustomMsgContent"`
}

type MutedAccountList added in v1.0.787

type MutedAccountList struct {
	// 用户 ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	MemberAccount *string `json:"MemberAccount,omitnil,omitempty" name:"MemberAccount"`

	// 禁言到的时间(使用 UTC 时间,即世界协调时间)
	// 注意:此字段可能返回 null,表示取不到有效值。
	MutedUntil *uint64 `json:"MutedUntil,omitnil,omitempty" name:"MutedUntil"`
}

type QuestionInfo added in v1.0.629

type QuestionInfo struct {
	// 问题ID
	QuestionId *string `json:"QuestionId,omitnil,omitempty" name:"QuestionId"`

	// 问题内容
	QuestionContent *string `json:"QuestionContent,omitnil,omitempty" name:"QuestionContent"`

	// 倒计时答题设置的秒数(0 表示不计时)
	Duration *uint64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// 正确答案(按照位表示是否选择,如0x1表示选择A,0x11表示选择AB)
	CorrectAnswer *int64 `json:"CorrectAnswer,omitnil,omitempty" name:"CorrectAnswer"`

	// 每个选项答题人数统计
	// 注意:此字段可能返回 null,表示取不到有效值。
	AnswerStats []*AnswerStat `json:"AnswerStats,omitnil,omitempty" name:"AnswerStats"`
}

type RegisterUserRequest

type RegisterUserRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 用户在客户系统的Id,需要在同一应用下唯一。
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`

	// 用户头像。
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

func NewRegisterUserRequest

func NewRegisterUserRequest() (request *RegisterUserRequest)

func (*RegisterUserRequest) FromJsonString

func (r *RegisterUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RegisterUserRequest) ToJsonString

func (r *RegisterUserRequest) ToJsonString() string

type RegisterUserRequestParams

type RegisterUserRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 用户在客户系统的Id,需要在同一应用下唯一。
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`

	// 用户头像。
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

Predefined struct for user

type RegisterUserResponse

type RegisterUserResponse struct {
	*tchttp.BaseResponse
	Response *RegisterUserResponseParams `json:"Response"`
}

func NewRegisterUserResponse

func NewRegisterUserResponse() (response *RegisterUserResponse)

func (*RegisterUserResponse) FromJsonString

func (r *RegisterUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RegisterUserResponse) ToJsonString

func (r *RegisterUserResponse) ToJsonString() string

type RegisterUserResponseParams

type RegisterUserResponseParams struct {
	// 用户Id。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 登录/注册成功后返回登录态token。有效期7天。
	Token *string `json:"Token,omitnil,omitempty" name:"Token"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RoomInfo added in v1.0.591

type RoomInfo struct {
	// 房间名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 预定的房间开始时间,unix时间戳。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 预定的房间结束时间,unix时间戳。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// 老师ID。通过[注册用户]接口获取的UserId。
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// 进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// 释放音视频权限后是否自动取消连麦。可以有以下取值: 0 自动取消连麦(默认值) 1 保持连麦状态
	TurnOffMic *uint64 `json:"TurnOffMic,omitnil,omitempty" name:"TurnOffMic"`

	// 高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// 上课后是否禁止自动录制。可以有以下取值: 0 不禁止录制(自动开启录制,默认值) 1 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// 助教Id列表。通过[注册用户]接口获取的UserId。
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// rtc人数。
	RTCAudienceNumber *uint64 `json:"RTCAudienceNumber,omitnil,omitempty" name:"RTCAudienceNumber"`

	// 观看类型。
	AudienceType *uint64 `json:"AudienceType,omitnil,omitempty" name:"AudienceType"`

	// 录制布局。
	RecordLayout *uint64 `json:"RecordLayout,omitnil,omitempty" name:"RecordLayout"`

	// 房间绑定的群组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 打开学生麦克风/摄像头的授权开关
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
	VideoOrientation *int64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// 开启课后评分。 0:不开启(默认)  1:开启
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
	// 注:大班课的布局(layout)只有三分屏
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// 直播类型:0 常规(默认)1 伪直播
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// 伪直播回放链接
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// 录制自定义场景,仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// 录制自定义语言,仅recordlayout=9的时候此参数有效
	//
	// Deprecated: RecordLang is deprecated.
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

type RoomItem added in v1.0.634

type RoomItem struct {
	// 名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 房间ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 房间状态。0 未开始 ;1进行中  ;2 已结束;3已过期
	// 注意:此字段可能返回 null,表示取不到有效值。
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 开始时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 结束时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 实际开始时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	RealStartTime *uint64 `json:"RealStartTime,omitnil,omitempty" name:"RealStartTime"`

	// 实际结束时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	RealEndTime *uint64 `json:"RealEndTime,omitnil,omitempty" name:"RealEndTime"`

	// 分辨率。1 标清
	// 2 高清
	// 3 全高清
	// 注意:此字段可能返回 null,表示取不到有效值。
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 最大允许连麦人数
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRTCMember *uint64 `json:"MaxRTCMember,omitnil,omitempty" name:"MaxRTCMember"`

	// 房间录制地址。已废弃,使用新字段 RecordUrl
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReplayUrl *string `json:"ReplayUrl,omitnil,omitempty" name:"ReplayUrl"`

	// 录制地址(协议为https)。仅在房间结束后存在。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RecordUrl *string `json:"RecordUrl,omitnil,omitempty" name:"RecordUrl"`

	// 最高房间内人数(不包括老师),0表示不限制,默认为0
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// 打开学生麦克风/摄像头的授权开关
	// 注意:此字段可能返回 null,表示取不到有效值。
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
	// 注意:此字段可能返回 null,表示取不到有效值。
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	VideoOrientation *int64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// 开启课后评分。 0:不开启(默认)  1:开启
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// 房间类型。0:小班课(默认值);1:大班课;2:1V1(后续扩展)
	// 注:大班课的布局(layout)只有三分屏
	// 注意:此字段可能返回 null,表示取不到有效值。
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
	// 注意:此字段可能返回 null,表示取不到有效值。
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// 直播类型:0 常规(默认)1 伪直播
	// 注意:此字段可能返回 null,表示取不到有效值。
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// 伪直播回放链接
	// 注意:此字段可能返回 null,表示取不到有效值。
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
	// 注意:此字段可能返回 null,表示取不到有效值。
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
	// 注意:此字段可能返回 null,表示取不到有效值。
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// 录制自定义场景,仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// 录制自定义语言,仅recordlayout=9的时候此参数有效
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

type SceneItem added in v1.0.580

type SceneItem struct {
	// 场景名称
	Scene *string `json:"Scene,omitnil,omitempty" name:"Scene"`

	// logo地址
	// 注意:此字段可能返回 null,表示取不到有效值。
	LogoUrl *string `json:"LogoUrl,omitnil,omitempty" name:"LogoUrl"`

	// 主页地址
	// 注意:此字段可能返回 null,表示取不到有效值。
	HomeUrl *string `json:"HomeUrl,omitnil,omitempty" name:"HomeUrl"`

	// 自定义的js
	// 注意:此字段可能返回 null,表示取不到有效值。
	JSUrl *string `json:"JSUrl,omitnil,omitempty" name:"JSUrl"`

	// 自定义的css
	// 注意:此字段可能返回 null,表示取不到有效值。
	CSSUrl *string `json:"CSSUrl,omitnil,omitempty" name:"CSSUrl"`
}

type SendRoomNormalMessageRequest added in v1.0.769

type SendRoomNormalMessageRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 管理员指定消息发送方账号(若需设置 FromAccount 信息,则该参数取值不能为空)
	FromAccount *string `json:"FromAccount,omitnil,omitempty" name:"FromAccount"`

	// 自定义消息
	MsgBody []*MsgBody `json:"MsgBody,omitnil,omitempty" name:"MsgBody"`

	// 消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到)。
	CloudCustomData *string `json:"CloudCustomData,omitnil,omitempty" name:"CloudCustomData"`

	// 昵称,当FromAccount没有在房间中,需要填写NickName,当FromAccount在房间中,填写NickName无意义
	NickName *string `json:"NickName,omitnil,omitempty" name:"NickName"`
}

func NewSendRoomNormalMessageRequest added in v1.0.769

func NewSendRoomNormalMessageRequest() (request *SendRoomNormalMessageRequest)

func (*SendRoomNormalMessageRequest) FromJsonString added in v1.0.769

func (r *SendRoomNormalMessageRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SendRoomNormalMessageRequest) ToJsonString added in v1.0.769

func (r *SendRoomNormalMessageRequest) ToJsonString() string

type SendRoomNormalMessageRequestParams added in v1.0.769

type SendRoomNormalMessageRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 管理员指定消息发送方账号(若需设置 FromAccount 信息,则该参数取值不能为空)
	FromAccount *string `json:"FromAccount,omitnil,omitempty" name:"FromAccount"`

	// 自定义消息
	MsgBody []*MsgBody `json:"MsgBody,omitnil,omitempty" name:"MsgBody"`

	// 消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到)。
	CloudCustomData *string `json:"CloudCustomData,omitnil,omitempty" name:"CloudCustomData"`

	// 昵称,当FromAccount没有在房间中,需要填写NickName,当FromAccount在房间中,填写NickName无意义
	NickName *string `json:"NickName,omitnil,omitempty" name:"NickName"`
}

Predefined struct for user

type SendRoomNormalMessageResponse added in v1.0.769

type SendRoomNormalMessageResponse struct {
	*tchttp.BaseResponse
	Response *SendRoomNormalMessageResponseParams `json:"Response"`
}

func NewSendRoomNormalMessageResponse added in v1.0.769

func NewSendRoomNormalMessageResponse() (response *SendRoomNormalMessageResponse)

func (*SendRoomNormalMessageResponse) FromJsonString added in v1.0.769

func (r *SendRoomNormalMessageResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SendRoomNormalMessageResponse) ToJsonString added in v1.0.769

func (r *SendRoomNormalMessageResponse) ToJsonString() string

type SendRoomNormalMessageResponseParams added in v1.0.769

type SendRoomNormalMessageResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SendRoomNotificationMessageRequest added in v1.0.769

type SendRoomNotificationMessageRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 消息。
	MsgContent *string `json:"MsgContent,omitnil,omitempty" name:"MsgContent"`
}

func NewSendRoomNotificationMessageRequest added in v1.0.769

func NewSendRoomNotificationMessageRequest() (request *SendRoomNotificationMessageRequest)

func (*SendRoomNotificationMessageRequest) FromJsonString added in v1.0.769

func (r *SendRoomNotificationMessageRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SendRoomNotificationMessageRequest) ToJsonString added in v1.0.769

func (r *SendRoomNotificationMessageRequest) ToJsonString() string

type SendRoomNotificationMessageRequestParams added in v1.0.769

type SendRoomNotificationMessageRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 消息。
	MsgContent *string `json:"MsgContent,omitnil,omitempty" name:"MsgContent"`
}

Predefined struct for user

type SendRoomNotificationMessageResponse added in v1.0.769

type SendRoomNotificationMessageResponse struct {
	*tchttp.BaseResponse
	Response *SendRoomNotificationMessageResponseParams `json:"Response"`
}

func NewSendRoomNotificationMessageResponse added in v1.0.769

func NewSendRoomNotificationMessageResponse() (response *SendRoomNotificationMessageResponse)

func (*SendRoomNotificationMessageResponse) FromJsonString added in v1.0.769

func (r *SendRoomNotificationMessageResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SendRoomNotificationMessageResponse) ToJsonString added in v1.0.769

func (r *SendRoomNotificationMessageResponse) ToJsonString() string

type SendRoomNotificationMessageResponseParams added in v1.0.769

type SendRoomNotificationMessageResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetAppCustomContentRequest added in v1.0.514

type SetAppCustomContentRequest struct {
	*tchttp.BaseRequest

	// 自定义内容。
	CustomContent []*AppCustomContent `json:"CustomContent,omitnil,omitempty" name:"CustomContent"`

	// 应用ID。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewSetAppCustomContentRequest added in v1.0.514

func NewSetAppCustomContentRequest() (request *SetAppCustomContentRequest)

func (*SetAppCustomContentRequest) FromJsonString added in v1.0.514

func (r *SetAppCustomContentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetAppCustomContentRequest) ToJsonString added in v1.0.514

func (r *SetAppCustomContentRequest) ToJsonString() string

type SetAppCustomContentRequestParams added in v1.0.514

type SetAppCustomContentRequestParams struct {
	// 自定义内容。
	CustomContent []*AppCustomContent `json:"CustomContent,omitnil,omitempty" name:"CustomContent"`

	// 应用ID。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type SetAppCustomContentResponse added in v1.0.514

type SetAppCustomContentResponse struct {
	*tchttp.BaseResponse
	Response *SetAppCustomContentResponseParams `json:"Response"`
}

func NewSetAppCustomContentResponse added in v1.0.514

func NewSetAppCustomContentResponse() (response *SetAppCustomContentResponse)

func (*SetAppCustomContentResponse) FromJsonString added in v1.0.514

func (r *SetAppCustomContentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetAppCustomContentResponse) ToJsonString added in v1.0.514

func (r *SetAppCustomContentResponse) ToJsonString() string

type SetAppCustomContentResponseParams added in v1.0.514

type SetAppCustomContentResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetWatermarkRequest added in v1.0.591

type SetWatermarkRequest struct {
	*tchttp.BaseRequest

	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 老师视频区域的水印参数地址,设置为空字符串表示删除
	TeacherUrl *string `json:"TeacherUrl,omitnil,omitempty" name:"TeacherUrl"`

	// 白板视频区域的水印参数地址,设置为空字符串表示删除
	BoardUrl *string `json:"BoardUrl,omitnil,omitempty" name:"BoardUrl"`

	// 视频默认图片(在没有视频流的时候显示),设置为空字符串表示删除
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`

	// 白板区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
	BoardW *float64 `json:"BoardW,omitnil,omitempty" name:"BoardW"`

	// 白板区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
	BoardH *float64 `json:"BoardH,omitnil,omitempty" name:"BoardH"`

	// 白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
	BoardX *float64 `json:"BoardX,omitnil,omitempty" name:"BoardX"`

	// 白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
	BoardY *float64 `json:"BoardY,omitnil,omitempty" name:"BoardY"`

	// 老师视频区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
	TeacherW *float64 `json:"TeacherW,omitnil,omitempty" name:"TeacherW"`

	// 老师视频区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
	TeacherH *float64 `json:"TeacherH,omitnil,omitempty" name:"TeacherH"`

	// 老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
	TeacherX *float64 `json:"TeacherX,omitnil,omitempty" name:"TeacherX"`

	// 老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
	TeacherY *float64 `json:"TeacherY,omitnil,omitempty" name:"TeacherY"`

	// 文字水印内容,设置为空字符串表示删除
	Text *string `json:"Text,omitnil,omitempty" name:"Text"`

	// 文字水印颜色
	TextColor *string `json:"TextColor,omitnil,omitempty" name:"TextColor"`
}

func NewSetWatermarkRequest added in v1.0.591

func NewSetWatermarkRequest() (request *SetWatermarkRequest)

func (*SetWatermarkRequest) FromJsonString added in v1.0.591

func (r *SetWatermarkRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetWatermarkRequest) ToJsonString added in v1.0.591

func (r *SetWatermarkRequest) ToJsonString() string

type SetWatermarkRequestParams added in v1.0.591

type SetWatermarkRequestParams struct {
	// 低代码互动课堂的SdkAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 老师视频区域的水印参数地址,设置为空字符串表示删除
	TeacherUrl *string `json:"TeacherUrl,omitnil,omitempty" name:"TeacherUrl"`

	// 白板视频区域的水印参数地址,设置为空字符串表示删除
	BoardUrl *string `json:"BoardUrl,omitnil,omitempty" name:"BoardUrl"`

	// 视频默认图片(在没有视频流的时候显示),设置为空字符串表示删除
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`

	// 白板区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
	BoardW *float64 `json:"BoardW,omitnil,omitempty" name:"BoardW"`

	// 白板区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
	BoardH *float64 `json:"BoardH,omitnil,omitempty" name:"BoardH"`

	// 白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
	BoardX *float64 `json:"BoardX,omitnil,omitempty" name:"BoardX"`

	// 白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
	BoardY *float64 `json:"BoardY,omitnil,omitempty" name:"BoardY"`

	// 老师视频区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
	TeacherW *float64 `json:"TeacherW,omitnil,omitempty" name:"TeacherW"`

	// 老师视频区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
	TeacherH *float64 `json:"TeacherH,omitnil,omitempty" name:"TeacherH"`

	// 老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
	TeacherX *float64 `json:"TeacherX,omitnil,omitempty" name:"TeacherX"`

	// 老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
	TeacherY *float64 `json:"TeacherY,omitnil,omitempty" name:"TeacherY"`

	// 文字水印内容,设置为空字符串表示删除
	Text *string `json:"Text,omitnil,omitempty" name:"Text"`

	// 文字水印颜色
	TextColor *string `json:"TextColor,omitnil,omitempty" name:"TextColor"`
}

Predefined struct for user

type SetWatermarkResponse added in v1.0.591

type SetWatermarkResponse struct {
	*tchttp.BaseResponse
	Response *SetWatermarkResponseParams `json:"Response"`
}

func NewSetWatermarkResponse added in v1.0.591

func NewSetWatermarkResponse() (response *SetWatermarkResponse)

func (*SetWatermarkResponse) FromJsonString added in v1.0.591

func (r *SetWatermarkResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetWatermarkResponse) ToJsonString added in v1.0.591

func (r *SetWatermarkResponse) ToJsonString() string

type SetWatermarkResponseParams added in v1.0.591

type SetWatermarkResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StartRoomRequest added in v1.0.641

type StartRoomRequest struct {
	*tchttp.BaseRequest

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewStartRoomRequest added in v1.0.641

func NewStartRoomRequest() (request *StartRoomRequest)

func (*StartRoomRequest) FromJsonString added in v1.0.641

func (r *StartRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StartRoomRequest) ToJsonString added in v1.0.641

func (r *StartRoomRequest) ToJsonString() string

type StartRoomRequestParams added in v1.0.641

type StartRoomRequestParams struct {
	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type StartRoomResponse added in v1.0.641

type StartRoomResponse struct {
	*tchttp.BaseResponse
	Response *StartRoomResponseParams `json:"Response"`
}

func NewStartRoomResponse added in v1.0.641

func NewStartRoomResponse() (response *StartRoomResponse)

func (*StartRoomResponse) FromJsonString added in v1.0.641

func (r *StartRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StartRoomResponse) ToJsonString added in v1.0.641

func (r *StartRoomResponse) ToJsonString() string

type StartRoomResponseParams added in v1.0.641

type StartRoomResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type TextMarkConfig added in v1.0.591

type TextMarkConfig struct {
	// 文字水印内容
	// 注意:此字段可能返回 null,表示取不到有效值。
	Text *string `json:"Text,omitnil,omitempty" name:"Text"`

	// 文字水印颜色
	// 注意:此字段可能返回 null,表示取不到有效值。
	Color *string `json:"Color,omitnil,omitempty" name:"Color"`
}

type TextMsgContent added in v1.0.769

type TextMsgContent struct {
	// 文本消息。
	Text *string `json:"Text,omitnil,omitempty" name:"Text"`
}

type TransferItem added in v1.0.868

type TransferItem struct {
	// 转存状态, 1正常 2停用
	// 注意:此字段可能返回 null,表示取不到有效值。
	State *uint64 `json:"State,omitnil,omitempty" name:"State"`
}

type UnbindDocumentFromRoomRequest added in v1.0.517

type UnbindDocumentFromRoomRequest struct {
	*tchttp.BaseRequest

	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 文档ID。
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewUnbindDocumentFromRoomRequest added in v1.0.517

func NewUnbindDocumentFromRoomRequest() (request *UnbindDocumentFromRoomRequest)

func (*UnbindDocumentFromRoomRequest) FromJsonString added in v1.0.517

func (r *UnbindDocumentFromRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnbindDocumentFromRoomRequest) ToJsonString added in v1.0.517

func (r *UnbindDocumentFromRoomRequest) ToJsonString() string

type UnbindDocumentFromRoomRequestParams added in v1.0.517

type UnbindDocumentFromRoomRequestParams struct {
	// 房间ID。
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 文档ID。
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type UnbindDocumentFromRoomResponse added in v1.0.517

type UnbindDocumentFromRoomResponse struct {
	*tchttp.BaseResponse
	Response *UnbindDocumentFromRoomResponseParams `json:"Response"`
}

func NewUnbindDocumentFromRoomResponse added in v1.0.517

func NewUnbindDocumentFromRoomResponse() (response *UnbindDocumentFromRoomResponse)

func (*UnbindDocumentFromRoomResponse) FromJsonString added in v1.0.517

func (r *UnbindDocumentFromRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnbindDocumentFromRoomResponse) ToJsonString added in v1.0.517

func (r *UnbindDocumentFromRoomResponse) ToJsonString() string

type UnbindDocumentFromRoomResponseParams added in v1.0.517

type UnbindDocumentFromRoomResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UserInfo added in v1.0.591

type UserInfo struct {
	// 应用Id。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户Id。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 用户昵称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 用户头像Url。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`

	// 用户在客户系统的Id
	// 注意:此字段可能返回 null,表示取不到有效值。
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`
}

type WatermarkConfig added in v1.0.591

type WatermarkConfig struct {
	// 水印图片的url
	// 注意:此字段可能返回 null,表示取不到有效值。
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// 水印宽。为比例值
	// 注意:此字段可能返回 null,表示取不到有效值。
	Width *float64 `json:"Width,omitnil,omitempty" name:"Width"`

	// 水印高。为比例值
	// 注意:此字段可能返回 null,表示取不到有效值。
	Height *float64 `json:"Height,omitnil,omitempty" name:"Height"`

	// 水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	LocationX *float64 `json:"LocationX,omitnil,omitempty" name:"LocationX"`

	// 水印Y偏移, 取值:0-100, 表示区域Y方向的百分比。比如50,则表示位于Y轴中间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	LocationY *float64 `json:"LocationY,omitnil,omitempty" name:"LocationY"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL