tencentcloud-sdk-nodejs-trtc 4.0.474 → 4.0.476

package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { CreatePictureRequest, DescribeRelayUsageRequest, RemoveUserByStrRoomIdResponse, StartMCUMixTranscodeRequest, DescribeUserEventRequest, StartMCUMixTranscodeByStrRoomIdRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeUserInfoRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeMixTranscodingUsageRequest, ModifyPictureRequest, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, DescribeUserInfoResponse, DescribeRelayUsageResponse, DescribeRecordingUsageResponse, ModifyPictureResponse, DescribeRecordingUsageRequest, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, RemoveUserRequest, DismissRoomRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, StopMCUMixTranscodeRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, DeletePictureResponse, ModifyCloudRecordingRequest, CreateCloudRecordingResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribeExternalTrtcMeasureResponse, DescribePictureResponse, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, DescribeCloudRecordingResponse, DismissRoomResponse, DeletePictureRequest, DescribeExternalTrtcMeasureRequest, RemoveUserByStrRoomIdRequest, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
+import { CreatePictureRequest, DescribeRelayUsageRequest, DescribeTRTCMarketQualityMetricDataResponse, RemoveUserByStrRoomIdResponse, StartMCUMixTranscodeRequest, DescribeUserEventRequest, StartMCUMixTranscodeByStrRoomIdRequest, DescribeTRTCRealTimeScaleMetricDataRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeUserInfoRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DescribeTrtcUsageResponse, DismissRoomByStrRoomIdRequest, DescribeTRTCMarketQualityMetricDataRequest, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeMixTranscodingUsageRequest, ModifyPictureRequest, DescribeTrtcUsageRequest, DescribeRoomInfoResponse, DescribeTRTCRealTimeQualityMetricDataRequest, DescribeUserInfoResponse, DescribeTRTCRealTimeScaleMetricDataResponse, DescribeTRTCMarketScaleMetricDataRequest, DescribeRelayUsageResponse, DescribeRecordingUsageResponse, ModifyPictureResponse, DescribeRecordingUsageRequest, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, DescribeMixTranscodingUsageResponse, RemoveUserRequest, DismissRoomRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, StopMCUMixTranscodeRequest, DescribeTRTCRealTimeQualityMetricDataResponse, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, DeletePictureResponse, ModifyCloudRecordingRequest, CreateCloudRecordingResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribeExternalTrtcMeasureResponse, DescribePictureResponse, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, DescribeCloudRecordingResponse, DismissRoomResponse, DeletePictureRequest, DescribeExternalTrtcMeasureRequest, RemoveUserByStrRoomIdRequest, DescribeTRTCMarketScaleMetricDataResponse, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
 /**
  * trtc client
  * @class
@@ -22,6 +22,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   - 默认接口请求频率限制：5次/秒。
        */
     DescribeTrtcUsage(req: DescribeTrtcUsageRequest, cb?: (error: string, rep: DescribeTrtcUsageResponse) => void): Promise<DescribeTrtcUsageResponse>;
+    /**
+       * 查询TRTC监控仪表盘-数据大盘质量指标（包括下列指标）
+  joinSuccessRate：加入频道成功率。
+  joinSuccessIn5sRate：5s内加入频道成功率。
+  audioFreezeRate：音频卡顿率。
+  videoFreezeRate：视频卡顿率。
+  networkDelay ：网络延迟率。
+  注意：
+  1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
+  2、查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
+       */
+    DescribeTRTCMarketQualityMetricData(req: DescribeTRTCMarketQualityMetricDataRequest, cb?: (error: string, rep: DescribeTRTCMarketQualityMetricDataResponse) => void): Promise<DescribeTRTCMarketQualityMetricDataResponse>;
     /**
        * 查询指定时间内的用户列表及用户通话质量数据，可查询14天内数据。DataType 不为null，查询起止时间不超过1个小时，查询用户不超过6个，支持跨天查询。DataType为null时，查询起止时间不超过4个小时， 默认查询6个用户，同时支持每页查询100以内用户个数（PageSize不超过100）。接口用于查询质量问题，不推荐作为计费使用。（同老接口DescribeCallDetail）
   **注意**：
@@ -33,6 +45,17 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 接口说明：结束云端混流
      */
     StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
+    /**
+       * 查询TRTC监控仪表盘-数据大盘规模指标（会返回通话人数，通话房间数，峰值同时在线人数，峰值同时在线频道数）
+  userCount：通话人数，
+  roomCount：通话房间数，从有用户加入频道到所有用户离开频道计为一个通话频道。
+  peakCurrentChannels：峰值同时在线频道数。
+  peakCurrentUsers：峰值同时在线人数。
+  注意：
+  1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
+  2、查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
+       */
+    DescribeTRTCMarketScaleMetricData(req: DescribeTRTCMarketScaleMetricDataRequest, cb?: (error: string, rep: DescribeTRTCMarketScaleMetricDataResponse) => void): Promise<DescribeTRTCMarketScaleMetricDataResponse>;
     /**
        * 接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。
   
@@ -61,6 +84,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印，可通过此接口删除已上传的图片。无需频繁删除图片的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
      */
     DeletePicture(req: DeletePictureRequest, cb?: (error: string, rep: DeletePictureResponse) => void): Promise<DeletePictureResponse>;
+    /**
+       * 查询TRTC监控仪表盘-实时监控质量指标（会返回下列指标）
+  -视频卡顿率
+  -音频卡顿率
+  注意：
+  1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
+  2、查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时。
+       */
+    DescribeTRTCRealTimeQualityMetricData(req: DescribeTRTCRealTimeQualityMetricDataRequest, cb?: (error: string, rep: DescribeTRTCRealTimeQualityMetricDataResponse) => void): Promise<DescribeTRTCRealTimeQualityMetricDataResponse>;
     /**
      * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印，可通过此接口上传新的图片素材。无需频繁新增图片的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
      */
@@ -214,4 +246,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   异常体验ID映射见：https://cloud.tencent.com/document/product/647/44916
        */
     DescribeUnusualEvent(req: DescribeUnusualEventRequest, cb?: (error: string, rep: DescribeUnusualEventResponse) => void): Promise<DescribeUnusualEventResponse>;
+    /**
+       * 查询TRTC监控仪表盘-实时监控规模指标（会返回下列指标）
+  -userCount（在线用户数）
+  -roomCount（在线房间数）
+  注意：
+  1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
+  2、查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时。
+       */
+    DescribeTRTCRealTimeScaleMetricData(req: DescribeTRTCRealTimeScaleMetricDataRequest, cb?: (error: string, rep: DescribeTRTCRealTimeScaleMetricDataResponse) => void): Promise<DescribeTRTCRealTimeScaleMetricDataResponse>;
 }

package/tencentcloud/services/trtc/v20190722/trtc_client.js

@@ -47,6 +47,20 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeTrtcUsage(req, cb) {
         return this.request("DescribeTrtcUsage", req, cb);
     }
+    /**
+       * 查询TRTC监控仪表盘-数据大盘质量指标（包括下列指标）
+  joinSuccessRate：加入频道成功率。
+  joinSuccessIn5sRate：5s内加入频道成功率。
+  audioFreezeRate：音频卡顿率。
+  videoFreezeRate：视频卡顿率。
+  networkDelay ：网络延迟率。
+  注意：
+  1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
+  2、查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
+       */
+    async DescribeTRTCMarketQualityMetricData(req, cb) {
+        return this.request("DescribeTRTCMarketQualityMetricData", req, cb);
+    }
     /**
        * 查询指定时间内的用户列表及用户通话质量数据，可查询14天内数据。DataType 不为null，查询起止时间不超过1个小时，查询用户不超过6个，支持跨天查询。DataType为null时，查询起止时间不超过4个小时， 默认查询6个用户，同时支持每页查询100以内用户个数（PageSize不超过100）。接口用于查询质量问题，不推荐作为计费使用。（同老接口DescribeCallDetail）
   **注意**：
@@ -62,6 +76,19 @@ class Client extends TencentCloudCommon.AbstractClient {
     async StopMCUMixTranscode(req, cb) {
         return this.request("StopMCUMixTranscode", req, cb);
     }
+    /**
+       * 查询TRTC监控仪表盘-数据大盘规模指标（会返回通话人数，通话房间数，峰值同时在线人数，峰值同时在线频道数）
+  userCount：通话人数，
+  roomCount：通话房间数，从有用户加入频道到所有用户离开频道计为一个通话频道。
+  peakCurrentChannels：峰值同时在线频道数。
+  peakCurrentUsers：峰值同时在线人数。
+  注意：
+  1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
+  2、查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天。
+       */
+    async DescribeTRTCMarketScaleMetricData(req, cb) {
+        return this.request("DescribeTRTCMarketScaleMetricData", req, cb);
+    }
     /**
        * 接口说明：启动云端混流，并指定混流画面中各路画面的布局位置。
   
@@ -94,6 +121,17 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DeletePicture(req, cb) {
         return this.request("DeletePicture", req, cb);
     }
+    /**
+       * 查询TRTC监控仪表盘-实时监控质量指标（会返回下列指标）
+  -视频卡顿率
+  -音频卡顿率
+  注意：
+  1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
+  2、查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时。
+       */
+    async DescribeTRTCRealTimeQualityMetricData(req, cb) {
+        return this.request("DescribeTRTCRealTimeQualityMetricData", req, cb);
+    }
     /**
      * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印，可通过此接口上传新的图片素材。无需频繁新增图片的场景，建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
      */
@@ -293,5 +331,16 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeUnusualEvent(req, cb) {
         return this.request("DescribeUnusualEvent", req, cb);
     }
+    /**
+       * 查询TRTC监控仪表盘-实时监控规模指标（会返回下列指标）
+  -userCount（在线用户数）
+  -roomCount（在线房间数）
+  注意：
+  1.调用接口需开通监控仪表盘【基础版】和【进阶版】，监控仪表盘【免费版】不支持调用，监控仪表盘版本功能和计费说明：https://cloud.tencent.com/document/product/647/81331。
+  2、查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时。
+       */
+    async DescribeTRTCRealTimeScaleMetricData(req, cb) {
+        return this.request("DescribeTRTCRealTimeScaleMetricData", req, cb);
+    }
 }
 exports.Client = Client;

package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts

@@ -49,6 +49,20 @@ export interface DescribeRelayUsageRequest {
      */
     SdkAppId?: number;
 }
+/**
+ * DescribeTRTCMarketQualityMetricData返回参数结构体
+ */
+export interface DescribeTRTCMarketQualityMetricDataResponse {
+    /**
+        * TRTC监控数据出参
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Data: TRTCDataResp;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 用户自定义混流布局参数列表。
  */
@@ -224,6 +238,27 @@ export interface ScaleInfomation {
         */
     RoomNumbers: number;
 }
+/**
+ * DescribeTRTCRealTimeScaleMetricData请求参数结构体
+ */
+export interface DescribeTRTCRealTimeScaleMetricDataRequest {
+    /**
+     * 用户SdkAppId（如：1400xxxxxx）
+     */
+    SdkAppId: string;
+    /**
+     * 开始时间，unix时间戳，单位：秒（查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时）
+     */
+    StartTime: number;
+    /**
+     * 结束时间，unix时间戳，单位：秒
+     */
+    EndTime: number;
+    /**
+     * 房间ID
+     */
+    RoomId?: string;
+}
 /**
  * DescribeUserEvent返回参数结构体
  */
@@ -506,6 +541,29 @@ export interface DismissRoomByStrRoomIdRequest {
      */
     RoomId: string;
 }
+/**
+ * DescribeTRTCMarketQualityMetricData请求参数结构体
+ */
+export interface DescribeTRTCMarketQualityMetricDataRequest {
+    /**
+     * 用户SdkAppId（如：1400xxxxxx）
+     */
+    SdkAppId: string;
+    /**
+     * 查询开始时间，格式为YYYY-MM-DD。（查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天）
+     */
+    StartTime: string;
+    /**
+     * 查询结束时间，格式为YYYY-MM-DD。
+     */
+    EndTime: string;
+    /**
+        * 返回数据的粒度，支持设为以下值：
+  d：按天。此时返回查询时间范围内 UTC 时间为零点的数据。
+  h：按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
+        */
+    Period: string;
+}
 /**
  * 事件信息，包括，事件时间戳，事件ID,
  */
@@ -906,6 +964,27 @@ export interface DescribeRoomInfoResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeTRTCRealTimeQualityMetricData请求参数结构体
+ */
+export interface DescribeTRTCRealTimeQualityMetricDataRequest {
+    /**
+     * 用户SdkAppId（如：1400xxxxxx）
+     */
+    SdkAppId: string;
+    /**
+     * 开始时间，unix时间戳，单位：秒（查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时）
+     */
+    StartTime: number;
+    /**
+     * 结束时间，unix时间戳，单位：秒
+     */
+    EndTime: number;
+    /**
+     * 房间ID
+     */
+    RoomId?: string;
+}
 /**
  * 查询旁路转码计费时长。
 查询时间小于等于1天时，返回每5分钟粒度的数据；查询时间大于1天时，返回按天汇总的数据。
@@ -954,6 +1033,20 @@ export interface DescribeUserInfoResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeTRTCRealTimeScaleMetricData返回参数结构体
+ */
+export interface DescribeTRTCRealTimeScaleMetricDataResponse {
+    /**
+        * TRTC监控数据出参
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Data: TRTCDataResp;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 实时音视频用量在某一时间段的统计信息。
  */
@@ -967,6 +1060,29 @@ export interface TrtcUsage {
      */
     UsageValue: Array<number>;
 }
+/**
+ * DescribeTRTCMarketScaleMetricData请求参数结构体
+ */
+export interface DescribeTRTCMarketScaleMetricDataRequest {
+    /**
+     * 用户SdkAppId
+     */
+    SdkAppId: string;
+    /**
+     * 查询开始时间，格式为YYYY-MM-DD。（查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天）
+     */
+    StartTime: string;
+    /**
+     * 查询结束时间，格式为YYYY-MM-DD。
+     */
+    EndTime: string;
+    /**
+        * 返回数据的粒度，支持设为以下值：
+  d：按天。此时返回查询时间范围内 UTC 时间为零点的数据。
+  h：按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
+        */
+    Period: string;
+}
 /**
  * DescribeRelayUsage返回参数结构体
  */
@@ -1176,6 +1292,19 @@ export interface DescribeMixTranscodingUsageResponse {
      */
     RequestId?: string;
 }
+/**
+ * SdkAppId级别录制时长数据。
+ */
+export interface SdkAppIdRecordUsage {
+    /**
+     * SdkAppId的值。
+     */
+    SdkAppId: string;
+    /**
+     * 统计的时间点数据。
+     */
+    Usages: Array<RecordUsage>;
+}
 /**
  * SdkAppId级别实时音视频的用量数据
  */
@@ -1309,6 +1438,20 @@ export interface StopMCUMixTranscodeRequest {
      */
     RoomId: number;
 }
+/**
+ * DescribeTRTCRealTimeQualityMetricData返回参数结构体
+ */
+export interface DescribeTRTCRealTimeQualityMetricDataResponse {
+    /**
+        * TRTC监控数据出参
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Data: TRTCDataResp;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * MCU混流布局参数
  */
@@ -1641,6 +1784,26 @@ export interface DescribePictureRequest {
      */
     PageNo?: number;
 }
+/**
+ * TRTC数据大盘/实时监控 API接口数据出参
+ */
+export interface TRTCDataResp {
+    /**
+        * StatementID值
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    StatementID: number;
+    /**
+        * Series数据
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Series: Array<SeriesInfo>;
+    /**
+        * Total值
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Total: number;
+}
 /**
  * DescribeExternalTrtcMeasure返回参数结构体
  */
@@ -1923,17 +2086,18 @@ export interface RecordParams {
     AvMerge?: number;
 }
 /**
- * SdkAppId级别录制时长数据。
+ * DescribeTRTCMarketScaleMetricData返回参数结构体
  */
-export interface SdkAppIdRecordUsage {
+export interface DescribeTRTCMarketScaleMetricDataResponse {
     /**
-     * SdkAppId的值。
-     */
-    SdkAppId: string;
+        * TRTC监控数据出参
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Data: TRTCDataResp;
     /**
-     * 统计的时间点数据。
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
-    Usages: Array<RecordUsage>;
+    RequestId?: string;
 }
 /**
  * 自定义模板中有效，指定用户视频在混合画面中的位置。
@@ -2002,6 +2166,21 @@ export interface AudioParams {
      */
     BitRate: number;
 }
+/**
+ * SeriesInfo类型
+ */
+export interface SeriesInfo {
+    /**
+        * 数据列
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Columns: Array<string>;
+    /**
+        * 数据值
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Values: Array<number>;
+}
 /**
  * 第三方CDN转推参数
  */