v20190722

package
v3.0.1666+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source 
const APIVersion = "2019-07-22"

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	common.Client
}

func NewClient 

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

func NewClientWithSecretId 

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

Deprecated

func (*Client) DescribeCallDetail 

func (c *Client) DescribeCallDetail(request *DescribeCallDetailRequest) (response *DescribeCallDetailResponse, err error)

查询指定时间内的用户列表及用户通话质量数据。

func (*Client) DescribeHistoryScale 

func (c *Client) DescribeHistoryScale(request *DescribeHistoryScaleRequest) (response *DescribeHistoryScaleResponse, err error)

查询历史房间和用户数，每分钟1次，可查询最近5天的数据

func (*Client) DescribeRealtimeNetwork 

func (c *Client) DescribeRealtimeNetwork(request *DescribeRealtimeNetworkRequest) (response *DescribeRealtimeNetworkResponse, err error)

查询sdkappid维度下实时网络状态，包括上行丢包与下行丢包。可查询24小时内数据，查询起止时间不超过1个小时。

func (*Client) DescribeRealtimeQuality 

func (c *Client) DescribeRealtimeQuality(request *DescribeRealtimeQualityRequest) (response *DescribeRealtimeQualityResponse, err error)

查询sdkappid维度下实时质量数据，包括：进房成功率，首帧秒开率，音频卡顿率，视频卡顿率。可查询24小时内数据，查询起止时间不超过1个小时。

func (*Client) DescribeRealtimeScale 

func (c *Client) DescribeRealtimeScale(request *DescribeRealtimeScaleRequest) (response *DescribeRealtimeScaleResponse, err error)

查询sdkappid维度下实时规模，可查询24小时内数据，查询起止时间不超过1个小时。

func (*Client) DescribeRoomInformation 

func (c *Client) DescribeRoomInformation(request *DescribeRoomInformationRequest) (response *DescribeRoomInformationResponse, err error)

查询sdkappid下的房间列表。默认返回10条通话，一次最多返回100条通话。可查询最近5天的数据。

func (*Client) DismissRoom 

func (c *Client) DismissRoom(request *DismissRoomRequest) (response *DismissRoomResponse, err error)

接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

func (*Client) RemoveUser 

func (c *Client) RemoveUser(request *RemoveUserRequest) (response *RemoveUserResponse, err error)

接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

type DescribeCallDetailRequest 

type DescribeCallDetailRequest struct {
	*tchttp.BaseRequest

	// 通话ID
	CommId *string `json:"CommId,omitempty" name:"CommId"`

	// 查询开始时间
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 用户sdkappid
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 需查询的用户数组，不填默认返回6个用户
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds" list`

	// 需查询的指标，不填则只返回用户列表，填all则返回所有指标。
	// appCpu：APP CPU使用率；
	// sysCpu：系统 CPU使用率；
	// aBit：上/下行音频码率；
	// aBlock：音频卡顿时长；
	// vBit：上/下行视频码率；
	// vCapFps：视频采集帧率；
	// vEncFps：视频发送帧率；
	// vDecFps：渲染帧率；
	// vBlock：视频卡顿时长；
	// aLoss：上/下行音频丢包；
	// vLoss：上/下行视频丢包；
	// vWidth：上/下行分辨率宽；
	// vHeight：上/下行分辨率高
	DataType []*string `json:"DataType,omitempty" name:"DataType" list`
}

func NewDescribeCallDetailRequest 

func NewDescribeCallDetailRequest() (request *DescribeCallDetailRequest)

func (*DescribeCallDetailRequest) FromJsonString 

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

func (*DescribeCallDetailRequest) ToJsonString 

func (r *DescribeCallDetailRequest) ToJsonString() string

type DescribeCallDetailResponse 

type DescribeCallDetailResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的用户总条数
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// 用户信息列表
		// 注意：此字段可能返回 null，表示取不到有效值。
		UserList []*UserInformation `json:"UserList,omitempty" name:"UserList" list`

		// 质量数据
		// 注意：此字段可能返回 null，表示取不到有效值。
		Data []*QualityData `json:"Data,omitempty" name:"Data" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeCallDetailResponse 

func NewDescribeCallDetailResponse() (response *DescribeCallDetailResponse)

func (*DescribeCallDetailResponse) FromJsonString 

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

func (*DescribeCallDetailResponse) ToJsonString 

func (r *DescribeCallDetailResponse) ToJsonString() string

type DescribeHistoryScaleRequest 

type DescribeHistoryScaleRequest struct {
	*tchttp.BaseRequest

	// 用户sdkappid
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 查询开始时间
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
}

func NewDescribeHistoryScaleRequest 

func NewDescribeHistoryScaleRequest() (request *DescribeHistoryScaleRequest)

func (*DescribeHistoryScaleRequest) FromJsonString 

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

func (*DescribeHistoryScaleRequest) ToJsonString 

func (r *DescribeHistoryScaleRequest) ToJsonString() string

type DescribeHistoryScaleResponse 

type DescribeHistoryScaleResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的数据条数
		Total *uint64 `json:"Total,omitempty" name:"Total"`

		// 返回的数据
		// 注意：此字段可能返回 null，表示取不到有效值。
		ScaleList []*ScaleInfomation `json:"ScaleList,omitempty" name:"ScaleList" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeHistoryScaleResponse 

func NewDescribeHistoryScaleResponse() (response *DescribeHistoryScaleResponse)

func (*DescribeHistoryScaleResponse) FromJsonString 

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

func (*DescribeHistoryScaleResponse) ToJsonString 

func (r *DescribeHistoryScaleResponse) ToJsonString() string

type DescribeRealtimeNetworkRequest 

type DescribeRealtimeNetworkRequest struct {
	*tchttp.BaseRequest

	// 查询开始时间
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 用户sdkappid
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 需查询的数据类型
	// sendLossRateRaw：上行丢包率；
	// recvLossRateRaw：下行丢包率
	DataType []*string `json:"DataType,omitempty" name:"DataType" list`
}

func NewDescribeRealtimeNetworkRequest 

func NewDescribeRealtimeNetworkRequest() (request *DescribeRealtimeNetworkRequest)

func (*DescribeRealtimeNetworkRequest) FromJsonString 

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

func (*DescribeRealtimeNetworkRequest) ToJsonString 

func (r *DescribeRealtimeNetworkRequest) ToJsonString() string

type DescribeRealtimeNetworkResponse 

type DescribeRealtimeNetworkResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 查询返回的数据
		Data []*RealtimeData `json:"Data,omitempty" name:"Data" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRealtimeNetworkResponse 

func NewDescribeRealtimeNetworkResponse() (response *DescribeRealtimeNetworkResponse)

func (*DescribeRealtimeNetworkResponse) FromJsonString 

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

func (*DescribeRealtimeNetworkResponse) ToJsonString 

func (r *DescribeRealtimeNetworkResponse) ToJsonString() string

type DescribeRealtimeQualityRequest 

type DescribeRealtimeQualityRequest struct {
	*tchttp.BaseRequest

	// 查询开始时间
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 用户sdkappid
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 查询的数据类型
	// enterTotalSuccPercent：进房成功率
	// fistFreamInSecRate：首帧秒开率
	// blockPercent：视频卡顿率
	// audioBlockPercent：音频卡顿率
	DataType []*string `json:"DataType,omitempty" name:"DataType" list`
}

func NewDescribeRealtimeQualityRequest 

func NewDescribeRealtimeQualityRequest() (request *DescribeRealtimeQualityRequest)

func (*DescribeRealtimeQualityRequest) FromJsonString 

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

func (*DescribeRealtimeQualityRequest) ToJsonString 

func (r *DescribeRealtimeQualityRequest) ToJsonString() string

type DescribeRealtimeQualityResponse 

type DescribeRealtimeQualityResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的数据类型
		Data []*RealtimeData `json:"Data,omitempty" name:"Data" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRealtimeQualityResponse 

func NewDescribeRealtimeQualityResponse() (response *DescribeRealtimeQualityResponse)

func (*DescribeRealtimeQualityResponse) FromJsonString 

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

func (*DescribeRealtimeQualityResponse) ToJsonString 

func (r *DescribeRealtimeQualityResponse) ToJsonString() string

type DescribeRealtimeScaleRequest 

type DescribeRealtimeScaleRequest struct {
	*tchttp.BaseRequest

	// 查询开始时间
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 用户sdkappid
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 查询的数据类型
	// UserNum：通话人数；
	// RoomNum：房间数
	DataType []*string `json:"DataType,omitempty" name:"DataType" list`
}

func NewDescribeRealtimeScaleRequest 

func NewDescribeRealtimeScaleRequest() (request *DescribeRealtimeScaleRequest)

func (*DescribeRealtimeScaleRequest) FromJsonString 

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

func (*DescribeRealtimeScaleRequest) ToJsonString 

func (r *DescribeRealtimeScaleRequest) ToJsonString() string

type DescribeRealtimeScaleResponse 

type DescribeRealtimeScaleResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的数据数组
		Data []*RealtimeData `json:"Data,omitempty" name:"Data" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRealtimeScaleResponse 

func NewDescribeRealtimeScaleResponse() (response *DescribeRealtimeScaleResponse)

func (*DescribeRealtimeScaleResponse) FromJsonString 

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

func (*DescribeRealtimeScaleResponse) ToJsonString 

func (r *DescribeRealtimeScaleResponse) ToJsonString() string

type DescribeRoomInformationRequest 

type DescribeRoomInformationRequest struct {
	*tchttp.BaseRequest

	// 用户sdkappid
	SdkAppId *string `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 查询开始时间
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`

	// 数字房间号
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// 分页index（不填默认只返回10个）
	PageNumber *string `json:"PageNumber,omitempty" name:"PageNumber"`

	// 分页大小（不填默认返回10个,最多不超过100条）
	PageSize *string `json:"PageSize,omitempty" name:"PageSize"`
}

func NewDescribeRoomInformationRequest 

func NewDescribeRoomInformationRequest() (request *DescribeRoomInformationRequest)

func (*DescribeRoomInformationRequest) FromJsonString 

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

func (*DescribeRoomInformationRequest) ToJsonString 

func (r *DescribeRoomInformationRequest) ToJsonString() string

type DescribeRoomInformationResponse 

type DescribeRoomInformationResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的数据总条数
		Total *int64 `json:"Total,omitempty" name:"Total"`

		// 房间信息列表
		RoomList []*RoomState `json:"RoomList,omitempty" name:"RoomList" list`

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRoomInformationResponse 

func NewDescribeRoomInformationResponse() (response *DescribeRoomInformationResponse)

func (*DescribeRoomInformationResponse) FromJsonString 

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

func (*DescribeRoomInformationResponse) ToJsonString 

func (r *DescribeRoomInformationResponse) ToJsonString() string

type DismissRoomRequest 

type DismissRoomRequest struct {
	*tchttp.BaseRequest

	// TRTC的SDKAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

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

func NewDismissRoomRequest 

func NewDismissRoomRequest() (request *DismissRoomRequest)

func (*DismissRoomRequest) FromJsonString 

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

func (*DismissRoomRequest) ToJsonString 

func (r *DismissRoomRequest) ToJsonString() string

type DismissRoomResponse 

type DismissRoomResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDismissRoomResponse 

func NewDismissRoomResponse() (response *DismissRoomResponse)

func (*DismissRoomResponse) FromJsonString 

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

func (*DismissRoomResponse) ToJsonString 

func (r *DismissRoomResponse) ToJsonString() string

type QualityData 

type QualityData struct {

	// 数据内容
	Content []*TimeValue `json:"Content,omitempty" name:"Content" list`

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

	// 对端Id,为空时表示上行数据
	// 注意：此字段可能返回 null，表示取不到有效值。
	PeerId *string `json:"PeerId,omitempty" name:"PeerId"`

	// 数据类型
	DataType *string `json:"DataType,omitempty" name:"DataType"`
}

type RealtimeData 

type RealtimeData struct {

	// 返回的数据
	// 注意：此字段可能返回 null，表示取不到有效值。
	Content []*TimeValue `json:"Content,omitempty" name:"Content" list`

	// 数据类型字段
	DataType *string `json:"DataType,omitempty" name:"DataType"`
}

type RemoveUserRequest 

type RemoveUserRequest struct {
	*tchttp.BaseRequest

	// TRTC的SDKAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

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

	// 要移出的用户列表，最多10个。
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds" list`
}

func NewRemoveUserRequest 

func NewRemoveUserRequest() (request *RemoveUserRequest)

func (*RemoveUserRequest) FromJsonString 

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

func (*RemoveUserRequest) ToJsonString 

func (r *RemoveUserRequest) ToJsonString() string

type RemoveUserResponse 

type RemoveUserResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewRemoveUserResponse 

func NewRemoveUserResponse() (response *RemoveUserResponse)

func (*RemoveUserResponse) FromJsonString 

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

func (*RemoveUserResponse) ToJsonString 

func (r *RemoveUserResponse) ToJsonString() string

type RoomState 

type RoomState struct {

	// 通话ID（唯一标识一次通话）
	CommId *string `json:"CommId,omitempty" name:"CommId"`

	// 房间号
	RoomString *string `json:"RoomString,omitempty" name:"RoomString"`

	// 房间创建时间
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// 房间销毁时间
	DestroyTime *uint64 `json:"DestroyTime,omitempty" name:"DestroyTime"`

	// 房间是否已经结束
	IsFinished *bool `json:"IsFinished,omitempty" name:"IsFinished"`

	// 房间创建者Id
	UserId *string `json:"UserId,omitempty" name:"UserId"`
}

type ScaleInfomation 

type ScaleInfomation struct {

	// 每天开始的时间
	Time *uint64 `json:"Time,omitempty" name:"Time"`

	// 房间人数
	// 注意：此字段可能返回 null，表示取不到有效值。
	UserNumber *uint64 `json:"UserNumber,omitempty" name:"UserNumber"`

	// 房间人次
	// 注意：此字段可能返回 null，表示取不到有效值。
	UserCount *uint64 `json:"UserCount,omitempty" name:"UserCount"`

	// 房间数
	// 注意：此字段可能返回 null，表示取不到有效值。
	RoomNumbers *uint64 `json:"RoomNumbers,omitempty" name:"RoomNumbers"`
}

type TimeValue 

type TimeValue struct {

	// 时间
	Time *uint64 `json:"Time,omitempty" name:"Time"`

	// 当前时间取值
	Value *float64 `json:"Value,omitempty" name:"Value"`
}

type UserInformation 

type UserInformation struct {

	// 房间号
	RoomStr *string `json:"RoomStr,omitempty" name:"RoomStr"`

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

	// 用户进房时间
	JoinTs *uint64 `json:"JoinTs,omitempty" name:"JoinTs"`

	// 用户退房时间
	LeaveTs *uint64 `json:"LeaveTs,omitempty" name:"LeaveTs"`

	// 终端类型
	DeviceType *string `json:"DeviceType,omitempty" name:"DeviceType"`

	// Sdk版本号
	SdkVersion *string `json:"SdkVersion,omitempty" name:"SdkVersion"`

	// 客户端IP地址
	ClientIp *string `json:"ClientIp,omitempty" name:"ClientIp"`
}

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.