apis

package
v1.62.0 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddPushStreamRuleRequest added in v1.56.0 

type AddPushStreamRuleRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 推流规则 (Optional) */
	Rules []openjrtc.PushStreamRule `json:"rules"`
}

func NewAddPushStreamRuleRequest added in v1.56.0 

func NewAddPushStreamRuleRequest() *AddPushStreamRuleRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewAddPushStreamRuleRequestWithAllParams added in v1.56.0 

func NewAddPushStreamRuleRequestWithAllParams(
	appId *string,
	rules []openjrtc.PushStreamRule,
) *AddPushStreamRuleRequest

* param appId: 应用ID (Optional) * param rules: 推流规则 (Optional)

func NewAddPushStreamRuleRequestWithoutParam added in v1.56.0 

func NewAddPushStreamRuleRequestWithoutParam() *AddPushStreamRuleRequest

This constructor has better compatible ability when API parameters changed

func (AddPushStreamRuleRequest) GetRegionId added in v1.56.0 

func (r AddPushStreamRuleRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*AddPushStreamRuleRequest) SetAppId added in v1.56.0 

func (r *AddPushStreamRuleRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*AddPushStreamRuleRequest) SetRules added in v1.56.0 

func (r *AddPushStreamRuleRequest) SetRules(rules []openjrtc.PushStreamRule)

param rules: 推流规则(Optional)

type AddPushStreamRuleResponse added in v1.56.0 

type AddPushStreamRuleResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    AddPushStreamRuleResult `json:"result"`
}

type AddPushStreamRuleResult added in v1.56.0 

type AddPushStreamRuleResult struct {
}

type AddRecordRuleRequest added in v1.56.0 

type AddRecordRuleRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 录制规则 (Optional) */
	Rules []openjrtc.RecordRule `json:"rules"`
}

func NewAddRecordRuleRequest added in v1.56.0 

func NewAddRecordRuleRequest() *AddRecordRuleRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewAddRecordRuleRequestWithAllParams added in v1.56.0 

func NewAddRecordRuleRequestWithAllParams(
	appId *string,
	rules []openjrtc.RecordRule,
) *AddRecordRuleRequest

* param appId: 应用ID (Optional) * param rules: 录制规则 (Optional)

func NewAddRecordRuleRequestWithoutParam added in v1.56.0 

func NewAddRecordRuleRequestWithoutParam() *AddRecordRuleRequest

This constructor has better compatible ability when API parameters changed

func (AddRecordRuleRequest) GetRegionId added in v1.56.0 

func (r AddRecordRuleRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*AddRecordRuleRequest) SetAppId added in v1.56.0 

func (r *AddRecordRuleRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*AddRecordRuleRequest) SetRules added in v1.56.0 

func (r *AddRecordRuleRequest) SetRules(rules []openjrtc.RecordRule)

param rules: 录制规则(Optional)

type AddRecordRuleResponse added in v1.56.0 

type AddRecordRuleResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    AddRecordRuleResult `json:"result"`
}

type AddRecordRuleResult added in v1.56.0 

type AddRecordRuleResult struct {
}

type CloseRoomUserStreamRequest added in v1.56.0 

type CloseRoomUserStreamRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Optional) */
	UserId *string `json:"userId"`

	/* 要关闭的流ID (Optional) */
	StreamId *string `json:"streamId"`
}

func NewCloseRoomUserStreamRequest added in v1.56.0 

func NewCloseRoomUserStreamRequest(
	appId string,
) *CloseRoomUserStreamRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCloseRoomUserStreamRequestWithAllParams added in v1.56.0 

func NewCloseRoomUserStreamRequestWithAllParams(
	appId string,
	userRoomId *string,
	userId *string,
	streamId *string,
) *CloseRoomUserStreamRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Optional) * param streamId: 要关闭的流ID (Optional)

func NewCloseRoomUserStreamRequestWithoutParam added in v1.56.0 

func NewCloseRoomUserStreamRequestWithoutParam() *CloseRoomUserStreamRequest

This constructor has better compatible ability when API parameters changed

func (CloseRoomUserStreamRequest) GetRegionId added in v1.56.0 

func (r CloseRoomUserStreamRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CloseRoomUserStreamRequest) SetAppId added in v1.56.0 

func (r *CloseRoomUserStreamRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*CloseRoomUserStreamRequest) SetStreamId added in v1.56.0 

func (r *CloseRoomUserStreamRequest) SetStreamId(streamId string)

param streamId: 要关闭的流ID(Optional)

func (*CloseRoomUserStreamRequest) SetUserId added in v1.56.0 

func (r *CloseRoomUserStreamRequest) SetUserId(userId string)

param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId(Optional)

func (*CloseRoomUserStreamRequest) SetUserRoomId added in v1.56.0 

func (r *CloseRoomUserStreamRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type CloseRoomUserStreamResponse added in v1.56.0 

type CloseRoomUserStreamResponse struct {
	RequestID string                    `json:"requestId"`
	Error     core.ErrorResponse        `json:"error"`
	Result    CloseRoomUserStreamResult `json:"result"`
}

type CloseRoomUserStreamResult added in v1.56.0 

type CloseRoomUserStreamResult struct {
}

type CreateRoomRequest 

type CreateRoomRequest struct {
	core.JDCloudRequest

	/* 房间名称 (Optional) */
	RoomName *string `json:"roomName"`

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 房间类型 1-小房间(音频单流订阅) 2-大房间(音频固定订阅) (Optional) */
	RoomType *int `json:"roomType"`

	/* 会议类型 0-即时会议 1-预约会议 (Optional) */
	MeetingType *int `json:"meetingType"`

	/* 用户ID(创建者ID) (Optional) */
	PeerId *int64 `json:"peerId"`
}

func NewCreateRoomRequest 

func NewCreateRoomRequest() *CreateRoomRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewCreateRoomRequestWithAllParams 

func NewCreateRoomRequestWithAllParams(
	roomName *string,
	appId *string,
	roomType *int,
	meetingType *int,
	peerId *int64,
) *CreateRoomRequest

* param roomName: 房间名称 (Optional) * param appId: 应用ID (Optional) * param roomType: 房间类型 1-小房间(音频单流订阅) 2-大房间(音频固定订阅) (Optional) * param meetingType: 会议类型 0-即时会议 1-预约会议 (Optional) * param peerId: 用户ID(创建者ID) (Optional)

func NewCreateRoomRequestWithoutParam 

func NewCreateRoomRequestWithoutParam() *CreateRoomRequest

This constructor has better compatible ability when API parameters changed

func (CreateRoomRequest) GetRegionId 

func (r CreateRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateRoomRequest) SetAppId 

func (r *CreateRoomRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*CreateRoomRequest) SetMeetingType added in v1.56.0 

func (r *CreateRoomRequest) SetMeetingType(meetingType int)

param meetingType: 会议类型 0-即时会议 1-预约会议(Optional)

func (*CreateRoomRequest) SetPeerId 

func (r *CreateRoomRequest) SetPeerId(peerId int64)

param peerId: 用户ID(创建者ID)(Optional)

func (*CreateRoomRequest) SetRoomName 

func (r *CreateRoomRequest) SetRoomName(roomName string)

param roomName: 房间名称(Optional)

func (*CreateRoomRequest) SetRoomType added in v1.56.0 

func (r *CreateRoomRequest) SetRoomType(roomType int)

param roomType: 房间类型 1-小房间(音频单流订阅) 2-大房间(音频固定订阅)(Optional)

type CreateRoomResponse 

type CreateRoomResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    CreateRoomResult   `json:"result"`
}

type CreateRoomResult 

type CreateRoomResult struct {
	RoomId     int64  `json:"roomId"`
	RoomName   string `json:"roomName"`
	RoomType   int    `json:"roomType"`
	AppId      string `json:"appId"`
	PeerId     int64  `json:"peerId"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

type CreateTokenRequest added in v1.56.0 

type CreateTokenRequest struct {
	core.JDCloudRequest

	/* appId (Optional) */
	AppId *string `json:"appId"`

	/* appKey (Optional) */
	AppKey *string `json:"appKey"`

	/* 用户id (Optional) */
	UserId *string `json:"userId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 时间戳-毫秒 (Optional) */
	Timestamp *int64 `json:"timestamp"`
}

func NewCreateTokenRequest added in v1.56.0 

func NewCreateTokenRequest() *CreateTokenRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewCreateTokenRequestWithAllParams added in v1.56.0 

func NewCreateTokenRequestWithAllParams(
	appId *string,
	appKey *string,
	userId *string,
	userRoomId *string,
	timestamp *int64,
) *CreateTokenRequest

* param appId: appId (Optional) * param appKey: appKey (Optional) * param userId: 用户id (Optional) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) * param timestamp: 时间戳-毫秒 (Optional)

func NewCreateTokenRequestWithoutParam added in v1.56.0 

func NewCreateTokenRequestWithoutParam() *CreateTokenRequest

This constructor has better compatible ability when API parameters changed

func (CreateTokenRequest) GetRegionId added in v1.56.0 

func (r CreateTokenRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateTokenRequest) SetAppId added in v1.56.0 

func (r *CreateTokenRequest) SetAppId(appId string)

param appId: appId(Optional)

func (*CreateTokenRequest) SetAppKey added in v1.56.0 

func (r *CreateTokenRequest) SetAppKey(appKey string)

param appKey: appKey(Optional)

func (*CreateTokenRequest) SetTimestamp added in v1.56.0 

func (r *CreateTokenRequest) SetTimestamp(timestamp int64)

param timestamp: 时间戳-毫秒(Optional)

func (*CreateTokenRequest) SetUserId added in v1.56.0 

func (r *CreateTokenRequest) SetUserId(userId string)

param userId: 用户id(Optional)

func (*CreateTokenRequest) SetUserRoomId added in v1.56.0 

func (r *CreateTokenRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type CreateTokenResponse added in v1.56.0 

type CreateTokenResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    CreateTokenResult  `json:"result"`
}

type CreateTokenResult added in v1.56.0 

type CreateTokenResult struct {
	AppId      string `json:"appId"`
	AppKey     string `json:"appKey"`
	UserId     string `json:"userId"`
	UserRoomId string `json:"userRoomId"`
	Nonce      string `json:"nonce"`
	Timestamp  int64  `json:"timestamp"`
	Token      string `json:"token"`
	Available  bool   `json:"available"`
}

type CreateUserRequest 

type CreateUserRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 用户名称 (Optional) */
	UserName *string `json:"userName"`

	/* 业务接入方的用户ID (Optional) */
	UserId *string `json:"userId"`

	/* 是否临时用户 (Optional) */
	Temporary *bool `json:"temporary"`
}

func NewCreateUserRequest 

func NewCreateUserRequest() *CreateUserRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewCreateUserRequestWithAllParams 

func NewCreateUserRequestWithAllParams(
	appId *string,
	userName *string,
	userId *string,
	temporary *bool,
) *CreateUserRequest

* param appId: 应用ID (Optional) * param userName: 用户名称 (Optional) * param userId: 业务接入方的用户ID (Optional) * param temporary: 是否临时用户 (Optional)

func NewCreateUserRequestWithoutParam 

func NewCreateUserRequestWithoutParam() *CreateUserRequest

This constructor has better compatible ability when API parameters changed

func (CreateUserRequest) GetRegionId 

func (r CreateUserRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateUserRequest) SetAppId 

func (r *CreateUserRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*CreateUserRequest) SetTemporary 

func (r *CreateUserRequest) SetTemporary(temporary bool)

param temporary: 是否临时用户(Optional)

func (*CreateUserRequest) SetUserId 

func (r *CreateUserRequest) SetUserId(userId string)

param userId: 业务接入方的用户ID(Optional)

func (*CreateUserRequest) SetUserName 

func (r *CreateUserRequest) SetUserName(userName string)

param userName: 用户名称(Optional)

type CreateUserResponse 

type CreateUserResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    CreateUserResult   `json:"result"`
}

type CreateUserResult 

type CreateUserResult struct {
	PeerId int64  `json:"peerId"`
	AppId  string `json:"appId"`
	UserId string `json:"userId"`
}

type DeleteRoomRequest added in v1.52.0 

type DeleteRoomRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 房间ID  */
	RoomId int `json:"roomId"`
}

func NewDeleteRoomRequest added in v1.52.0 

func NewDeleteRoomRequest(
	appId string,
	roomId int,
) *DeleteRoomRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteRoomRequestWithAllParams added in v1.52.0 

func NewDeleteRoomRequestWithAllParams(
	appId string,
	roomId int,
) *DeleteRoomRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required)

func NewDeleteRoomRequestWithoutParam added in v1.52.0 

func NewDeleteRoomRequestWithoutParam() *DeleteRoomRequest

This constructor has better compatible ability when API parameters changed

func (DeleteRoomRequest) GetRegionId added in v1.52.0 

func (r DeleteRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteRoomRequest) SetAppId added in v1.52.0 

func (r *DeleteRoomRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DeleteRoomRequest) SetRoomId added in v1.52.0 

func (r *DeleteRoomRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type DeleteRoomResponse added in v1.52.0 

type DeleteRoomResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeleteRoomResult   `json:"result"`
}

type DeleteRoomResult added in v1.52.0 

type DeleteRoomResult struct {
}

type DescribeAppKeyRequest added in v1.52.0 

type DescribeAppKeyRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`
}

func NewDescribeAppKeyRequest added in v1.52.0 

func NewDescribeAppKeyRequest(
	appId string,
) *DescribeAppKeyRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAppKeyRequestWithAllParams added in v1.52.0 

func NewDescribeAppKeyRequestWithAllParams(
	appId string,
) *DescribeAppKeyRequest

* param appId: 应用ID (Required)

func NewDescribeAppKeyRequestWithoutParam added in v1.52.0 

func NewDescribeAppKeyRequestWithoutParam() *DescribeAppKeyRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAppKeyRequest) GetRegionId added in v1.52.0 

func (r DescribeAppKeyRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeAppKeyRequest) SetAppId added in v1.52.0 

func (r *DescribeAppKeyRequest) SetAppId(appId string)

param appId: 应用ID(Required)

type DescribeAppKeyResponse added in v1.52.0 

type DescribeAppKeyResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    DescribeAppKeyResult `json:"result"`
}

type DescribeAppKeyResult added in v1.52.0 

type DescribeAppKeyResult struct {
	AppId  string `json:"appId"`
	AppKey string `json:"appKey"`
}

type DescribeAppRequest added in v1.52.0 

type DescribeAppRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`
}

func NewDescribeAppRequest added in v1.52.0 

func NewDescribeAppRequest(
	appId string,
) *DescribeAppRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAppRequestWithAllParams added in v1.52.0 

func NewDescribeAppRequestWithAllParams(
	appId string,
) *DescribeAppRequest

* param appId: 应用ID (Required)

func NewDescribeAppRequestWithoutParam added in v1.52.0 

func NewDescribeAppRequestWithoutParam() *DescribeAppRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAppRequest) GetRegionId added in v1.52.0 

func (r DescribeAppRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeAppRequest) SetAppId added in v1.52.0 

func (r *DescribeAppRequest) SetAppId(appId string)

param appId: 应用ID(Required)

type DescribeAppResponse added in v1.52.0 

type DescribeAppResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DescribeAppResult  `json:"result"`
}

type DescribeAppResult added in v1.52.0 

type DescribeAppResult struct {
	AppId      string `json:"appId"`
	AppName    string `json:"appName"`
	Status     string `json:"status"`
	RoomType   int    `json:"roomType"`
	BillType   string `json:"billType"`
	CreateTime string `json:"createTime"`
}

type DescribeAppsRequest added in v1.52.0 

type DescribeAppsRequest struct {
	core.JDCloudRequest

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`
}

func NewDescribeAppsRequest added in v1.52.0 

func NewDescribeAppsRequest() *DescribeAppsRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAppsRequestWithAllParams added in v1.52.0 

func NewDescribeAppsRequestWithAllParams(
	pageNumber *int,
	pageSize *int,
) *DescribeAppsRequest

* param pageNumber: 页码；默认值为 1 (Optional) * param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)

func NewDescribeAppsRequestWithoutParam added in v1.52.0 

func NewDescribeAppsRequestWithoutParam() *DescribeAppsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAppsRequest) GetRegionId added in v1.52.0 

func (r DescribeAppsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeAppsRequest) SetPageNumber added in v1.52.0 

func (r *DescribeAppsRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeAppsRequest) SetPageSize added in v1.52.0 

func (r *DescribeAppsRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

type DescribeAppsResponse added in v1.52.0 

type DescribeAppsResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DescribeAppsResult `json:"result"`
}

type DescribeAppsResult added in v1.52.0 

type DescribeAppsResult struct {
	PageNumber    int                      `json:"pageNumber"`
	PageSize      int                      `json:"pageSize"`
	TotalElements int                      `json:"totalElements"`
	TotalPages    int                      `json:"totalPages"`
	Content       []openjrtc.AppInfoObject `json:"content"`
}

type DescribeCallDurationByCodeRateRequest added in v1.56.0 

type DescribeCallDurationByCodeRateRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 开始时间 UTC格式  */
	StartTime string `json:"startTime"`

	/* 结束时间 UTC格式 (Optional) */
	EndTime *string `json:"endTime"`
}

func NewDescribeCallDurationByCodeRateRequest added in v1.56.0 

func NewDescribeCallDurationByCodeRateRequest(
	startTime string,
) *DescribeCallDurationByCodeRateRequest

* param startTime: 开始时间 UTC格式 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeCallDurationByCodeRateRequestWithAllParams added in v1.56.0 

func NewDescribeCallDurationByCodeRateRequestWithAllParams(
	appId *string,
	startTime string,
	endTime *string,
) *DescribeCallDurationByCodeRateRequest

* param appId: 应用ID (Optional) * param startTime: 开始时间 UTC格式 (Required) * param endTime: 结束时间 UTC格式 (Optional)

func NewDescribeCallDurationByCodeRateRequestWithoutParam added in v1.56.0 

func NewDescribeCallDurationByCodeRateRequestWithoutParam() *DescribeCallDurationByCodeRateRequest

This constructor has better compatible ability when API parameters changed

func (DescribeCallDurationByCodeRateRequest) GetRegionId added in v1.56.0 

func (r DescribeCallDurationByCodeRateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeCallDurationByCodeRateRequest) SetAppId added in v1.56.0 

func (r *DescribeCallDurationByCodeRateRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*DescribeCallDurationByCodeRateRequest) SetEndTime added in v1.56.0 

func (r *DescribeCallDurationByCodeRateRequest) SetEndTime(endTime string)

param endTime: 结束时间 UTC格式(Optional)

func (*DescribeCallDurationByCodeRateRequest) SetStartTime added in v1.56.0 

func (r *DescribeCallDurationByCodeRateRequest) SetStartTime(startTime string)

param startTime: 开始时间 UTC格式(Required)

type DescribeCallDurationByCodeRateResponse added in v1.56.0 

type DescribeCallDurationByCodeRateResponse struct {
	RequestID string                               `json:"requestId"`
	Error     core.ErrorResponse                   `json:"error"`
	Result    DescribeCallDurationByCodeRateResult `json:"result"`
}

type DescribeCallDurationByCodeRateResult added in v1.56.0 

type DescribeCallDurationByCodeRateResult struct {
	Content []openjrtc.CallDurationByCodeRate `json:"content"`
}

type DescribeDailyCallDurationRequest added in v1.56.0 

type DescribeDailyCallDurationRequest struct {
	core.JDCloudRequest
}

func NewDescribeDailyCallDurationRequest added in v1.56.0 

func NewDescribeDailyCallDurationRequest() *DescribeDailyCallDurationRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeDailyCallDurationRequestWithAllParams added in v1.56.0 

func NewDescribeDailyCallDurationRequestWithAllParams() *DescribeDailyCallDurationRequest

func NewDescribeDailyCallDurationRequestWithoutParam added in v1.56.0 

func NewDescribeDailyCallDurationRequestWithoutParam() *DescribeDailyCallDurationRequest

This constructor has better compatible ability when API parameters changed

func (DescribeDailyCallDurationRequest) GetRegionId added in v1.56.0 

func (r DescribeDailyCallDurationRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

type DescribeDailyCallDurationResponse added in v1.56.0 

type DescribeDailyCallDurationResponse struct {
	RequestID string                          `json:"requestId"`
	Error     core.ErrorResponse              `json:"error"`
	Result    DescribeDailyCallDurationResult `json:"result"`
}

type DescribeDailyCallDurationResult added in v1.56.0 

type DescribeDailyCallDurationResult struct {
	Content []openjrtc.CallDuration `json:"content"`
}

type DescribeOnlineUserNumRequest added in v1.56.0 

type DescribeOnlineUserNumRequest struct {
	core.JDCloudRequest

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 传参字段描述:
	appId:   应用ID (必填)
	userRoomId：业务接入方定义的且在JRTC系统内注册过的房间号(必填)
	startTime: 房间使用起始时间 UTC (必填)
	endTime：房间使用截止时间 UTC (必填)
	*/
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeOnlineUserNumRequest added in v1.56.0 

func NewDescribeOnlineUserNumRequest(
	filters []openjrtc.Filter,
) *DescribeOnlineUserNumRequest
  • param filters: 传参字段描述: appId: 应用ID (必填) userRoomId：业务接入方定义的且在JRTC系统内注册过的房间号(必填) startTime: 房间使用起始时间 UTC (必填) endTime：房间使用截止时间 UTC (必填)

(Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeOnlineUserNumRequestWithAllParams added in v1.56.0 

func NewDescribeOnlineUserNumRequestWithAllParams(
	pageNumber *int,
	pageSize *int,
	filters []openjrtc.Filter,
) *DescribeOnlineUserNumRequest
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param filters: 传参字段描述: appId: 应用ID (必填) userRoomId：业务接入方定义的且在JRTC系统内注册过的房间号(必填) startTime: 房间使用起始时间 UTC (必填) endTime：房间使用截止时间 UTC (必填)

(Required)

func NewDescribeOnlineUserNumRequestWithoutParam added in v1.56.0 

func NewDescribeOnlineUserNumRequestWithoutParam() *DescribeOnlineUserNumRequest

This constructor has better compatible ability when API parameters changed

func (DescribeOnlineUserNumRequest) GetRegionId added in v1.56.0 

func (r DescribeOnlineUserNumRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeOnlineUserNumRequest) SetFilters added in v1.56.0 

func (r *DescribeOnlineUserNumRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:
 appId:   应用ID (必填)
 userRoomId：业务接入方定义的且在JRTC系统内注册过的房间号(必填)
 startTime: 房间使用起始时间 UTC (必填)
 endTime：房间使用截止时间 UTC (必填)

(Required)

func (*DescribeOnlineUserNumRequest) SetPageNumber added in v1.56.0 

func (r *DescribeOnlineUserNumRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeOnlineUserNumRequest) SetPageSize added in v1.56.0 

func (r *DescribeOnlineUserNumRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

type DescribeOnlineUserNumResponse added in v1.56.0 

type DescribeOnlineUserNumResponse struct {
	RequestID string                      `json:"requestId"`
	Error     core.ErrorResponse          `json:"error"`
	Result    DescribeOnlineUserNumResult `json:"result"`
}

type DescribeOnlineUserNumResult added in v1.56.0 

type DescribeOnlineUserNumResult struct {
	PageNumber    int                    `json:"pageNumber"`
	PageSize      int                    `json:"pageSize"`
	TotalElements int                    `json:"totalElements"`
	TotalPages    int                    `json:"totalPages"`
	Content       []openjrtc.UserNumInfo `json:"content"`
}

type DescribeP2pStreamBitRateRequest added in v1.56.0 

type DescribeP2pStreamBitRateRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的用户房间号  */
	UserRoomId string `json:"userRoomId"`

	/* 业务接入方定义的且在JRTC系统内注册过的用户id  */
	UserId string `json:"userId"`

	/* audio/video  */
	Kind string `json:"kind"`

	/* producer 发布流 consumer 订阅流  */
	Type string `json:"type"`

	/* 加入时间 UTC格式  */
	JoinTime string `json:"joinTime"`

	/* 离开时间 UTC格式 (Optional) */
	LeaveTime *string `json:"leaveTime"`

	/* 业务接入方定义的且在JRTC系统内注册过的用户id type=consumer时选择发送端用户id切换码率 (Optional) */
	FromUserId *string `json:"fromUserId"`

	/* 粒度 支持 1m 1h 1d (Optional) */
	Period *string `json:"period"`
}

func NewDescribeP2pStreamBitRateRequest added in v1.56.0 

func NewDescribeP2pStreamBitRateRequest(
	appId string,
	userRoomId string,
	userId string,
	kind string,
	type_ string,
	joinTime string,
) *DescribeP2pStreamBitRateRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的用户房间号 (Required) * param userId: 业务接入方定义的且在JRTC系统内注册过的用户id (Required) * param kind: audio/video (Required) * param type_: producer 发布流 consumer 订阅流 (Required) * param joinTime: 加入时间 UTC格式 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeP2pStreamBitRateRequestWithAllParams added in v1.56.0 

func NewDescribeP2pStreamBitRateRequestWithAllParams(
	appId string,
	userRoomId string,
	userId string,
	kind string,
	type_ string,
	joinTime string,
	leaveTime *string,
	fromUserId *string,
	period *string,
) *DescribeP2pStreamBitRateRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的用户房间号 (Required) * param userId: 业务接入方定义的且在JRTC系统内注册过的用户id (Required) * param kind: audio/video (Required) * param type_: producer 发布流 consumer 订阅流 (Required) * param joinTime: 加入时间 UTC格式 (Required) * param leaveTime: 离开时间 UTC格式 (Optional) * param fromUserId: 业务接入方定义的且在JRTC系统内注册过的用户id type=consumer时选择发送端用户id切换码率 (Optional) * param period: 粒度 支持 1m 1h 1d (Optional)

func NewDescribeP2pStreamBitRateRequestWithoutParam added in v1.56.0 

func NewDescribeP2pStreamBitRateRequestWithoutParam() *DescribeP2pStreamBitRateRequest

This constructor has better compatible ability when API parameters changed

func (DescribeP2pStreamBitRateRequest) GetRegionId added in v1.56.0 

func (r DescribeP2pStreamBitRateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeP2pStreamBitRateRequest) SetAppId added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeP2pStreamBitRateRequest) SetFromUserId added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetFromUserId(fromUserId string)

param fromUserId: 业务接入方定义的且在JRTC系统内注册过的用户id type=consumer时选择发送端用户id切换码率(Optional)

func (*DescribeP2pStreamBitRateRequest) SetJoinTime added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetJoinTime(joinTime string)

param joinTime: 加入时间 UTC格式(Required)

func (*DescribeP2pStreamBitRateRequest) SetKind added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetKind(kind string)

param kind: audio/video(Required)

func (*DescribeP2pStreamBitRateRequest) SetLeaveTime added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetLeaveTime(leaveTime string)

param leaveTime: 离开时间 UTC格式(Optional)

func (*DescribeP2pStreamBitRateRequest) SetPeriod added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetPeriod(period string)

param period: 粒度 支持 1m 1h 1d(Optional)

func (*DescribeP2pStreamBitRateRequest) SetType added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetType(type_ string)

param type_: producer 发布流 consumer 订阅流(Required)

func (*DescribeP2pStreamBitRateRequest) SetUserId added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetUserId(userId string)

param userId: 业务接入方定义的且在JRTC系统内注册过的用户id(Required)

func (*DescribeP2pStreamBitRateRequest) SetUserRoomId added in v1.56.0 

func (r *DescribeP2pStreamBitRateRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的用户房间号(Required)

type DescribeP2pStreamBitRateResponse added in v1.56.0 

type DescribeP2pStreamBitRateResponse struct {
	RequestID string                         `json:"requestId"`
	Error     core.ErrorResponse             `json:"error"`
	Result    DescribeP2pStreamBitRateResult `json:"result"`
}

type DescribeP2pStreamBitRateResult added in v1.56.0 

type DescribeP2pStreamBitRateResult struct {
	Content []openjrtc.StreamBitRate `json:"content"`
}

type DescribeRegisterUserRequest added in v1.56.0 

type DescribeRegisterUserRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方用户体系定义的且在JRTC系统内注册过的userId  */
	UserId string `json:"userId"`
}

func NewDescribeRegisterUserRequest added in v1.56.0 

func NewDescribeRegisterUserRequest(
	appId string,
	userId string,
) *DescribeRegisterUserRequest

* param appId: 应用ID (Required) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRegisterUserRequestWithAllParams added in v1.56.0 

func NewDescribeRegisterUserRequestWithAllParams(
	appId string,
	userId string,
) *DescribeRegisterUserRequest

* param appId: 应用ID (Required) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Required)

func NewDescribeRegisterUserRequestWithoutParam added in v1.56.0 

func NewDescribeRegisterUserRequestWithoutParam() *DescribeRegisterUserRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRegisterUserRequest) GetRegionId added in v1.56.0 

func (r DescribeRegisterUserRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRegisterUserRequest) SetAppId added in v1.56.0 

func (r *DescribeRegisterUserRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeRegisterUserRequest) SetUserId added in v1.56.0 

func (r *DescribeRegisterUserRequest) SetUserId(userId string)

param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId(Required)

type DescribeRegisterUserResponse added in v1.56.0 

type DescribeRegisterUserResponse struct {
	RequestID string                     `json:"requestId"`
	Error     core.ErrorResponse         `json:"error"`
	Result    DescribeRegisterUserResult `json:"result"`
}

type DescribeRegisterUserResult added in v1.56.0 

type DescribeRegisterUserResult struct {
	AppId      string `json:"appId"`
	PeerId     int64  `json:"peerId"`
	UserId     string `json:"userId"`
	UserName   string `json:"userName"`
	Temporary  bool   `json:"temporary"`
	CreateTime string `json:"createTime"`
}

type DescribeRegisterUsersRequest added in v1.56.0 

type DescribeRegisterUsersRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 传参字段描述:
	 startTime[eq]:   用户注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效
	 endTime[eq]:     用户注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效
	(Optional) */
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeRegisterUsersRequest added in v1.56.0 

func NewDescribeRegisterUsersRequest(
	appId string,
) *DescribeRegisterUsersRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRegisterUsersRequestWithAllParams added in v1.56.0 

func NewDescribeRegisterUsersRequestWithAllParams(
	appId string,
	pageNumber *int,
	pageSize *int,
	filters []openjrtc.Filter,
) *DescribeRegisterUsersRequest
  • param appId: 应用ID (Required)
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param filters: 传参字段描述: startTime[eq]: 用户注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效 endTime[eq]: 用户注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效

(Optional)

func NewDescribeRegisterUsersRequestWithoutParam added in v1.56.0 

func NewDescribeRegisterUsersRequestWithoutParam() *DescribeRegisterUsersRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRegisterUsersRequest) GetRegionId added in v1.56.0 

func (r DescribeRegisterUsersRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRegisterUsersRequest) SetAppId added in v1.56.0 

func (r *DescribeRegisterUsersRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeRegisterUsersRequest) SetFilters added in v1.56.0 

func (r *DescribeRegisterUsersRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:
 startTime[eq]:   用户注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效
 endTime[eq]:     用户注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效

(Optional)

func (*DescribeRegisterUsersRequest) SetPageNumber added in v1.56.0 

func (r *DescribeRegisterUsersRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeRegisterUsersRequest) SetPageSize added in v1.56.0 

func (r *DescribeRegisterUsersRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

type DescribeRegisterUsersResponse added in v1.56.0 

type DescribeRegisterUsersResponse struct {
	RequestID string                      `json:"requestId"`
	Error     core.ErrorResponse          `json:"error"`
	Result    DescribeRegisterUsersResult `json:"result"`
}

type DescribeRegisterUsersResult added in v1.56.0 

type DescribeRegisterUsersResult struct {
	PageNumber    int                            `json:"pageNumber"`
	PageSize      int                            `json:"pageSize"`
	TotalElements int                            `json:"totalElements"`
	TotalPages    int                            `json:"totalPages"`
	Content       []openjrtc.RegisterUserInfoObj `json:"content"`
}

type DescribeRoomInfoRequest added in v1.52.0 

type DescribeRoomInfoRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 房间ID  */
	RoomId int `json:"roomId"`
}

func NewDescribeRoomInfoRequest added in v1.52.0 

func NewDescribeRoomInfoRequest(
	appId string,
	roomId int,
) *DescribeRoomInfoRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRoomInfoRequestWithAllParams added in v1.52.0 

func NewDescribeRoomInfoRequestWithAllParams(
	appId string,
	roomId int,
) *DescribeRoomInfoRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required)

func NewDescribeRoomInfoRequestWithoutParam added in v1.52.0 

func NewDescribeRoomInfoRequestWithoutParam() *DescribeRoomInfoRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomInfoRequest) GetRegionId added in v1.52.0 

func (r DescribeRoomInfoRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRoomInfoRequest) SetAppId added in v1.52.0 

func (r *DescribeRoomInfoRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeRoomInfoRequest) SetRoomId added in v1.52.0 

func (r *DescribeRoomInfoRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type DescribeRoomInfoResponse added in v1.52.0 

type DescribeRoomInfoResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    DescribeRoomInfoResult `json:"result"`
}

type DescribeRoomInfoResult added in v1.52.0 

type DescribeRoomInfoResult struct {
	RoomId     int64  `json:"roomId"`
	RoomName   string `json:"roomName"`
	RoomType   int    `json:"roomType"`
	AppId      string `json:"appId"`
	PeerId     int64  `json:"peerId"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

type DescribeRoomOnlineUserNumRequest 

type DescribeRoomOnlineUserNumRequest struct {
	core.JDCloudRequest

	/* 房间ID  */
	RoomId int `json:"roomId"`
}

func NewDescribeRoomOnlineUserNumRequest 

func NewDescribeRoomOnlineUserNumRequest(
	roomId int,
) *DescribeRoomOnlineUserNumRequest

* param roomId: 房间ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRoomOnlineUserNumRequestWithAllParams 

func NewDescribeRoomOnlineUserNumRequestWithAllParams(
	roomId int,
) *DescribeRoomOnlineUserNumRequest

* param roomId: 房间ID (Required)

func NewDescribeRoomOnlineUserNumRequestWithoutParam 

func NewDescribeRoomOnlineUserNumRequestWithoutParam() *DescribeRoomOnlineUserNumRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomOnlineUserNumRequest) GetRegionId 

func (r DescribeRoomOnlineUserNumRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRoomOnlineUserNumRequest) SetRoomId 

func (r *DescribeRoomOnlineUserNumRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type DescribeRoomOnlineUserNumResponse 

type DescribeRoomOnlineUserNumResponse struct {
	RequestID string                          `json:"requestId"`
	Error     core.ErrorResponse              `json:"error"`
	Result    DescribeRoomOnlineUserNumResult `json:"result"`
}

type DescribeRoomOnlineUserNumResult 

type DescribeRoomOnlineUserNumResult struct {
	AppId      string `json:"appId"`
	RoomId     int64  `json:"roomId"`
	Number     int    `json:"number"`
	CreateTime string `json:"createTime"`
}

type DescribeRoomUserRequest added in v1.56.0 

type DescribeRoomUserRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号  */
	UserRoomId string `json:"userRoomId"`

	/* 业务接入方用户体系定义的且在JRTC系统内注册过的userId  */
	UserId string `json:"userId"`
}

func NewDescribeRoomUserRequest added in v1.56.0 

func NewDescribeRoomUserRequest(
	appId string,
	userRoomId string,
	userId string,
) *DescribeRoomUserRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRoomUserRequestWithAllParams added in v1.56.0 

func NewDescribeRoomUserRequestWithAllParams(
	appId string,
	userRoomId string,
	userId string,
) *DescribeRoomUserRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Required)

func NewDescribeRoomUserRequestWithoutParam added in v1.56.0 

func NewDescribeRoomUserRequestWithoutParam() *DescribeRoomUserRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomUserRequest) GetRegionId added in v1.56.0 

func (r DescribeRoomUserRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRoomUserRequest) SetAppId added in v1.56.0 

func (r *DescribeRoomUserRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeRoomUserRequest) SetUserId added in v1.56.0 

func (r *DescribeRoomUserRequest) SetUserId(userId string)

param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId(Required)

func (*DescribeRoomUserRequest) SetUserRoomId added in v1.56.0 

func (r *DescribeRoomUserRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Required)

type DescribeRoomUserResponse added in v1.56.0 

type DescribeRoomUserResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    DescribeRoomUserResult `json:"result"`
}

type DescribeRoomUserResult added in v1.56.0 

type DescribeRoomUserResult struct {
	AppId      string `json:"appId"`
	UserRoomId string `json:"userRoomId"`
	UserId     string `json:"userId"`
	NickName   string `json:"nickName"`
	ConnectId  string `json:"connectId"`
	Status     int    `json:"status"`
	JoinTime   string `json:"joinTime"`
	UpdateTime string `json:"updateTime"`
}

type DescribeRoomUsersNumRequest added in v1.56.0 

type DescribeRoomUsersNumRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号  */
	UserRoomId string `json:"userRoomId"`
}

func NewDescribeRoomUsersNumRequest added in v1.56.0 

func NewDescribeRoomUsersNumRequest(
	appId string,
	userRoomId string,
) *DescribeRoomUsersNumRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRoomUsersNumRequestWithAllParams added in v1.56.0 

func NewDescribeRoomUsersNumRequestWithAllParams(
	appId string,
	userRoomId string,
) *DescribeRoomUsersNumRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required)

func NewDescribeRoomUsersNumRequestWithoutParam added in v1.56.0 

func NewDescribeRoomUsersNumRequestWithoutParam() *DescribeRoomUsersNumRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomUsersNumRequest) GetRegionId added in v1.56.0 

func (r DescribeRoomUsersNumRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRoomUsersNumRequest) SetAppId added in v1.56.0 

func (r *DescribeRoomUsersNumRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeRoomUsersNumRequest) SetUserRoomId added in v1.56.0 

func (r *DescribeRoomUsersNumRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Required)

type DescribeRoomUsersNumResponse added in v1.56.0 

type DescribeRoomUsersNumResponse struct {
	RequestID string                     `json:"requestId"`
	Error     core.ErrorResponse         `json:"error"`
	Result    DescribeRoomUsersNumResult `json:"result"`
}

type DescribeRoomUsersNumResult added in v1.56.0 

type DescribeRoomUsersNumResult struct {
	AppId         string `json:"appId"`
	UserRoomId    string `json:"userRoomId"`
	OnlineNumber  int    `json:"onlineNumber"`
	OfflineNumber int    `json:"offlineNumber"`
	Total         int    `json:"total"`
}

type DescribeRoomUsersRequest added in v1.56.0 

type DescribeRoomUsersRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号  */
	UserRoomId string `json:"userRoomId"`

	/* 传参字段描述:
	- status[eq] 在线状态 1-在线 2-离线
	- startTime[eq] 用户加入时间段开始时间-UTC时间 startTime,endTime同时有值时生效
	- endTime[eq] 用户加入时间段结束时间-UTC时间   startTime,endTime同时有值时生效
	 (Optional) */
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeRoomUsersRequest added in v1.56.0 

func NewDescribeRoomUsersRequest(
	appId string,
	userRoomId string,
) *DescribeRoomUsersRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRoomUsersRequestWithAllParams added in v1.56.0 

func NewDescribeRoomUsersRequestWithAllParams(
	appId string,
	pageNumber *int,
	pageSize *int,
	userRoomId string,
	filters []openjrtc.Filter,
) *DescribeRoomUsersRequest
  • param appId: 应用ID (Required)
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required)
  • param filters: 传参字段描述:
  • status[eq] 在线状态 1-在线 2-离线
  • startTime[eq] 用户加入时间段开始时间-UTC时间 startTime,endTime同时有值时生效
  • endTime[eq] 用户加入时间段结束时间-UTC时间 startTime,endTime同时有值时生效 (Optional)

func NewDescribeRoomUsersRequestWithoutParam added in v1.56.0 

func NewDescribeRoomUsersRequestWithoutParam() *DescribeRoomUsersRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomUsersRequest) GetRegionId added in v1.56.0 

func (r DescribeRoomUsersRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRoomUsersRequest) SetAppId added in v1.56.0 

func (r *DescribeRoomUsersRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeRoomUsersRequest) SetFilters added in v1.56.0 

func (r *DescribeRoomUsersRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:

- status[eq] 在线状态 1-在线 2-离线 - startTime[eq] 用户加入时间段开始时间-UTC时间 startTime,endTime同时有值时生效 - endTime[eq] 用户加入时间段结束时间-UTC时间 startTime,endTime同时有值时生效 (Optional)

func (*DescribeRoomUsersRequest) SetPageNumber added in v1.56.0 

func (r *DescribeRoomUsersRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeRoomUsersRequest) SetPageSize added in v1.56.0 

func (r *DescribeRoomUsersRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

func (*DescribeRoomUsersRequest) SetUserRoomId added in v1.56.0 

func (r *DescribeRoomUsersRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Required)

type DescribeRoomUsersResponse added in v1.56.0 

type DescribeRoomUsersResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    DescribeRoomUsersResult `json:"result"`
}

type DescribeRoomUsersResult added in v1.56.0 

type DescribeRoomUsersResult struct {
	PageNumber    int                        `json:"pageNumber"`
	PageSize      int                        `json:"pageSize"`
	TotalElements int                        `json:"totalElements"`
	TotalPages    int                        `json:"totalPages"`
	Content       []openjrtc.RoomUserInfoObj `json:"content"`
}

type DescribeRoomsRequest added in v1.52.0 

type DescribeRoomsRequest struct {
	core.JDCloudRequest

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 传参字段描述:
	 appId:   应用ID
	(Optional) */
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeRoomsRequest added in v1.52.0 

func NewDescribeRoomsRequest() *DescribeRoomsRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRoomsRequestWithAllParams added in v1.52.0 

func NewDescribeRoomsRequestWithAllParams(
	pageNumber *int,
	pageSize *int,
	filters []openjrtc.Filter,
) *DescribeRoomsRequest
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param filters: 传参字段描述: appId: 应用ID

(Optional)

func NewDescribeRoomsRequestWithoutParam added in v1.52.0 

func NewDescribeRoomsRequestWithoutParam() *DescribeRoomsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomsRequest) GetRegionId added in v1.52.0 

func (r DescribeRoomsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRoomsRequest) SetFilters added in v1.52.0 

func (r *DescribeRoomsRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:
 appId:   应用ID

(Optional)

func (*DescribeRoomsRequest) SetPageNumber added in v1.52.0 

func (r *DescribeRoomsRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeRoomsRequest) SetPageSize added in v1.52.0 

func (r *DescribeRoomsRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

type DescribeRoomsResponse added in v1.52.0 

type DescribeRoomsResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DescribeRoomsResult `json:"result"`
}

type DescribeRoomsResult added in v1.52.0 

type DescribeRoomsResult struct {
	PageNumber    int                    `json:"pageNumber"`
	PageSize      int                    `json:"pageSize"`
	TotalElements int                    `json:"totalElements"`
	TotalPages    int                    `json:"totalPages"`
	Content       []openjrtc.RoomInfoObj `json:"content"`
}

type DescribeStreamInfoByStreamIdRequest added in v1.56.0 

type DescribeStreamInfoByStreamIdRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 流ID  */
	StreamId string `json:"streamId"`
}

func NewDescribeStreamInfoByStreamIdRequest added in v1.56.0 

func NewDescribeStreamInfoByStreamIdRequest(
	appId string,
	streamId string,
) *DescribeStreamInfoByStreamIdRequest

* param appId: 应用ID (Required) * param streamId: 流ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeStreamInfoByStreamIdRequestWithAllParams added in v1.56.0 

func NewDescribeStreamInfoByStreamIdRequestWithAllParams(
	appId string,
	streamId string,
) *DescribeStreamInfoByStreamIdRequest

* param appId: 应用ID (Required) * param streamId: 流ID (Required)

func NewDescribeStreamInfoByStreamIdRequestWithoutParam added in v1.56.0 

func NewDescribeStreamInfoByStreamIdRequestWithoutParam() *DescribeStreamInfoByStreamIdRequest

This constructor has better compatible ability when API parameters changed

func (DescribeStreamInfoByStreamIdRequest) GetRegionId added in v1.56.0 

func (r DescribeStreamInfoByStreamIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeStreamInfoByStreamIdRequest) SetAppId added in v1.56.0 

func (r *DescribeStreamInfoByStreamIdRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeStreamInfoByStreamIdRequest) SetStreamId added in v1.56.0 

func (r *DescribeStreamInfoByStreamIdRequest) SetStreamId(streamId string)

param streamId: 流ID(Required)

type DescribeStreamInfoByStreamIdResponse added in v1.56.0 

type DescribeStreamInfoByStreamIdResponse struct {
	RequestID string                             `json:"requestId"`
	Error     core.ErrorResponse                 `json:"error"`
	Result    DescribeStreamInfoByStreamIdResult `json:"result"`
}

type DescribeStreamInfoByStreamIdResult added in v1.56.0 

type DescribeStreamInfoByStreamIdResult struct {
	AppId        string `json:"appId"`
	UserRoomId   string `json:"userRoomId"`
	RoomName     string `json:"roomName"`
	UserId       string `json:"userId"`
	UserName     string `json:"userName"`
	NickName     string `json:"nickName"`
	StreamId     string `json:"streamId"`
	StreamName   string `json:"streamName"`
	Kind         int    `json:"kind"`
	Status       int    `json:"status"`
	DeviceType   int    `json:"deviceType"`
	PublishCount int    `json:"publishCount"`
	PublishTime  string `json:"publishTime"`
	CreateTime   string `json:"createTime"`
}

type DescribeStreamInfosByUserIdRequest added in v1.56.0 

type DescribeStreamInfosByUserIdRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号  */
	UserRoomId string `json:"userRoomId"`

	/* 业务接入方用户体系定义的且在JRTC系统内注册过的userId  */
	UserId string `json:"userId"`
}

func NewDescribeStreamInfosByUserIdRequest added in v1.56.0 

func NewDescribeStreamInfosByUserIdRequest(
	appId string,
	userRoomId string,
	userId string,
) *DescribeStreamInfosByUserIdRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeStreamInfosByUserIdRequestWithAllParams added in v1.56.0 

func NewDescribeStreamInfosByUserIdRequestWithAllParams(
	appId string,
	userRoomId string,
	userId string,
) *DescribeStreamInfosByUserIdRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Required)

func NewDescribeStreamInfosByUserIdRequestWithoutParam added in v1.56.0 

func NewDescribeStreamInfosByUserIdRequestWithoutParam() *DescribeStreamInfosByUserIdRequest

This constructor has better compatible ability when API parameters changed

func (DescribeStreamInfosByUserIdRequest) GetRegionId added in v1.56.0 

func (r DescribeStreamInfosByUserIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeStreamInfosByUserIdRequest) SetAppId added in v1.56.0 

func (r *DescribeStreamInfosByUserIdRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeStreamInfosByUserIdRequest) SetUserId added in v1.56.0 

func (r *DescribeStreamInfosByUserIdRequest) SetUserId(userId string)

param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId(Required)

func (*DescribeStreamInfosByUserIdRequest) SetUserRoomId added in v1.56.0 

func (r *DescribeStreamInfosByUserIdRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Required)

type DescribeStreamInfosByUserIdResponse added in v1.56.0 

type DescribeStreamInfosByUserIdResponse struct {
	RequestID string                            `json:"requestId"`
	Error     core.ErrorResponse                `json:"error"`
	Result    DescribeStreamInfosByUserIdResult `json:"result"`
}

type DescribeStreamInfosByUserIdResult added in v1.56.0 

type DescribeStreamInfosByUserIdResult struct {
	Content []openjrtc.StreamInfo `json:"content"`
}

type DescribeStreamInfosByUserRoomIdRequest added in v1.56.0 

type DescribeStreamInfosByUserRoomIdRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号  */
	UserRoomId string `json:"userRoomId"`

	/* 传参字段描述:
	- status[eq] 在线状态 1-在线 2-离线
	- kind[eq] 在线状态 1-音频流 2-视频流 100-数据流
	- startTime[eq] 用户推流开始时间-UTC时间  startTime,endTime同时指定时生效
	- endTime[eq]   用户推流结束时间-UTC时间  startTime,endTime同时指定时生效
	 (Optional) */
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeStreamInfosByUserRoomIdRequest added in v1.56.0 

func NewDescribeStreamInfosByUserRoomIdRequest(
	appId string,
	userRoomId string,
) *DescribeStreamInfosByUserRoomIdRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeStreamInfosByUserRoomIdRequestWithAllParams added in v1.56.0 

func NewDescribeStreamInfosByUserRoomIdRequestWithAllParams(
	appId string,
	pageNumber *int,
	pageSize *int,
	userRoomId string,
	filters []openjrtc.Filter,
) *DescribeStreamInfosByUserRoomIdRequest
  • param appId: 应用ID (Required)
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required)
  • param filters: 传参字段描述:
  • status[eq] 在线状态 1-在线 2-离线
  • kind[eq] 在线状态 1-音频流 2-视频流 100-数据流
  • startTime[eq] 用户推流开始时间-UTC时间 startTime,endTime同时指定时生效
  • endTime[eq] 用户推流结束时间-UTC时间 startTime,endTime同时指定时生效 (Optional)

func NewDescribeStreamInfosByUserRoomIdRequestWithoutParam added in v1.56.0 

func NewDescribeStreamInfosByUserRoomIdRequestWithoutParam() *DescribeStreamInfosByUserRoomIdRequest

This constructor has better compatible ability when API parameters changed

func (DescribeStreamInfosByUserRoomIdRequest) GetRegionId added in v1.56.0 

func (r DescribeStreamInfosByUserRoomIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeStreamInfosByUserRoomIdRequest) SetAppId added in v1.56.0 

func (r *DescribeStreamInfosByUserRoomIdRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeStreamInfosByUserRoomIdRequest) SetFilters added in v1.56.0 

func (r *DescribeStreamInfosByUserRoomIdRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:

- status[eq] 在线状态 1-在线 2-离线 - kind[eq] 在线状态 1-音频流 2-视频流 100-数据流 - startTime[eq] 用户推流开始时间-UTC时间 startTime,endTime同时指定时生效 - endTime[eq] 用户推流结束时间-UTC时间 startTime,endTime同时指定时生效 (Optional)

func (*DescribeStreamInfosByUserRoomIdRequest) SetPageNumber added in v1.56.0 

func (r *DescribeStreamInfosByUserRoomIdRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeStreamInfosByUserRoomIdRequest) SetPageSize added in v1.56.0 

func (r *DescribeStreamInfosByUserRoomIdRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

func (*DescribeStreamInfosByUserRoomIdRequest) SetUserRoomId added in v1.56.0 

func (r *DescribeStreamInfosByUserRoomIdRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Required)

type DescribeStreamInfosByUserRoomIdResponse added in v1.56.0 

type DescribeStreamInfosByUserRoomIdResponse struct {
	RequestID string                                `json:"requestId"`
	Error     core.ErrorResponse                    `json:"error"`
	Result    DescribeStreamInfosByUserRoomIdResult `json:"result"`
}

type DescribeStreamInfosByUserRoomIdResult added in v1.56.0 

type DescribeStreamInfosByUserRoomIdResult struct {
	PageNumber    int                   `json:"pageNumber"`
	PageSize      int                   `json:"pageSize"`
	TotalElements int                   `json:"totalElements"`
	TotalPages    int                   `json:"totalPages"`
	Content       []openjrtc.StreamInfo `json:"content"`
}

type DescribeStreamRecordsByStreamIdRequest added in v1.56.0 

type DescribeStreamRecordsByStreamIdRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 流ID  */
	StreamId string `json:"streamId"`

	/* 传参字段描述:
	- startTime[eq] 用户推流开始时间-UTC时间  startTime,endTime同时指定时生效
	- endTime[eq]   用户推流结束时间-UTC时间  startTime,endTime同时指定时生效
	 (Optional) */
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeStreamRecordsByStreamIdRequest added in v1.56.0 

func NewDescribeStreamRecordsByStreamIdRequest(
	appId string,
	streamId string,
) *DescribeStreamRecordsByStreamIdRequest

* param appId: 应用ID (Required) * param streamId: 流ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeStreamRecordsByStreamIdRequestWithAllParams added in v1.56.0 

func NewDescribeStreamRecordsByStreamIdRequestWithAllParams(
	appId string,
	pageNumber *int,
	pageSize *int,
	streamId string,
	filters []openjrtc.Filter,
) *DescribeStreamRecordsByStreamIdRequest
  • param appId: 应用ID (Required)
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param streamId: 流ID (Required)
  • param filters: 传参字段描述:
  • startTime[eq] 用户推流开始时间-UTC时间 startTime,endTime同时指定时生效
  • endTime[eq] 用户推流结束时间-UTC时间 startTime,endTime同时指定时生效 (Optional)

func NewDescribeStreamRecordsByStreamIdRequestWithoutParam added in v1.56.0 

func NewDescribeStreamRecordsByStreamIdRequestWithoutParam() *DescribeStreamRecordsByStreamIdRequest

This constructor has better compatible ability when API parameters changed

func (DescribeStreamRecordsByStreamIdRequest) GetRegionId added in v1.56.0 

func (r DescribeStreamRecordsByStreamIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeStreamRecordsByStreamIdRequest) SetAppId added in v1.56.0 

func (r *DescribeStreamRecordsByStreamIdRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeStreamRecordsByStreamIdRequest) SetFilters added in v1.56.0 

func (r *DescribeStreamRecordsByStreamIdRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:

- startTime[eq] 用户推流开始时间-UTC时间 startTime,endTime同时指定时生效 - endTime[eq] 用户推流结束时间-UTC时间 startTime,endTime同时指定时生效 (Optional)

func (*DescribeStreamRecordsByStreamIdRequest) SetPageNumber added in v1.56.0 

func (r *DescribeStreamRecordsByStreamIdRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeStreamRecordsByStreamIdRequest) SetPageSize added in v1.56.0 

func (r *DescribeStreamRecordsByStreamIdRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

func (*DescribeStreamRecordsByStreamIdRequest) SetStreamId added in v1.56.0 

func (r *DescribeStreamRecordsByStreamIdRequest) SetStreamId(streamId string)

param streamId: 流ID(Required)

type DescribeStreamRecordsByStreamIdResponse added in v1.56.0 

type DescribeStreamRecordsByStreamIdResponse struct {
	RequestID string                                `json:"requestId"`
	Error     core.ErrorResponse                    `json:"error"`
	Result    DescribeStreamRecordsByStreamIdResult `json:"result"`
}

type DescribeStreamRecordsByStreamIdResult added in v1.56.0 

type DescribeStreamRecordsByStreamIdResult struct {
	PageNumber    int                         `json:"pageNumber"`
	PageSize      int                         `json:"pageSize"`
	TotalElements int                         `json:"totalElements"`
	TotalPages    int                         `json:"totalPages"`
	Content       []openjrtc.StreamRecordInfo `json:"content"`
}

type DescribeStreamRecordsByUserIdRequest added in v1.56.0 

type DescribeStreamRecordsByUserIdRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号  */
	UserRoomId string `json:"userRoomId"`

	/* 业务接入方用户体系定义的且在JRTC系统内注册过的userId  */
	UserId string `json:"userId"`

	/* 传参字段描述:
	- kind[eq] 在线状态 1-音频流 2-视频流 100-数据流
	- startTime[eq] 用户推流开始时间-UTC时间  startTime,endTime同时指定时生效
	- endTime[eq]   用户推流结束时间-UTC时间  startTime,endTime同时指定时生效
	 (Optional) */
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeStreamRecordsByUserIdRequest added in v1.56.0 

func NewDescribeStreamRecordsByUserIdRequest(
	appId string,
	userRoomId string,
	userId string,
) *DescribeStreamRecordsByUserIdRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeStreamRecordsByUserIdRequestWithAllParams added in v1.56.0 

func NewDescribeStreamRecordsByUserIdRequestWithAllParams(
	appId string,
	pageNumber *int,
	pageSize *int,
	userRoomId string,
	userId string,
	filters []openjrtc.Filter,
) *DescribeStreamRecordsByUserIdRequest
  • param appId: 应用ID (Required)
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required)
  • param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Required)
  • param filters: 传参字段描述:
  • kind[eq] 在线状态 1-音频流 2-视频流 100-数据流
  • startTime[eq] 用户推流开始时间-UTC时间 startTime,endTime同时指定时生效
  • endTime[eq] 用户推流结束时间-UTC时间 startTime,endTime同时指定时生效 (Optional)

func NewDescribeStreamRecordsByUserIdRequestWithoutParam added in v1.56.0 

func NewDescribeStreamRecordsByUserIdRequestWithoutParam() *DescribeStreamRecordsByUserIdRequest

This constructor has better compatible ability when API parameters changed

func (DescribeStreamRecordsByUserIdRequest) GetRegionId added in v1.56.0 

func (r DescribeStreamRecordsByUserIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeStreamRecordsByUserIdRequest) SetAppId added in v1.56.0 

func (r *DescribeStreamRecordsByUserIdRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeStreamRecordsByUserIdRequest) SetFilters added in v1.56.0 

func (r *DescribeStreamRecordsByUserIdRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:

- kind[eq] 在线状态 1-音频流 2-视频流 100-数据流 - startTime[eq] 用户推流开始时间-UTC时间 startTime,endTime同时指定时生效 - endTime[eq] 用户推流结束时间-UTC时间 startTime,endTime同时指定时生效 (Optional)

func (*DescribeStreamRecordsByUserIdRequest) SetPageNumber added in v1.56.0 

func (r *DescribeStreamRecordsByUserIdRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeStreamRecordsByUserIdRequest) SetPageSize added in v1.56.0 

func (r *DescribeStreamRecordsByUserIdRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

func (*DescribeStreamRecordsByUserIdRequest) SetUserId added in v1.56.0 

func (r *DescribeStreamRecordsByUserIdRequest) SetUserId(userId string)

param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId(Required)

func (*DescribeStreamRecordsByUserIdRequest) SetUserRoomId added in v1.56.0 

func (r *DescribeStreamRecordsByUserIdRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Required)

type DescribeStreamRecordsByUserIdResponse added in v1.56.0 

type DescribeStreamRecordsByUserIdResponse struct {
	RequestID string                              `json:"requestId"`
	Error     core.ErrorResponse                  `json:"error"`
	Result    DescribeStreamRecordsByUserIdResult `json:"result"`
}

type DescribeStreamRecordsByUserIdResult added in v1.56.0 

type DescribeStreamRecordsByUserIdResult struct {
	PageNumber    int                         `json:"pageNumber"`
	PageSize      int                         `json:"pageSize"`
	TotalElements int                         `json:"totalElements"`
	TotalPages    int                         `json:"totalPages"`
	Content       []openjrtc.StreamRecordInfo `json:"content"`
}

type DescribeUserByPeerRequest added in v1.56.0 

type DescribeUserByPeerRequest struct {
	core.JDCloudRequest

	/* peerId  */
	PeerId int `json:"peerId"`
}

func NewDescribeUserByPeerRequest added in v1.56.0 

func NewDescribeUserByPeerRequest(
	peerId int,
) *DescribeUserByPeerRequest

* param peerId: peerId (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeUserByPeerRequestWithAllParams added in v1.56.0 

func NewDescribeUserByPeerRequestWithAllParams(
	peerId int,
) *DescribeUserByPeerRequest

* param peerId: peerId (Required)

func NewDescribeUserByPeerRequestWithoutParam added in v1.56.0 

func NewDescribeUserByPeerRequestWithoutParam() *DescribeUserByPeerRequest

This constructor has better compatible ability when API parameters changed

func (DescribeUserByPeerRequest) GetRegionId added in v1.56.0 

func (r DescribeUserByPeerRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeUserByPeerRequest) SetPeerId added in v1.56.0 

func (r *DescribeUserByPeerRequest) SetPeerId(peerId int)

param peerId: peerId(Required)

type DescribeUserByPeerResponse added in v1.56.0 

type DescribeUserByPeerResponse struct {
	RequestID string                   `json:"requestId"`
	Error     core.ErrorResponse       `json:"error"`
	Result    DescribeUserByPeerResult `json:"result"`
}

type DescribeUserByPeerResult added in v1.56.0 

type DescribeUserByPeerResult struct {
	PeerId     int64  `json:"peerId"`
	AppId      string `json:"appId"`
	UserId     string `json:"userId"`
	Temporary  bool   `json:"temporary"`
	CreateTime string `json:"createTime"`
}

type DescribeUserRecordByRoomRequest added in v1.56.0 

type DescribeUserRecordByRoomRequest struct {
	core.JDCloudRequest

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 传参字段描述:
	appId:   应用ID (必填)
	startTime: 房间使用起始时间 UTC格式 (必填)
	endTime：房间使用截止时间 UTC格式 (必填)
	userRoomId：业务接入方定义的且在JRTC系统内注册过的房间号(必填)
	userId：业务接入方定义的且在JRTC系统内注册过的用户id
	*/
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeUserRecordByRoomRequest added in v1.56.0 

func NewDescribeUserRecordByRoomRequest(
	filters []openjrtc.Filter,
) *DescribeUserRecordByRoomRequest
  • param filters: 传参字段描述: appId: 应用ID (必填) startTime: 房间使用起始时间 UTC格式 (必填) endTime：房间使用截止时间 UTC格式 (必填) userRoomId：业务接入方定义的且在JRTC系统内注册过的房间号(必填) userId：业务接入方定义的且在JRTC系统内注册过的用户id

(Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeUserRecordByRoomRequestWithAllParams added in v1.56.0 

func NewDescribeUserRecordByRoomRequestWithAllParams(
	pageNumber *int,
	pageSize *int,
	filters []openjrtc.Filter,
) *DescribeUserRecordByRoomRequest
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param filters: 传参字段描述: appId: 应用ID (必填) startTime: 房间使用起始时间 UTC格式 (必填) endTime：房间使用截止时间 UTC格式 (必填) userRoomId：业务接入方定义的且在JRTC系统内注册过的房间号(必填) userId：业务接入方定义的且在JRTC系统内注册过的用户id

(Required)

func NewDescribeUserRecordByRoomRequestWithoutParam added in v1.56.0 

func NewDescribeUserRecordByRoomRequestWithoutParam() *DescribeUserRecordByRoomRequest

This constructor has better compatible ability when API parameters changed

func (DescribeUserRecordByRoomRequest) GetRegionId added in v1.56.0 

func (r DescribeUserRecordByRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeUserRecordByRoomRequest) SetFilters added in v1.56.0 

func (r *DescribeUserRecordByRoomRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:
 appId:   应用ID (必填)
 startTime: 房间使用起始时间 UTC格式 (必填)
 endTime：房间使用截止时间 UTC格式 (必填)
 userRoomId：业务接入方定义的且在JRTC系统内注册过的房间号(必填)
 userId：业务接入方定义的且在JRTC系统内注册过的用户id

(Required)

func (*DescribeUserRecordByRoomRequest) SetPageNumber added in v1.56.0 

func (r *DescribeUserRecordByRoomRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeUserRecordByRoomRequest) SetPageSize added in v1.56.0 

func (r *DescribeUserRecordByRoomRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

type DescribeUserRecordByRoomResponse added in v1.56.0 

type DescribeUserRecordByRoomResponse struct {
	RequestID string                         `json:"requestId"`
	Error     core.ErrorResponse             `json:"error"`
	Result    DescribeUserRecordByRoomResult `json:"result"`
}

type DescribeUserRecordByRoomResult added in v1.56.0 

type DescribeUserRecordByRoomResult struct {
	PageNumber    int                       `json:"pageNumber"`
	PageSize      int                       `json:"pageSize"`
	TotalElements int                       `json:"totalElements"`
	TotalPages    int                       `json:"totalPages"`
	Content       []openjrtc.RoomUserRecord `json:"content"`
}

type DescribeUserRoomRequest added in v1.56.0 

type DescribeUserRoomRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号  */
	UserRoomId string `json:"userRoomId"`
}

func NewDescribeUserRoomRequest added in v1.56.0 

func NewDescribeUserRoomRequest(
	appId string,
	userRoomId string,
) *DescribeUserRoomRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeUserRoomRequestWithAllParams added in v1.56.0 

func NewDescribeUserRoomRequestWithAllParams(
	appId string,
	userRoomId string,
) *DescribeUserRoomRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Required)

func NewDescribeUserRoomRequestWithoutParam added in v1.56.0 

func NewDescribeUserRoomRequestWithoutParam() *DescribeUserRoomRequest

This constructor has better compatible ability when API parameters changed

func (DescribeUserRoomRequest) GetRegionId added in v1.56.0 

func (r DescribeUserRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeUserRoomRequest) SetAppId added in v1.56.0 

func (r *DescribeUserRoomRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeUserRoomRequest) SetUserRoomId added in v1.56.0 

func (r *DescribeUserRoomRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Required)

type DescribeUserRoomResponse added in v1.56.0 

type DescribeUserRoomResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    DescribeUserRoomResult `json:"result"`
}

type DescribeUserRoomResult added in v1.56.0 

type DescribeUserRoomResult struct {
	RoomId     int64  `json:"roomId"`
	UserRoomId string `json:"userRoomId"`
	RoomName   string `json:"roomName"`
	RoomType   int    `json:"roomType"`
	AppId      string `json:"appId"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

type DescribeUserRoomsRequest added in v1.56.0 

type DescribeUserRoomsRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 传参字段描述:
	 - startTime[eq] 按房间注册时间段查询-UTC时间 startTime,endTime同时有值时生效
	 - endTime[eq] 按房间注册时间段查询-UTC时间   startTime,endTime同时有值时生效
	(Optional) */
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeUserRoomsRequest added in v1.56.0 

func NewDescribeUserRoomsRequest(
	appId string,
) *DescribeUserRoomsRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeUserRoomsRequestWithAllParams added in v1.56.0 

func NewDescribeUserRoomsRequestWithAllParams(
	appId string,
	pageNumber *int,
	pageSize *int,
	filters []openjrtc.Filter,
) *DescribeUserRoomsRequest

* param appId: 应用ID (Required) * param pageNumber: 页码；默认值为 1 (Optional) * param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional) * param filters: 传参字段描述:

  • startTime[eq] 按房间注册时间段查询-UTC时间 startTime,endTime同时有值时生效
  • endTime[eq] 按房间注册时间段查询-UTC时间 startTime,endTime同时有值时生效

(Optional)

func NewDescribeUserRoomsRequestWithoutParam added in v1.56.0 

func NewDescribeUserRoomsRequestWithoutParam() *DescribeUserRoomsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeUserRoomsRequest) GetRegionId added in v1.56.0 

func (r DescribeUserRoomsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeUserRoomsRequest) SetAppId added in v1.56.0 

func (r *DescribeUserRoomsRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeUserRoomsRequest) SetFilters added in v1.56.0 

func (r *DescribeUserRoomsRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:
 - startTime[eq] 按房间注册时间段查询-UTC时间 startTime,endTime同时有值时生效
 - endTime[eq] 按房间注册时间段查询-UTC时间   startTime,endTime同时有值时生效

(Optional)

func (*DescribeUserRoomsRequest) SetPageNumber added in v1.56.0 

func (r *DescribeUserRoomsRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeUserRoomsRequest) SetPageSize added in v1.56.0 

func (r *DescribeUserRoomsRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

type DescribeUserRoomsResponse added in v1.56.0 

type DescribeUserRoomsResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    DescribeUserRoomsResult `json:"result"`
}

type DescribeUserRoomsResult added in v1.56.0 

type DescribeUserRoomsResult struct {
	PageNumber    int                        `json:"pageNumber"`
	PageSize      int                        `json:"pageSize"`
	TotalElements int                        `json:"totalElements"`
	TotalPages    int                        `json:"totalPages"`
	Content       []openjrtc.UserRoomInfoObj `json:"content"`
}

type PostMessageToUserRequest added in v1.56.0 

type PostMessageToUserRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Optional) */
	UserId *string `json:"userId"`

	/* 事件名称 (Optional) */
	EventName *string `json:"eventName"`

	/* 自定义信令消息 (Optional) */
	Message *string `json:"message"`
}

func NewPostMessageToUserRequest added in v1.56.0 

func NewPostMessageToUserRequest() *PostMessageToUserRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewPostMessageToUserRequestWithAllParams added in v1.56.0 

func NewPostMessageToUserRequestWithAllParams(
	appId *string,
	userRoomId *string,
	userId *string,
	eventName *string,
	message *string,
) *PostMessageToUserRequest

* param appId: 应用ID (Optional) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) * param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId (Optional) * param eventName: 事件名称 (Optional) * param message: 自定义信令消息 (Optional)

func NewPostMessageToUserRequestWithoutParam added in v1.56.0 

func NewPostMessageToUserRequestWithoutParam() *PostMessageToUserRequest

This constructor has better compatible ability when API parameters changed

func (PostMessageToUserRequest) GetRegionId added in v1.56.0 

func (r PostMessageToUserRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*PostMessageToUserRequest) SetAppId added in v1.56.0 

func (r *PostMessageToUserRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*PostMessageToUserRequest) SetEventName added in v1.56.0 

func (r *PostMessageToUserRequest) SetEventName(eventName string)

param eventName: 事件名称(Optional)

func (*PostMessageToUserRequest) SetMessage added in v1.56.0 

func (r *PostMessageToUserRequest) SetMessage(message string)

param message: 自定义信令消息(Optional)

func (*PostMessageToUserRequest) SetUserId added in v1.56.0 

func (r *PostMessageToUserRequest) SetUserId(userId string)

param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId(Optional)

func (*PostMessageToUserRequest) SetUserRoomId added in v1.56.0 

func (r *PostMessageToUserRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type PostMessageToUserResponse added in v1.56.0 

type PostMessageToUserResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    PostMessageToUserResult `json:"result"`
}

type PostMessageToUserResult added in v1.56.0 

type PostMessageToUserResult struct {
}

type PostMessageToUserRoomRequest added in v1.56.0 

type PostMessageToUserRoomRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 事件名称 (Optional) */
	EventName *string `json:"eventName"`

	/* 自定义信令消息 (Optional) */
	Message *string `json:"message"`
}

func NewPostMessageToUserRoomRequest added in v1.56.0 

func NewPostMessageToUserRoomRequest() *PostMessageToUserRoomRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewPostMessageToUserRoomRequestWithAllParams added in v1.56.0 

func NewPostMessageToUserRoomRequestWithAllParams(
	appId *string,
	userRoomId *string,
	eventName *string,
	message *string,
) *PostMessageToUserRoomRequest

* param appId: 应用ID (Optional) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) * param eventName: 事件名称 (Optional) * param message: 自定义信令消息 (Optional)

func NewPostMessageToUserRoomRequestWithoutParam added in v1.56.0 

func NewPostMessageToUserRoomRequestWithoutParam() *PostMessageToUserRoomRequest

This constructor has better compatible ability when API parameters changed

func (PostMessageToUserRoomRequest) GetRegionId added in v1.56.0 

func (r PostMessageToUserRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*PostMessageToUserRoomRequest) SetAppId added in v1.56.0 

func (r *PostMessageToUserRoomRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*PostMessageToUserRoomRequest) SetEventName added in v1.56.0 

func (r *PostMessageToUserRoomRequest) SetEventName(eventName string)

param eventName: 事件名称(Optional)

func (*PostMessageToUserRoomRequest) SetMessage added in v1.56.0 

func (r *PostMessageToUserRoomRequest) SetMessage(message string)

param message: 自定义信令消息(Optional)

func (*PostMessageToUserRoomRequest) SetUserRoomId added in v1.56.0 

func (r *PostMessageToUserRoomRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type PostMessageToUserRoomResponse added in v1.56.0 

type PostMessageToUserRoomResponse struct {
	RequestID string                      `json:"requestId"`
	Error     core.ErrorResponse          `json:"error"`
	Result    PostMessageToUserRoomResult `json:"result"`
}

type PostMessageToUserRoomResult added in v1.56.0 

type PostMessageToUserRoomResult struct {
}

type RegisterUserRequest added in v1.56.0 

type RegisterUserRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 用户名称 (Optional) */
	UserName *string `json:"userName"`

	/* 业务接入方用户体系定义的userId (Optional) */
	UserId *string `json:"userId"`

	/* 是否临时用户 (Optional) */
	Temporary *bool `json:"temporary"`
}

func NewRegisterUserRequest added in v1.56.0 

func NewRegisterUserRequest() *RegisterUserRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewRegisterUserRequestWithAllParams added in v1.56.0 

func NewRegisterUserRequestWithAllParams(
	appId *string,
	userName *string,
	userId *string,
	temporary *bool,
) *RegisterUserRequest

* param appId: 应用ID (Optional) * param userName: 用户名称 (Optional) * param userId: 业务接入方用户体系定义的userId (Optional) * param temporary: 是否临时用户 (Optional)

func NewRegisterUserRequestWithoutParam added in v1.56.0 

func NewRegisterUserRequestWithoutParam() *RegisterUserRequest

This constructor has better compatible ability when API parameters changed

func (RegisterUserRequest) GetRegionId added in v1.56.0 

func (r RegisterUserRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RegisterUserRequest) SetAppId added in v1.56.0 

func (r *RegisterUserRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*RegisterUserRequest) SetTemporary added in v1.56.0 

func (r *RegisterUserRequest) SetTemporary(temporary bool)

param temporary: 是否临时用户(Optional)

func (*RegisterUserRequest) SetUserId added in v1.56.0 

func (r *RegisterUserRequest) SetUserId(userId string)

param userId: 业务接入方用户体系定义的userId(Optional)

func (*RegisterUserRequest) SetUserName added in v1.56.0 

func (r *RegisterUserRequest) SetUserName(userName string)

param userName: 用户名称(Optional)

type RegisterUserResponse added in v1.56.0 

type RegisterUserResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    RegisterUserResult `json:"result"`
}

type RegisterUserResult added in v1.56.0 

type RegisterUserResult struct {
	AppId  string `json:"appId"`
	UserId string `json:"userId"`
	PeerId int64  `json:"peerId"`
}

type RegisterUserRoomRequest added in v1.56.0 

type RegisterUserRoomRequest struct {
	core.JDCloudRequest

	/* 业务接入方定义的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 房间名称 (Optional) */
	RoomName *string `json:"roomName"`

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 房间类型 1-小房间(音频单流订阅) 2-大房间(音频固定订阅),默认取控制台APP对应的房间类型 (Optional) */
	RoomType *int `json:"roomType"`
}

func NewRegisterUserRoomRequest added in v1.56.0 

func NewRegisterUserRoomRequest() *RegisterUserRoomRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewRegisterUserRoomRequestWithAllParams added in v1.56.0 

func NewRegisterUserRoomRequestWithAllParams(
	userRoomId *string,
	roomName *string,
	appId *string,
	roomType *int,
) *RegisterUserRoomRequest

* param userRoomId: 业务接入方定义的房间号 (Optional) * param roomName: 房间名称 (Optional) * param appId: 应用ID (Optional) * param roomType: 房间类型 1-小房间(音频单流订阅) 2-大房间(音频固定订阅),默认取控制台APP对应的房间类型 (Optional)

func NewRegisterUserRoomRequestWithoutParam added in v1.56.0 

func NewRegisterUserRoomRequestWithoutParam() *RegisterUserRoomRequest

This constructor has better compatible ability when API parameters changed

func (RegisterUserRoomRequest) GetRegionId added in v1.56.0 

func (r RegisterUserRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RegisterUserRoomRequest) SetAppId added in v1.56.0 

func (r *RegisterUserRoomRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*RegisterUserRoomRequest) SetRoomName added in v1.56.0 

func (r *RegisterUserRoomRequest) SetRoomName(roomName string)

param roomName: 房间名称(Optional)

func (*RegisterUserRoomRequest) SetRoomType added in v1.56.0 

func (r *RegisterUserRoomRequest) SetRoomType(roomType int)

param roomType: 房间类型 1-小房间(音频单流订阅) 2-大房间(音频固定订阅),默认取控制台APP对应的房间类型(Optional)

func (*RegisterUserRoomRequest) SetUserRoomId added in v1.56.0 

func (r *RegisterUserRoomRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的房间号(Optional)

type RegisterUserRoomResponse added in v1.56.0 

type RegisterUserRoomResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    RegisterUserRoomResult `json:"result"`
}

type RegisterUserRoomResult added in v1.56.0 

type RegisterUserRoomResult struct {
	RoomId     int64  `json:"roomId"`
	UserRoomId string `json:"userRoomId"`
	RoomName   string `json:"roomName"`
	RoomType   int    `json:"roomType"`
	AppId      string `json:"appId"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

type RemoveAllRoomUsersRequest added in v1.56.0 

type RemoveAllRoomUsersRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 房间ID  */
	RoomId int `json:"roomId"`
}

func NewRemoveAllRoomUsersRequest added in v1.56.0 

func NewRemoveAllRoomUsersRequest(
	appId string,
	roomId int,
) *RemoveAllRoomUsersRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewRemoveAllRoomUsersRequestWithAllParams added in v1.56.0 

func NewRemoveAllRoomUsersRequestWithAllParams(
	appId string,
	roomId int,
) *RemoveAllRoomUsersRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required)

func NewRemoveAllRoomUsersRequestWithoutParam added in v1.56.0 

func NewRemoveAllRoomUsersRequestWithoutParam() *RemoveAllRoomUsersRequest

This constructor has better compatible ability when API parameters changed

func (RemoveAllRoomUsersRequest) GetRegionId added in v1.56.0 

func (r RemoveAllRoomUsersRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RemoveAllRoomUsersRequest) SetAppId added in v1.56.0 

func (r *RemoveAllRoomUsersRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*RemoveAllRoomUsersRequest) SetRoomId added in v1.56.0 

func (r *RemoveAllRoomUsersRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type RemoveAllRoomUsersResponse added in v1.56.0 

type RemoveAllRoomUsersResponse struct {
	RequestID string                   `json:"requestId"`
	Error     core.ErrorResponse       `json:"error"`
	Result    RemoveAllRoomUsersResult `json:"result"`
}

type RemoveAllRoomUsersResult added in v1.56.0 

type RemoveAllRoomUsersResult struct {
}

type RemoveAllUsersByUserRoomIdRequest added in v1.56.0 

type RemoveAllUsersByUserRoomIdRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`
}

func NewRemoveAllUsersByUserRoomIdRequest added in v1.56.0 

func NewRemoveAllUsersByUserRoomIdRequest(
	appId string,
) *RemoveAllUsersByUserRoomIdRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewRemoveAllUsersByUserRoomIdRequestWithAllParams added in v1.56.0 

func NewRemoveAllUsersByUserRoomIdRequestWithAllParams(
	appId string,
	userRoomId *string,
) *RemoveAllUsersByUserRoomIdRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional)

func NewRemoveAllUsersByUserRoomIdRequestWithoutParam added in v1.56.0 

func NewRemoveAllUsersByUserRoomIdRequestWithoutParam() *RemoveAllUsersByUserRoomIdRequest

This constructor has better compatible ability when API parameters changed

func (RemoveAllUsersByUserRoomIdRequest) GetRegionId added in v1.56.0 

func (r RemoveAllUsersByUserRoomIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RemoveAllUsersByUserRoomIdRequest) SetAppId added in v1.56.0 

func (r *RemoveAllUsersByUserRoomIdRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*RemoveAllUsersByUserRoomIdRequest) SetUserRoomId added in v1.56.0 

func (r *RemoveAllUsersByUserRoomIdRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type RemoveAllUsersByUserRoomIdResponse added in v1.56.0 

type RemoveAllUsersByUserRoomIdResponse struct {
	RequestID string                           `json:"requestId"`
	Error     core.ErrorResponse               `json:"error"`
	Result    RemoveAllUsersByUserRoomIdResult `json:"result"`
}

type RemoveAllUsersByUserRoomIdResult added in v1.56.0 

type RemoveAllUsersByUserRoomIdResult struct {
}

type RemoveRoomUserRequest added in v1.56.0 

type RemoveRoomUserRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 房间ID  */
	RoomId int `json:"roomId"`

	/* peerId列表,最多支持20个peerId (Optional) */
	PeerIds []int64 `json:"peerIds"`
}

func NewRemoveRoomUserRequest added in v1.56.0 

func NewRemoveRoomUserRequest(
	appId string,
	roomId int,
) *RemoveRoomUserRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewRemoveRoomUserRequestWithAllParams added in v1.56.0 

func NewRemoveRoomUserRequestWithAllParams(
	appId string,
	roomId int,
	peerIds []int64,
) *RemoveRoomUserRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * param peerIds: peerId列表,最多支持20个peerId (Optional)

func NewRemoveRoomUserRequestWithoutParam added in v1.56.0 

func NewRemoveRoomUserRequestWithoutParam() *RemoveRoomUserRequest

This constructor has better compatible ability when API parameters changed

func (RemoveRoomUserRequest) GetRegionId added in v1.56.0 

func (r RemoveRoomUserRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RemoveRoomUserRequest) SetAppId added in v1.56.0 

func (r *RemoveRoomUserRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*RemoveRoomUserRequest) SetPeerIds added in v1.56.0 

func (r *RemoveRoomUserRequest) SetPeerIds(peerIds []int64)

param peerIds: peerId列表,最多支持20个peerId(Optional)

func (*RemoveRoomUserRequest) SetRoomId added in v1.56.0 

func (r *RemoveRoomUserRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type RemoveRoomUserResponse added in v1.56.0 

type RemoveRoomUserResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    RemoveRoomUserResult `json:"result"`
}

type RemoveRoomUserResult added in v1.56.0 

type RemoveRoomUserResult struct {
}

type RemoveUserByUserRoomIdRequest added in v1.56.0 

type RemoveUserByUserRoomIdRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 接入方定义的userId列表,最多支持20个userId (Optional) */
	UserIds []string `json:"userIds"`
}

func NewRemoveUserByUserRoomIdRequest added in v1.56.0 

func NewRemoveUserByUserRoomIdRequest(
	appId string,
) *RemoveUserByUserRoomIdRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewRemoveUserByUserRoomIdRequestWithAllParams added in v1.56.0 

func NewRemoveUserByUserRoomIdRequestWithAllParams(
	appId string,
	userRoomId *string,
	userIds []string,
) *RemoveUserByUserRoomIdRequest

* param appId: 应用ID (Required) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) * param userIds: 接入方定义的userId列表,最多支持20个userId (Optional)

func NewRemoveUserByUserRoomIdRequestWithoutParam added in v1.56.0 

func NewRemoveUserByUserRoomIdRequestWithoutParam() *RemoveUserByUserRoomIdRequest

This constructor has better compatible ability when API parameters changed

func (RemoveUserByUserRoomIdRequest) GetRegionId added in v1.56.0 

func (r RemoveUserByUserRoomIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*RemoveUserByUserRoomIdRequest) SetAppId added in v1.56.0 

func (r *RemoveUserByUserRoomIdRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*RemoveUserByUserRoomIdRequest) SetUserIds added in v1.56.0 

func (r *RemoveUserByUserRoomIdRequest) SetUserIds(userIds []string)

param userIds: 接入方定义的userId列表,最多支持20个userId(Optional)

func (*RemoveUserByUserRoomIdRequest) SetUserRoomId added in v1.56.0 

func (r *RemoveUserByUserRoomIdRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type RemoveUserByUserRoomIdResponse added in v1.56.0 

type RemoveUserByUserRoomIdResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    RemoveUserByUserRoomIdResult `json:"result"`
}

type RemoveUserByUserRoomIdResult added in v1.56.0 

type RemoveUserByUserRoomIdResult struct {
}

type SendMessageToRoomRequest added in v1.56.0 

type SendMessageToRoomRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 房间ID  */
	RoomId int `json:"roomId"`

	/* 事件名称 (Optional) */
	EventName *string `json:"eventName"`

	/* 自定义信令消息 (Optional) */
	Message *string `json:"message"`
}

func NewSendMessageToRoomRequest added in v1.56.0 

func NewSendMessageToRoomRequest(
	appId string,
	roomId int,
) *SendMessageToRoomRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewSendMessageToRoomRequestWithAllParams added in v1.56.0 

func NewSendMessageToRoomRequestWithAllParams(
	appId string,
	roomId int,
	eventName *string,
	message *string,
) *SendMessageToRoomRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * param eventName: 事件名称 (Optional) * param message: 自定义信令消息 (Optional)

func NewSendMessageToRoomRequestWithoutParam added in v1.56.0 

func NewSendMessageToRoomRequestWithoutParam() *SendMessageToRoomRequest

This constructor has better compatible ability when API parameters changed

func (SendMessageToRoomRequest) GetRegionId added in v1.56.0 

func (r SendMessageToRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*SendMessageToRoomRequest) SetAppId added in v1.56.0 

func (r *SendMessageToRoomRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*SendMessageToRoomRequest) SetEventName added in v1.56.0 

func (r *SendMessageToRoomRequest) SetEventName(eventName string)

param eventName: 事件名称(Optional)

func (*SendMessageToRoomRequest) SetMessage added in v1.56.0 

func (r *SendMessageToRoomRequest) SetMessage(message string)

param message: 自定义信令消息(Optional)

func (*SendMessageToRoomRequest) SetRoomId added in v1.56.0 

func (r *SendMessageToRoomRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type SendMessageToRoomResponse added in v1.56.0 

type SendMessageToRoomResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    SendMessageToRoomResult `json:"result"`
}

type SendMessageToRoomResult added in v1.56.0 

type SendMessageToRoomResult struct {
}

type SendMessageToUserRequest added in v1.56.0 

type SendMessageToUserRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 房间ID  */
	RoomId int `json:"roomId"`

	/* 事件名称 (Optional) */
	EventName *string `json:"eventName"`

	/* 自定义信令消息 (Optional) */
	Message *string `json:"message"`

	/* peerId (Optional) */
	PeerId *int64 `json:"peerId"`
}

func NewSendMessageToUserRequest added in v1.56.0 

func NewSendMessageToUserRequest(
	appId string,
	roomId int,
) *SendMessageToUserRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewSendMessageToUserRequestWithAllParams added in v1.56.0 

func NewSendMessageToUserRequestWithAllParams(
	appId string,
	roomId int,
	eventName *string,
	message *string,
	peerId *int64,
) *SendMessageToUserRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required) * param eventName: 事件名称 (Optional) * param message: 自定义信令消息 (Optional) * param peerId: peerId (Optional)

func NewSendMessageToUserRequestWithoutParam added in v1.56.0 

func NewSendMessageToUserRequestWithoutParam() *SendMessageToUserRequest

This constructor has better compatible ability when API parameters changed

func (SendMessageToUserRequest) GetRegionId added in v1.56.0 

func (r SendMessageToUserRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*SendMessageToUserRequest) SetAppId added in v1.56.0 

func (r *SendMessageToUserRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*SendMessageToUserRequest) SetEventName added in v1.56.0 

func (r *SendMessageToUserRequest) SetEventName(eventName string)

param eventName: 事件名称(Optional)

func (*SendMessageToUserRequest) SetMessage added in v1.56.0 

func (r *SendMessageToUserRequest) SetMessage(message string)

param message: 自定义信令消息(Optional)

func (*SendMessageToUserRequest) SetPeerId added in v1.56.0 

func (r *SendMessageToUserRequest) SetPeerId(peerId int64)

param peerId: peerId(Optional)

func (*SendMessageToUserRequest) SetRoomId added in v1.56.0 

func (r *SendMessageToUserRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type SendMessageToUserResponse added in v1.56.0 

type SendMessageToUserResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    SendMessageToUserResult `json:"result"`
}

type SendMessageToUserResult added in v1.56.0 

type SendMessageToUserResult struct {
}

type StartAsrTaskRequest added in v1.56.0 

type StartAsrTaskRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 语音识别场景 0-全部识别转文字 (Optional) */
	AsrTaskType *int `json:"asrTaskType"`
}

func NewStartAsrTaskRequest added in v1.56.0 

func NewStartAsrTaskRequest() *StartAsrTaskRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewStartAsrTaskRequestWithAllParams added in v1.56.0 

func NewStartAsrTaskRequestWithAllParams(
	appId *string,
	userRoomId *string,
	asrTaskType *int,
) *StartAsrTaskRequest

* param appId: 应用ID (Optional) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) * param asrTaskType: 语音识别场景 0-全部识别转文字 (Optional)

func NewStartAsrTaskRequestWithoutParam added in v1.56.0 

func NewStartAsrTaskRequestWithoutParam() *StartAsrTaskRequest

This constructor has better compatible ability when API parameters changed

func (StartAsrTaskRequest) GetRegionId added in v1.56.0 

func (r StartAsrTaskRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*StartAsrTaskRequest) SetAppId added in v1.56.0 

func (r *StartAsrTaskRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*StartAsrTaskRequest) SetAsrTaskType added in v1.56.0 

func (r *StartAsrTaskRequest) SetAsrTaskType(asrTaskType int)

param asrTaskType: 语音识别场景 0-全部识别转文字(Optional)

func (*StartAsrTaskRequest) SetUserRoomId added in v1.56.0 

func (r *StartAsrTaskRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type StartAsrTaskResponse added in v1.56.0 

type StartAsrTaskResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    StartAsrTaskResult `json:"result"`
}

type StartAsrTaskResult added in v1.56.0 

type StartAsrTaskResult struct {
}

type StartMcuTranscodeRequest added in v1.56.0 

type StartMcuTranscodeRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 布局模板-支持参数1 (Optional) */
	LayoutTemplate *int `json:"layoutTemplate"`

	/* 主人员userId (Optional) */
	MainUserId *string `json:"mainUserId"`

	/* 输出类型 1：录制 2：旁路转推 (Optional) */
	OutputType *int `json:"outputType"`

	/* 输出名称 (Optional) */
	OutputName *string `json:"outputName"`

	/* 参与混流人员参数 (Optional) */
	McuUserInfos []openjrtc.McuUser `json:"mcuUserInfos"`

	/* 输出格式 (Optional) */
	OutputEncode *openjrtc.OutputEncode `json:"outputEncode"`
}

func NewStartMcuTranscodeRequest added in v1.56.0 

func NewStartMcuTranscodeRequest() *StartMcuTranscodeRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewStartMcuTranscodeRequestWithAllParams added in v1.56.0 

func NewStartMcuTranscodeRequestWithAllParams(
	appId *string,
	userRoomId *string,
	layoutTemplate *int,
	mainUserId *string,
	outputType *int,
	outputName *string,
	mcuUserInfos []openjrtc.McuUser,
	outputEncode *openjrtc.OutputEncode,
) *StartMcuTranscodeRequest

* param appId: 应用ID (Optional) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) * param layoutTemplate: 布局模板-支持参数1 (Optional) * param mainUserId: 主人员userId (Optional) * param outputType: 输出类型 1：录制 2：旁路转推 (Optional) * param outputName: 输出名称 (Optional) * param mcuUserInfos: 参与混流人员参数 (Optional) * param outputEncode: 输出格式 (Optional)

func NewStartMcuTranscodeRequestWithoutParam added in v1.56.0 

func NewStartMcuTranscodeRequestWithoutParam() *StartMcuTranscodeRequest

This constructor has better compatible ability when API parameters changed

func (StartMcuTranscodeRequest) GetRegionId added in v1.56.0 

func (r StartMcuTranscodeRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*StartMcuTranscodeRequest) SetAppId added in v1.56.0 

func (r *StartMcuTranscodeRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*StartMcuTranscodeRequest) SetLayoutTemplate added in v1.56.0 

func (r *StartMcuTranscodeRequest) SetLayoutTemplate(layoutTemplate int)

param layoutTemplate: 布局模板-支持参数1(Optional)

func (*StartMcuTranscodeRequest) SetMainUserId added in v1.56.0 

func (r *StartMcuTranscodeRequest) SetMainUserId(mainUserId string)

param mainUserId: 主人员userId(Optional)

func (*StartMcuTranscodeRequest) SetMcuUserInfos added in v1.56.0 

func (r *StartMcuTranscodeRequest) SetMcuUserInfos(mcuUserInfos []openjrtc.McuUser)

param mcuUserInfos: 参与混流人员参数(Optional)

func (*StartMcuTranscodeRequest) SetOutputEncode added in v1.56.0 

func (r *StartMcuTranscodeRequest) SetOutputEncode(outputEncode *openjrtc.OutputEncode)

param outputEncode: 输出格式(Optional)

func (*StartMcuTranscodeRequest) SetOutputName added in v1.56.0 

func (r *StartMcuTranscodeRequest) SetOutputName(outputName string)

param outputName: 输出名称(Optional)

func (*StartMcuTranscodeRequest) SetOutputType added in v1.56.0 

func (r *StartMcuTranscodeRequest) SetOutputType(outputType int)

param outputType: 输出类型 1：录制 2：旁路转推(Optional)

func (*StartMcuTranscodeRequest) SetUserRoomId added in v1.56.0 

func (r *StartMcuTranscodeRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type StartMcuTranscodeResponse added in v1.56.0 

type StartMcuTranscodeResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    StartMcuTranscodeResult `json:"result"`
}

type StartMcuTranscodeResult added in v1.56.0 

type StartMcuTranscodeResult struct {
}

type StopAsrTaskRequest added in v1.56.0 

type StopAsrTaskRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 语音识别场景 0-全部识别转文字 (Optional) */
	AsrTaskType *int `json:"asrTaskType"`
}

func NewStopAsrTaskRequest added in v1.56.0 

func NewStopAsrTaskRequest() *StopAsrTaskRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewStopAsrTaskRequestWithAllParams added in v1.56.0 

func NewStopAsrTaskRequestWithAllParams(
	appId *string,
	userRoomId *string,
	asrTaskType *int,
) *StopAsrTaskRequest

* param appId: 应用ID (Optional) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) * param asrTaskType: 语音识别场景 0-全部识别转文字 (Optional)

func NewStopAsrTaskRequestWithoutParam added in v1.56.0 

func NewStopAsrTaskRequestWithoutParam() *StopAsrTaskRequest

This constructor has better compatible ability when API parameters changed

func (StopAsrTaskRequest) GetRegionId added in v1.56.0 

func (r StopAsrTaskRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*StopAsrTaskRequest) SetAppId added in v1.56.0 

func (r *StopAsrTaskRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*StopAsrTaskRequest) SetAsrTaskType added in v1.56.0 

func (r *StopAsrTaskRequest) SetAsrTaskType(asrTaskType int)

param asrTaskType: 语音识别场景 0-全部识别转文字(Optional)

func (*StopAsrTaskRequest) SetUserRoomId added in v1.56.0 

func (r *StopAsrTaskRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type StopAsrTaskResponse added in v1.56.0 

type StopAsrTaskResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    StopAsrTaskResult  `json:"result"`
}

type StopAsrTaskResult added in v1.56.0 

type StopAsrTaskResult struct {
}

type StopMcuTranscodeRequest added in v1.56.0 

type StopMcuTranscodeRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`
}

func NewStopMcuTranscodeRequest added in v1.56.0 

func NewStopMcuTranscodeRequest() *StopMcuTranscodeRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewStopMcuTranscodeRequestWithAllParams added in v1.56.0 

func NewStopMcuTranscodeRequestWithAllParams(
	appId *string,
	userRoomId *string,
) *StopMcuTranscodeRequest

* param appId: 应用ID (Optional) * param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号 (Optional)

func NewStopMcuTranscodeRequestWithoutParam added in v1.56.0 

func NewStopMcuTranscodeRequestWithoutParam() *StopMcuTranscodeRequest

This constructor has better compatible ability when API parameters changed

func (StopMcuTranscodeRequest) GetRegionId added in v1.56.0 

func (r StopMcuTranscodeRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*StopMcuTranscodeRequest) SetAppId added in v1.56.0 

func (r *StopMcuTranscodeRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*StopMcuTranscodeRequest) SetUserRoomId added in v1.56.0 

func (r *StopMcuTranscodeRequest) SetUserRoomId(userRoomId string)

param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号(Optional)

type StopMcuTranscodeResponse added in v1.56.0 

type StopMcuTranscodeResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    StopMcuTranscodeResult `json:"result"`
}

type StopMcuTranscodeResult added in v1.56.0 

type StopMcuTranscodeResult struct {
}

type UpdateRoomRequest added in v1.52.0 

type UpdateRoomRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 房间ID (Optional) */
	RoomId *int64 `json:"roomId"`

	/* 房间名称 (Optional) */
	RoomName *string `json:"roomName"`
}

func NewUpdateRoomRequest added in v1.52.0 

func NewUpdateRoomRequest(
	appId string,
) *UpdateRoomRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateRoomRequestWithAllParams added in v1.52.0 

func NewUpdateRoomRequestWithAllParams(
	appId string,
	roomId *int64,
	roomName *string,
) *UpdateRoomRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Optional) * param roomName: 房间名称 (Optional)

func NewUpdateRoomRequestWithoutParam added in v1.52.0 

func NewUpdateRoomRequestWithoutParam() *UpdateRoomRequest

This constructor has better compatible ability when API parameters changed

func (UpdateRoomRequest) GetRegionId added in v1.52.0 

func (r UpdateRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UpdateRoomRequest) SetAppId added in v1.52.0 

func (r *UpdateRoomRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*UpdateRoomRequest) SetRoomId added in v1.52.0 

func (r *UpdateRoomRequest) SetRoomId(roomId int64)

param roomId: 房间ID(Optional)

func (*UpdateRoomRequest) SetRoomName added in v1.52.0 

func (r *UpdateRoomRequest) SetRoomName(roomName string)

param roomName: 房间名称(Optional)

type UpdateRoomResponse added in v1.52.0 

type UpdateRoomResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    UpdateRoomResult   `json:"result"`
}

type UpdateRoomResult added in v1.52.0 

type UpdateRoomResult struct {
	RoomId     int64  `json:"roomId"`
	RoomName   string `json:"roomName"`
	RoomType   int    `json:"roomType"`
	AppId      string `json:"appId"`
	PeerId     int64  `json:"peerId"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

type UpdateUserRoomRequest added in v1.56.0 

type UpdateUserRoomRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`

	/* 用户房间号 (Optional) */
	UserRoomId *string `json:"userRoomId"`

	/* 房间名称 (Optional) */
	RoomName *string `json:"roomName"`

	/* 房间类型 1-小房间；2-大房间 (Optional) */
	RoomType *int `json:"roomType"`
}

func NewUpdateUserRoomRequest added in v1.56.0 

func NewUpdateUserRoomRequest(
	appId string,
) *UpdateUserRoomRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateUserRoomRequestWithAllParams added in v1.56.0 

func NewUpdateUserRoomRequestWithAllParams(
	appId string,
	userRoomId *string,
	roomName *string,
	roomType *int,
) *UpdateUserRoomRequest

* param appId: 应用ID (Required) * param userRoomId: 用户房间号 (Optional) * param roomName: 房间名称 (Optional) * param roomType: 房间类型 1-小房间；2-大房间 (Optional)

func NewUpdateUserRoomRequestWithoutParam added in v1.56.0 

func NewUpdateUserRoomRequestWithoutParam() *UpdateUserRoomRequest

This constructor has better compatible ability when API parameters changed

func (UpdateUserRoomRequest) GetRegionId added in v1.56.0 

func (r UpdateUserRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UpdateUserRoomRequest) SetAppId added in v1.56.0 

func (r *UpdateUserRoomRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*UpdateUserRoomRequest) SetRoomName added in v1.56.0 

func (r *UpdateUserRoomRequest) SetRoomName(roomName string)

param roomName: 房间名称(Optional)

func (*UpdateUserRoomRequest) SetRoomType added in v1.56.0 

func (r *UpdateUserRoomRequest) SetRoomType(roomType int)

param roomType: 房间类型 1-小房间；2-大房间(Optional)

func (*UpdateUserRoomRequest) SetUserRoomId added in v1.56.0 

func (r *UpdateUserRoomRequest) SetUserRoomId(userRoomId string)

param userRoomId: 用户房间号(Optional)

type UpdateUserRoomResponse added in v1.56.0 

type UpdateUserRoomResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    UpdateUserRoomResult `json:"result"`
}

type UpdateUserRoomResult added in v1.56.0 

type UpdateUserRoomResult struct {
	RoomId     int64  `json:"roomId"`
	UserRoomId string `json:"userRoomId"`
	RoomName   string `json:"roomName"`
	RoomType   int    `json:"roomType"`
	AppId      string `json:"appId"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.