tencentcloud-sdk-nodejs 4.1.113 → 4.1.114

package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts

@@ -370,6 +370,19 @@ export interface DisableCCCPhoneNumberResponse {
      */
     RequestId?: string;
 }
+/**
+ * 筛选条件
+ */
+export interface Filter {
+    /**
+     * 筛选字段名
+     */
+    Name: string;
+    /**
+     * 筛选条件值
+     */
+    Values: Array<string>;
+}
 /**
  * DescribeProtectedTelCdr返回参数结构体
  */
@@ -811,6 +824,23 @@ export interface PausePredictiveDialingCampaignRequest {
      */
     CampaignId: number;
 }
+/**
+ * 呼转配置
+ */
+export interface ForwardingConfig {
+    /**
+     * 是否启用
+     */
+    Enabled?: boolean;
+    /**
+     * 1 无条件呼转 2 有条件呼转
+     */
+    Condition?: number;
+    /**
+     * 呼转目标
+     */
+    Target?: ForwardingTarget;
+}
 /**
  * DescribeAILatency请求参数结构体
  */
@@ -1030,6 +1060,107 @@ export interface DescribeChatMessagesResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeSessionDetail返回参数结构体
+ */
+export interface DescribeSessionDetailResponse {
+    /**
+     * 主叫号码
+     */
+    Caller?: string;
+    /**
+     * 被叫号码
+     */
+    Callee?: string;
+    /**
+     * 通话类型 1 呼出 2 呼入 3 音频呼入 5 预测式外呼 6 内线呼叫
+     */
+    CallType?: number;
+    /**
+     * 开始时间戳，Unix 秒级时间戳
+     */
+    StartTimeStamp?: number;
+    /**
+     * 振铃时间戳，UNIX 秒级时间戳
+     */
+    RingTimestamp?: number;
+    /**
+     * 接听时间戳，UNIX 秒级时间戳
+     */
+    AcceptTimestamp?: number;
+    /**
+     * 结束时间戳，UNIX 秒级时间戳
+     */
+    EndedTimestamp?: number;
+    /**
+     * 进入排队时间，Unix 秒级时间戳
+     */
+    QueuedTimestamp?: number;
+    /**
+     * 座席账号
+     */
+    StaffUserId?: string;
+    /**
+     * 参考 DescribeTelCdr 接口 EndStatus 字段
+     */
+    EndStatus?: number;
+    /**
+     * 排队技能组 ID
+     */
+    QueuedSkillGroupId?: number;
+    /**
+     * 排队技能组名称
+     */
+    QueuedSkillGroupName?: string;
+    /**
+     * 录音链接，带鉴权和有效期，获取之后请在短时间内拉取，不要持久化此链接
+     */
+    RecordURL?: string;
+    /**
+     * 录音转存第三方 COS 链接
+     */
+    CustomRecordURL?: string;
+    /**
+     * 录音文本信息链接，带鉴权和有效期，获取之后请在短时间内拉取，不要持久化此链接
+     */
+    AsrURL?: string;
+    /**
+     * 语音留言录音链接
+     */
+    VoicemailRecordURL?: Array<string>;
+    /**
+     * 语音留言录音文本信息链接，需在控制台购买离线语音识别套餐包并开启离线语音识别开关
+     */
+    VoicemailAsrURL?: Array<string>;
+    /**
+     * IVR 按键信息
+     */
+    IVRKeyPressed?: Array<IVRKeyPressedElement>;
+    /**
+     * 满意度按键信息
+     */
+    PostIVRKeyPressed?: Array<IVRKeyPressedElement>;
+    /**
+     * 挂机方 seat 座席 user 用户 system 系统
+     */
+    HungUpSide?: string;
+    /**
+     * 客户自定义数据（User-to-User Interface）
+     */
+    UUI?: string;
+    /**
+     * 通话中的事件列表
+     */
+    Events?: Array<SessionEvent>;
+    /**
+     * 服务参与者列表
+     */
+    ServeParticipants?: Array<ServeParticipant>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 参与者信息
  */
@@ -1966,6 +2097,23 @@ export interface DescribeIMCdrsRequest {
      */
     Type?: number;
 }
+/**
+ * 通话事件
+ */
+export interface SessionEvent {
+    /**
+     * 事件时间戳，Unix 秒级时间戳
+     */
+    Timestamp?: number;
+    /**
+     * 事件类型，目前支持 StaffHold StaffUnhold StaffMute StaffUnmute
+     */
+    EventType?: string;
+    /**
+     * 座席相关事件详情
+     */
+    StaffEventDetail?: EventStaffDetail;
+}
 /**
  * DescribeSkillGroupInfoList请求参数结构体
  */
@@ -2499,6 +2647,23 @@ export interface SkillGroupInfoItem {
      */
     RingAll?: boolean;
 }
+/**
+ * UploadIvrAudio返回参数结构体
+ */
+export interface UploadIvrAudioResponse {
+    /**
+     * 上传失败的文件列表
+     */
+    FailedFileList?: Array<UploadIvrAudioFailedInfo>;
+    /**
+     * 上传成功文件列表
+     */
+    SuccessFileList?: Array<AudioFileInfo>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateAIAgentCall请求参数结构体
  */
@@ -2585,21 +2750,17 @@ export interface TimeRange {
     EndTime?: string;
 }
 /**
- * 呼转配置
+ * DescribeStaffStatusHistory返回参数结构体
  */
-export interface ForwardingConfig {
-    /**
-     * 是否启用
-     */
-    Enabled?: boolean;
+export interface DescribeStaffStatusHistoryResponse {
     /**
-     * 1 无条件呼转 2 有条件呼转
+     * 座席状态数据
      */
-    Condition?: number;
+    Data?: Array<StaffStatus>;
     /**
-     * 呼转目标
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
-    Target?: ForwardingTarget;
+    RequestId?: string;
 }
 /**
  * DescribeTelCdr请求参数结构体
@@ -3035,21 +3196,25 @@ export interface UploadIvrAudioFailedInfo {
     FailedMsg?: string;
 }
 /**
- * UploadIvrAudio返回参数结构体
+ * DescribeSessionDetail请求参数结构体
  */
-export interface UploadIvrAudioResponse {
+export interface DescribeSessionDetailRequest {
     /**
-     * 上传失败的文件列表
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
      */
-    FailedFileList?: Array<UploadIvrAudioFailedInfo>;
+    SdkAppId: number;
     /**
-     * 上传成功文件列表
+     * 通话的 session id
      */
-    SuccessFileList?: Array<AudioFileInfo>;
+    SessionId: string;
     /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     * 起始时间戳，Unix 秒级时间戳，最大支持近180天。
      */
-    RequestId?: string;
+    StartTimestamp: number;
+    /**
+     * 结束时间戳，Unix 秒级时间戳，结束时间与开始时间的区间范围小于90天。
+     */
+    EndTimestamp: number;
 }
 /**
  * ModifyExtension返回参数结构体
@@ -3455,17 +3620,17 @@ export interface AITransferItem {
     TransferSkillGroupId: number;
 }
 /**
- * 筛选条件
+ * 座席信息
  */
-export interface Filter {
+export interface EventStaffElement {
     /**
-     * 筛选字段名
+     * 座席邮箱账号
      */
-    Name: string;
+    Mail?: string;
     /**
-     * 筛选条件值
+     * 座席工号
      */
-    Values: Array<string>;
+    StaffNumber?: string;
 }
 /**
  * AbortAgentCruiseDialingCampaign请求参数结构体
@@ -4392,6 +4557,35 @@ export interface StaffStatusExtra {
      */
     Direct?: string;
 }
+/**
+ * DescribeStaffStatusHistory请求参数结构体
+ */
+export interface DescribeStaffStatusHistoryRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 座席账号
+     */
+    StaffUserId: string;
+    /**
+     * 起始时间戳，Unix 秒级时间戳，最大支持近180天。
+     */
+    StartTimestamp: number;
+    /**
+     * 结束时间戳，Unix 秒级时间戳，结束时间与开始时间的区间范围小于 7 天。
+     */
+    EndTimestamp: number;
+    /**
+     * 分页检索时使用的游标
+     */
+    Cursor?: string;
+    /**
+     * 分页尺寸
+     */
+    PageSize?: number;
+}
 /**
  * CreateStaff请求参数结构体
  */
@@ -4468,6 +4662,15 @@ export interface DescribePSTNActiveSessionListResponse {
      */
     RequestId?: string;
 }
+/**
+ * 座席事件相关详情
+ */
+export interface EventStaffDetail {
+    /**
+     * 座席数据
+     */
+    Staffs?: Array<EventStaffElement>;
+}
 /**
  * AI时延统计
  */
@@ -4489,6 +4692,27 @@ export interface AILatencyStatistics {
      */
     ETELatency?: AILatencyStatisticsInfo;
 }
+/**
+ * 座席状态
+ */
+export interface StaffStatus {
+    /**
+     * 查询使用的游标，分页场景使用
+     */
+    Cursor?: string;
+    /**
+     * 状态时间戳，Unix 秒级时间戳
+     */
+    Timestamp?: number;
+    /**
+     * 座席状态 free 示闲 | busy 忙碌 | rest 小休 | notReady 示忙 | afterCallWork 话后调整 | offline 离线
+     */
+    Status?: string;
+    /**
+     * 状态关联的会话 Id
+     */
+    SessionId?: string;
+}
 /**
  * DescribeIMCdrList请求参数结构体
  */

package/tencentcloud/services/cdwpg/v20201230/cdwpg_models.d.ts

@@ -1061,6 +1061,14 @@ export interface DescribeSlowLogRequest {
      * 过滤时间
      */
     Duration?: number;
+    /**
+     * 执行用户
+     */
+    UserName?: string;
+    /**
+     * query 语句
+     */
+    QueryString?: string;
 }
 /**
  * DescribeUpgradeList返回参数结构体

package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts

@@ -1224,7 +1224,7 @@ export interface FailureParam {
  */
 export interface CreateTopicRequest {
     /**
-     * 实例Id
+     * 实例Id，可通过DescribeInstances接口获取。
      */
     InstanceId: string;
     /**
@@ -1252,27 +1252,27 @@ export interface CreateTopicRequest {
      */
     CleanUpPolicy?: string;
     /**
-     * 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
+     * 主题备注，是一个不超过 64 个字符的字符串，可以用字母和数字为首字符，剩余部分可以包含字母、数字和横划线(-)
      */
     Note?: string;
     /**
-     * 默认为1
+     * 最小同步副本数，默认为1
      */
     MinInsyncReplicas?: number;
     /**
-     * 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许
+     * 是否允许未同步的副本选为leader，0:不允许，1:允许，默认不允许
      */
     UncleanLeaderElectionEnable?: number;
     /**
-     * 可选参数。消息保留时间，单位ms，当前最小值为60000ms
+     * 可选参数。消息保留时间，单位ms，当前最小值为60000。默认值为7200000ms（2小时），最大值为7776000000 ms（90天）。
      */
     RetentionMs?: number;
     /**
-     * Segment分片滚动的时长，单位ms，当前最小为3600000ms
+     * Segment分片滚动的时长，单位ms，最小值为86400000ms（1天）。
      */
     SegmentMs?: number;
     /**
-     * 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为12582912Byte（即12MB）
+     * 主题消息最大值，单位为 Byte，最小值1024Bytes(即1KB)，最大值为12582912Bytes（即12MB）
      */
     MaxMessageBytes?: number;
     /**
@@ -1284,7 +1284,7 @@ export interface CreateTopicRequest {
      */
     AclRuleName?: string;
     /**
-     * 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
+     * 可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。
      */
     RetentionBytes?: number;
     /**
@@ -2303,7 +2303,7 @@ export interface SplitParam {
  */
 export interface DescribeTopicDetailRequest {
     /**
-     * ckafka集群实例Id
+     * ckafka集群实例Id，可通过DescribeInstances接口获取。
      */
     InstanceId: string;
     /**
@@ -2315,7 +2315,7 @@ export interface DescribeTopicDetailRequest {
      */
     Offset?: number;
     /**
-     * 返回数量，不填则默认 10，最大值20，取值要大于0
+     * 返回数量，不填则默认 20，取值要大于0
      */
     Limit?: number;
     /**
@@ -2323,11 +2323,11 @@ export interface DescribeTopicDetailRequest {
      */
     AclRuleName?: string;
     /**
-     * 根据特定的属性排序(目前支持PartitionNum/CreateTime)
+     * 根据特定的属性排序(目前支持PartitionNum/CreateTime)，默认值为CreateTime。
      */
     OrderBy?: string;
     /**
-     * 0-顺序、1-倒序
+     * 0-顺序、1-倒序，默认值为0。
      */
     OrderType?: number;
     /**
@@ -4732,11 +4732,11 @@ export interface BatchModifyTopicResultDTO {
  */
 export interface DescribeTopicAttributesRequest {
     /**
-     * ckafka集群实例Id
+     * ckafka集群实例Id，可通过DescribeInstances接口获取。
      */
     InstanceId: string;
     /**
-     * 主题名称
+     * 主题名称，可通过DescribeTopic接口获取。
      */
     TopicName: string;
 }
@@ -5366,11 +5366,11 @@ export interface DeleteInstancePostRequest {
  */
 export interface DescribeTopicProduceConnectionRequest {
     /**
-     * ckafka集群实例Id
+     * ckafka集群实例Id，可通过DescribeInstances接口获取。
      */
     InstanceId: string;
     /**
-     * 主题名
+     * 主题名，可通过DescribeTopic接口获取。
      */
     TopicName: string;
 }
@@ -5568,11 +5568,11 @@ export interface UserResponse {
  */
 export interface DescribeGroupInfoRequest {
     /**
-     * ckafka集群实例Id
+     * ckafka集群实例Id,可通过DescribeInstances接口获取
      */
     InstanceId: string;
     /**
-     * Kafka 消费分组列表
+     * Kafka 消费分组列表,可通过DescribeConsumerGroup接口获取
      */
     GroupList: Array<string>;
 }
@@ -5915,7 +5915,7 @@ export interface TopicAttributesResponse {
      */
     TopicId?: string;
     /**
-     * 创建时间
+     * 创建时间的秒级时间戳
      */
     CreateTime?: number;
     /**
@@ -6375,7 +6375,7 @@ export interface ModifyTopicAttributesRequest {
      */
     MaxMessageBytes?: number;
     /**
-     * Segment 分片滚动的时长，单位：ms，当前最小为300000ms。
+     * Segment 分片滚动的时长，单位：ms，当前最小值86400000ms。
      */
     SegmentMs?: number;
     /**
@@ -6428,7 +6428,7 @@ export interface CreateInstancePreRequest {
      */
     ZoneId: number;
     /**
-     * 预付费购买时长，例如 "1m",就是一个月
+     * 预付费购买时长，例如 "1m",就是一个月,取值范围 1m~36m
      */
     Period: string;
     /**
@@ -6669,7 +6669,7 @@ export interface DescribeConnectResourcesRequest {
      */
     Type?: string;
     /**
-     * 连接源名称的关键字查询
+     * 连接源名称的关键字查询,支持模糊匹配
      */
     SearchWord?: string;
     /**
@@ -6677,7 +6677,7 @@ export interface DescribeConnectResourcesRequest {
      */
     Offset?: number;
     /**
-     * 返回数量，默认为20，最大值为100
+     * 返回数量，默认为20，最大值为1000 (超过1000,则限制为1000)
      */
     Limit?: number;
     /**
@@ -6716,7 +6716,7 @@ export interface InstanceDeleteResponse {
  */
 export interface DescribeInstanceAttributesRequest {
     /**
-     * ckafka集群实例Id
+     * ckafka集群实例Id,可通过DescribeInstances接口获取
      */
     InstanceId: string;
 }
@@ -6818,7 +6818,11 @@ export interface CreateRouteRequest {
      */
     SubnetId?: string;
     /**
-     * 访问类型：0-plaintext；1-sasl_plaintext；2-ssl；3-sasl_ssl,默认为0
+     * 访问类型：0-plaintext；1-sasl_plaintext；3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512  默认为0
+  vipType=3,支持 0,1,3,4,5
+  vipType=7,支持0,1,3
+  vipType=1,支持1,3
+  
      */
     AccessType?: number;
     /**
@@ -7198,7 +7202,7 @@ export interface CheckCdcClusterResponse {
  */
 export interface DescribeDatahubTasksRequest {
     /**
-     * 返回数量，默认为20，最大值为100
+     * 返回数量，默认为20，最大值为100 (超过100限制为100)
      */
     Limit?: number;
     /**
@@ -7231,7 +7235,7 @@ export interface DescribeDatahubTasksRequest {
  */
 export interface DescribeTopicFlowRankingRequest {
     /**
-     * ckafka集群实例Id
+     * ckafka集群实例Id，可通过DescribeInstances接口获取。
      */
     InstanceId: string;
     /**
@@ -7804,7 +7808,7 @@ export interface DescribeDatahubTopicRequest {
  */
 export interface Config {
     /**
-     * 消息保留时间
+     * 消息保留时间，单位ms。
      */
     Retention?: number;
     /**
@@ -7819,7 +7823,7 @@ export interface Config {
      */
     CleanUpPolicy?: string;
     /**
-     * Segment 分片滚动的时长
+     * Segment 分片滚动的时长，单位ms。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     SegmentMs?: number;
@@ -7829,22 +7833,22 @@ export interface Config {
      */
     UncleanLeaderElectionEnable?: number;
     /**
-     * Segment 分片滚动的字节数
+     * Segment 分片滚动的字节数，单位bytes
   注意：此字段可能返回 null，表示取不到有效值。
      */
     SegmentBytes?: number;
     /**
-     * 最大消息字节数
+     * 最大消息字节数，单位bytes
   注意：此字段可能返回 null，表示取不到有效值。
      */
     MaxMessageBytes?: number;
     /**
-     * 消息保留文件大小
+     * 消息保留文件大小，单位Bytes
   注意：此字段可能返回 null，表示取不到有效值。
      */
     RetentionBytes?: number;
     /**
-     * 消息保存的时间类型
+     * 消息保存的时间类型，CreateTime表示生产者创建这条消息的时间;LogAppendTime表示broker接收到消息的时间。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     LogMsgTimestampType?: string;
@@ -7897,23 +7901,23 @@ export interface ModifyTopicAttributesResponse {
  */
 export interface DescribeConsumerGroupRequest {
     /**
-     * ckafka集群实例Id
+     * ckafka集群实例Id,通过DescribeInstances接口获取
      */
     InstanceId: string;
     /**
-     * 可选，用户需要查询的group名称。
+     * 用户需要查询的group名称。
      */
     GroupName?: string;
     /**
-     * 可选，用户需要查询的group中的对应的topic名称，如果指定了该参数，而group又未指定则忽略该参数。
+     * 用户需要查询的group中的对应的topic名称，如果指定了该参数，而group又未指定则忽略该参数。
      */
     TopicName?: string;
     /**
-     * 本次返回个数限制，最大支持50
+     * 返回消费组的限制数量，最大支持50
      */
     Limit?: number;
     /**
-     * 偏移位置
+     * 消费组列表的起始偏移量
      */
     Offset?: number;
 }
@@ -8008,7 +8012,7 @@ export interface ModifyRoutineMaintenanceTaskResponse {
  */
 export interface DescribeConnectResourceResponse {
     /**
-     * 连接源的Id
+     * 连接源数据信息
      */
     Result?: DescribeConnectResourceResp;
     /**
@@ -8276,19 +8280,19 @@ export interface InquiryPrice {
  */
 export interface ModifyGroupOffsetsRequest {
     /**
-     * ckafka集群实例Id
+     * ckafka集群实例Id,可通过DescribeInstances接口获取
      */
     InstanceId: string;
     /**
-     * 消费分组名称
+     * 消费分组名称,可通过DescribeConsumerGroup接口获取
      */
     Group: string;
     /**
-     * 重置offset的策略，入参含义 0. 对齐shift-by参数，代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset)，代表把offset移动到指定的offset位置
+     * 重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
      */
     Strategy: number;
     /**
-     * 需要重置的主题名列表， 不填表示全部
+     * 需要重置的主题名列表
      */
     Topics?: Array<string>;
     /**
@@ -8296,7 +8300,7 @@ export interface ModifyGroupOffsetsRequest {
      */
     Shift?: number;
     /**
-     * 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。
+     * 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的是，如果指定的时间不存在消息，则获取最末尾的offset。
      */
     ShiftTimestamp?: number;
     /**
@@ -8535,7 +8539,7 @@ export interface DescribeTopicSyncReplicaRequest {
      */
     Offset?: number;
     /**
-     * 返回数量，不填则默认10，最大值20。
+     * 返回数量，默认值为20，必须大于0。
      */
     Limit?: number;
     /**