tencentcloud-sdk-nodejs 4.0.801 → 4.0.802

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

@@ -95,6 +95,15 @@ export interface ModifyStaffRequest {
      */
     UseMobileAccept?: number;
 }
+/**
+ * BindNumberCallOutSkillGroup返回参数结构体
+ */
+export interface BindNumberCallOutSkillGroupResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ResetExtensionPassword请求参数结构体
  */
@@ -201,6 +210,19 @@ export interface CreateAdminURLResponse {
      */
     RequestId?: string;
 }
+/**
+ * PausePredictiveDialingCampaign请求参数结构体
+ */
+export interface PausePredictiveDialingCampaignRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 任务 ID
+     */
+    CampaignId: number;
+}
 /**
  * CreateCallOutSession返回参数结构体
  */
@@ -252,6 +274,63 @@ export interface DisableCCCPhoneNumberRequest {
      */
     SdkAppId?: number;
 }
+/**
+ * CreatePredictiveDialingCampaign请求参数结构体
+ */
+export interface CreatePredictiveDialingCampaignRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 任务名称
+     */
+    Name: string;
+    /**
+     * 被叫列表，支持 E.164 或不带国家码形式的号码
+     */
+    Callees: Array<string>;
+    /**
+     * 主叫列表，使用管理端展示的号码格式
+     */
+    Callers: Array<string>;
+    /**
+     * 被叫呼叫顺序 0 随机 1 顺序
+     */
+    CallOrder: number;
+    /**
+     * 使用的座席技能组 ID
+     */
+    SkillGroupId: number;
+    /**
+     * 相同应用内多个任务运行优先级，从高到底 1 - 5
+     */
+    Priority: number;
+    /**
+     * 预期呼损率，百分比，5 - 50
+     */
+    ExpectedAbandonRate: number;
+    /**
+     * 呼叫重试间隔时间，单位秒，60 - 86400
+     */
+    RetryInterval: number;
+    /**
+     * 任务启动时间，Unix 时间戳，到此时间后会自动启动任务
+     */
+    StartTime: number;
+    /**
+     * 任务结束时间，Unix 时间戳，到此时间后会自动终止任务
+     */
+    EndTime: number;
+    /**
+     * 指定的 IVR Id
+     */
+    IVRId?: number;
+    /**
+     * 呼叫重试次数，0 - 2
+     */
+    RetryTimes?: number;
+}
 /**
  * 参与者信息
  */
@@ -347,6 +426,44 @@ export interface ServeParticipant {
      */
     CustomRecordURL: string;
 }
+/**
+ * DescribeTelCallInfo返回参数结构体
+ */
+export interface DescribeTelCallInfoResponse {
+    /**
+     * 呼出套餐包消耗分钟数
+     */
+    TelCallOutCount?: number;
+    /**
+     * 呼入套餐包消耗分钟数
+     */
+    TelCallInCount?: number;
+    /**
+     * 坐席使用统计个数
+     */
+    SeatUsedCount?: number;
+    /**
+     * 音频套餐包消耗分钟数
+     * @deprecated
+     */
+    VoipCallInCount?: number;
+    /**
+     * 音频套餐包消耗分钟数
+     */
+    VOIPCallInCount?: number;
+    /**
+     * 离线语音转文字套餐包消耗分钟数
+     */
+    AsrOfflineCount?: number;
+    /**
+     * 实时语音转文字套餐包消耗分钟数
+     */
+    AsrRealtimeCount?: number;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeExtensions返回参数结构体
  */
@@ -378,38 +495,70 @@ export interface DeleteExtensionRequest {
     ExtensionId: string;
 }
 /**
- * DescribeTelCallInfo返回参数结构体
+ * 外呼任务被叫信息
  */
-export interface DescribeTelCallInfoResponse {
+export interface AutoCalloutTaskCalleeInfo {
     /**
-     * 呼出套餐包消耗分钟数
+     * 被叫号码
      */
-    TelCallOutCount?: number;
+    Callee: string;
     /**
-     * 呼入套餐包消耗分钟数
+     * 呼叫状态 0初始 1已接听 2未接听 3呼叫中 4待重试
      */
-    TelCallInCount?: number;
+    State: number;
     /**
-     * 坐席使用统计个数
+     * 会话ID列表
      */
-    SeatUsedCount?: number;
+    Sessions: Array<string>;
+}
+/**
+ * DescribePredictiveDialingCampaign返回参数结构体
+ */
+export interface DescribePredictiveDialingCampaignResponse {
     /**
-     * 音频套餐包消耗分钟数
-     * @deprecated
+     * 任务 ID
      */
-    VoipCallInCount?: number;
+    CampaignId?: number;
     /**
-     * 音频套餐包消耗分钟数
+     * 任务名称
      */
-    VOIPCallInCount?: number;
+    Name?: string;
     /**
-     * 离线语音转文字套餐包消耗分钟数
+     * 被叫呼叫顺序 0 随机 1 顺序
      */
-    AsrOfflineCount?: number;
+    CallOrder?: number;
     /**
-     * 实时语音转文字套餐包消耗分钟数
+     * 使用的座席技能组 ID
      */
-    AsrRealtimeCount?: number;
+    SkillGroupId?: number;
+    /**
+     * 指定的 IVR ID
+     */
+    IVRId?: number;
+    /**
+     * 相同应用内多个任务运行优先级，从高到底 1 - 5
+     */
+    Priority?: number;
+    /**
+     * 预期呼损率，百分比，5 - 50
+     */
+    ExpectedAbandonRate?: number;
+    /**
+     * 呼叫重试次数，0 - 2
+     */
+    RetryTimes?: number;
+    /**
+     * 呼叫重试间隔时间，单位秒，60 - 86400
+     */
+    RetryInterval?: number;
+    /**
+     * 任务启动时间，Unix 时间戳，到此时间后会自动启动任务
+     */
+    StartTime?: number;
+    /**
+     * 任务结束时间，Unix 时间戳，到此时间后会自动终止任务
+     */
+    EndTime?: number;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -619,6 +768,31 @@ export interface CreateStaffResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribePredictiveDialingCampaigns请求参数结构体
+ */
+export interface DescribePredictiveDialingCampaignsRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 分页尺寸，最大为 100
+     */
+    PageSize: number;
+    /**
+     * 分页页码，从 0 开始
+     */
+    PageNumber: number;
+    /**
+     * 查询任务列表名称关键字
+     */
+    Name?: string;
+    /**
+     * 查询任务列表技能组 ID
+     */
+    SkillGroupId?: number;
+}
 /**
  * DescribeSkillGroupInfoList返回参数结构体
  */
@@ -653,6 +827,19 @@ export interface DescribeNumbersResponse {
      */
     RequestId?: string;
 }
+/**
+ * DeletePredictiveDialingCampaign请求参数结构体
+ */
+export interface DeletePredictiveDialingCampaignRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 任务 ID
+     */
+    CampaignId: number;
+}
 /**
  * DescribeStaffInfoList返回参数结构体
  */
@@ -688,25 +875,66 @@ export interface UnbindNumberCallOutSkillGroupRequest {
     SkillGroupIds: Array<number | bigint>;
 }
 /**
- * CreateCarrierPrivilegeNumberApplicant请求参数结构体
+ * CreateAutoCalloutTask请求参数结构体
  */
-export interface CreateCarrierPrivilegeNumberApplicantRequest {
+export interface CreateAutoCalloutTaskRequest {
     /**
-     * SdkAppId
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
      */
     SdkAppId: number;
     /**
-     * 主叫号码，必须为实例中存在的号码，格式为0086xxxx（暂时只支持国内号码）
+     * 任务起始时间戳，Unix 秒级时间戳
      */
-    Callers: Array<string>;
+    NotBefore: number;
     /**
-     * 被叫号码，必须为实例中坐席绑定的手机号码，格式为0086xxxx（暂时只支持国内号码）
+     * 被叫号码列表
      */
     Callees: Array<string>;
     /**
-     * 描述
+     * 主叫号码列表
+     */
+    Callers: Array<string>;
+    /**
+     * 呼叫使用的Ivr
+     */
+    IvrId: number;
+    /**
+     * 任务名
+     */
+    Name?: string;
+    /**
+     * 任务描述
      */
     Description?: string;
+    /**
+     * 任务停止时间戳，Unix 秒级时间戳
+     */
+    NotAfter?: number;
+    /**
+     * 最大尝试次数
+     */
+    Tries?: number;
+    /**
+     * 自定义变量（仅高级版支持）
+     */
+    Variables?: Array<Variable>;
+    /**
+     * UUI
+     */
+    UUI?: string;
+    /**
+     * 被叫属性
+     */
+    CalleeAttributes?: Array<CalleeAttribute>;
+}
+/**
+ * ResumePredictiveDialingCampaign返回参数结构体
+ */
+export interface ResumePredictiveDialingCampaignResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
 }
 /**
  * 呼入技能组相关指标
@@ -922,21 +1150,17 @@ export interface CreateCarrierPrivilegeNumberApplicantResponse {
     RequestId?: string;
 }
 /**
- * 外呼任务被叫信息
+ * DescribePredictiveDialingCampaign请求参数结构体
  */
-export interface AutoCalloutTaskCalleeInfo {
-    /**
-     * 被叫号码
-     */
-    Callee: string;
+export interface DescribePredictiveDialingCampaignRequest {
     /**
-     * 呼叫状态 0初始 1已接听 2未接听 3呼叫中 4待重试
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
      */
-    State: number;
+    SdkAppId: number;
     /**
-     * 会话ID列表
+     * 任务 ID
      */
-    Sessions: Array<string>;
+    CampaignId: number;
 }
 /**
  * 坐席用户信息
@@ -981,6 +1205,23 @@ export interface SeatUserInfo {
      */
     Role?: number;
 }
+/**
+ * DescribePredictiveDialingSessions返回参数结构体
+ */
+export interface DescribePredictiveDialingSessionsResponse {
+    /**
+     * 数据总量
+     */
+    TotalCount?: number;
+    /**
+     * 呼叫的 session id 列表，通过 https://cloud.tencent.com/document/product/679/47714 可以批量获取呼叫详细话单
+     */
+    SessionList?: Array<string>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 运营商白名单号码申请单
  */
@@ -1036,6 +1277,15 @@ export interface ErrStaffItem {
      */
     Message: string;
 }
+/**
+ * PausePredictiveDialingCampaign返回参数结构体
+ */
+export interface PausePredictiveDialingCampaignResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * PSTN 会话类型。
  */
@@ -1105,6 +1355,67 @@ export interface PSTNSession {
      */
     ProtectedCallee: string;
 }
+/**
+ * UpdatePredictiveDialingCampaign请求参数结构体
+ */
+export interface UpdatePredictiveDialingCampaignRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 生成的任务 ID
+     */
+    CampaignId: number;
+    /**
+     * 任务名称
+     */
+    Name: string;
+    /**
+     * 被叫列表，支持 E.164 或不带国家码形式的号码
+     */
+    Callees: Array<string>;
+    /**
+     * 主叫列表，使用管理端展示的号码格式
+     */
+    Callers: Array<string>;
+    /**
+     * 被叫呼叫顺序 0 随机 1 顺序
+     */
+    CallOrder: number;
+    /**
+     * 使用的座席技能组 ID
+     */
+    SkillGroupId: number;
+    /**
+     * 相同应用内多个任务运行优先级，从高到底 1 - 5
+     */
+    Priority: number;
+    /**
+     * 预期呼损率，百分比，5 - 50
+     */
+    ExpectedAbandonRate: number;
+    /**
+     * 呼叫重试间隔时间，单位秒，60 - 86400
+     */
+    RetryInterval: number;
+    /**
+     * 任务启动时间，Unix 时间戳，到此时间后会自动启动任务
+     */
+    StartTime: number;
+    /**
+     * 任务结束时间，Unix 时间戳，到此时间后会自动终止任务
+     */
+    EndTime: number;
+    /**
+     * 指定的 IVR ID
+     */
+    IVRId?: number;
+    /**
+     * 呼叫重试次数，0 - 2
+     */
+    RetryTimes?: number;
+}
 /**
  * DescribeStaffInfoList请求参数结构体
  */
@@ -1261,6 +1572,28 @@ export interface ModifyExtensionRequest {
      */
     Relation?: string;
 }
+/**
+ * CreatePredictiveDialingCampaign返回参数结构体
+ */
+export interface CreatePredictiveDialingCampaignResponse {
+    /**
+     * 生成的任务 ID
+     */
+    CampaignId?: number;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * UpdatePredictiveDialingCampaign返回参数结构体
+ */
+export interface UpdatePredictiveDialingCampaignResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * PSTN 会话信息
  */
@@ -1331,6 +1664,15 @@ export interface Message {
      */
     Content: string;
 }
+/**
+ * AbortPredictiveDialingCampaign返回参数结构体
+ */
+export interface AbortPredictiveDialingCampaignResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeNumbers请求参数结构体
  */
@@ -1414,6 +1756,15 @@ export interface BindNumberCallOutSkillGroupRequest {
      */
     SkillGroupIds: Array<number | bigint>;
 }
+/**
+ * DeletePredictiveDialingCampaign返回参数结构体
+ */
+export interface DeletePredictiveDialingCampaignResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ivr 按键信息
  */
@@ -1844,6 +2195,25 @@ export interface DescribeCCCBuyInfoListRequest {
      */
     SdkAppIds?: Array<number | bigint>;
 }
+/**
+ * DescribePredictiveDialingCampaigns返回参数结构体
+ */
+export interface DescribePredictiveDialingCampaignsResponse {
+    /**
+     * 数据总量
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    TotalCount?: number;
+    /**
+     * 数据
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    CampaignList?: Array<DescribePredictiveDialingCampaignsElement>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeTelCallInfo请求参数结构体
  */
@@ -1930,57 +2300,25 @@ export interface StaffSkillGroupList {
     Priority?: number;
 }
 /**
- * CreateAutoCalloutTask请求参数结构体
+ * CreateCarrierPrivilegeNumberApplicant请求参数结构体
  */
-export interface CreateAutoCalloutTaskRequest {
+export interface CreateCarrierPrivilegeNumberApplicantRequest {
     /**
-     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     * SdkAppId
      */
     SdkAppId: number;
     /**
-     * 任务起始时间戳，Unix 秒级时间戳
-     */
-    NotBefore: number;
-    /**
-     * 被叫号码列表
-     */
-    Callees: Array<string>;
-    /**
-     * 主叫号码列表
+     * 主叫号码，必须为实例中存在的号码，格式为0086xxxx（暂时只支持国内号码）
      */
     Callers: Array<string>;
     /**
-     * 呼叫使用的Ivr
-     */
-    IvrId: number;
-    /**
-     * 任务名
+     * 被叫号码，必须为实例中坐席绑定的手机号码，格式为0086xxxx（暂时只支持国内号码）
      */
-    Name?: string;
+    Callees: Array<string>;
     /**
-     * 任务描述
+     * 描述
      */
     Description?: string;
-    /**
-     * 任务停止时间戳，Unix 秒级时间戳
-     */
-    NotAfter?: number;
-    /**
-     * 最大尝试次数
-     */
-    Tries?: number;
-    /**
-     * 自定义变量（仅高级版支持）
-     */
-    Variables?: Array<Variable>;
-    /**
-     * UUI
-     */
-    UUI?: string;
-    /**
-     * 被叫属性
-     */
-    CalleeAttributes?: Array<CalleeAttribute>;
 }
 /**
  * 筛选条件
@@ -2013,51 +2351,58 @@ export interface UnbindStaffSkillGroupListRequest {
     SkillGroupList: Array<number | bigint>;
 }
 /**
- * BindNumberCallOutSkillGroup返回参数结构体
+ * 查询预测式外呼任务列表元素
  */
-export interface BindNumberCallOutSkillGroupResponse {
+export interface DescribePredictiveDialingCampaignsElement {
     /**
-     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     * 任务 ID
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    RequestId?: string;
-}
-/**
- * CreateCallOutSession请求参数结构体
- */
-export interface CreateCallOutSessionRequest {
+    CampaignId?: number;
     /**
-     * 应用 ID
+     * 任务名称
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    SdkAppId: number;
+    Name?: string;
     /**
-     * 客服用户 ID，一般为客服邮箱
+     * 任务状态 0 待开始 1 进行中 2 已暂停 3 已终止 4 已完成
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    UserId: string;
+    Status?: number;
     /**
-     * 被叫号码，须带 0086 前缀
+     * 任务状态原因 0 正常 1 手动结束 2 超时结束
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Callee: string;
+    StatusReason?: number;
     /**
-     * 主叫号码（废弃，使用Callers），须带 0086 前缀
+     * 被叫号码个数
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Caller?: string;
+    CalleeCount?: number;
     /**
-     * 指定主叫号码列表，如果前面的号码失败了会自动换成下一个号码，须带 0086 前缀
+     * 已完成的被叫个数
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Callers?: Array<string>;
+    FinishedCalleeCount?: number;
     /**
-     * 是否强制使用手机外呼，当前只支持 true，若为 true 请确保已配置白名单
+     * 相同应用内多个任务运行优先级，从高到底 1 - 5
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    IsForceUseMobile?: boolean;
+    Priority?: number;
     /**
-     * 自定义数据，长度限制 1024 字节
-     * @deprecated
+     * 使用的座席技能组 ID
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Uui?: string;
+    SkillGroupId?: number;
+}
+/**
+ * HangUpCall返回参数结构体
+ */
+export interface HangUpCallResponse {
     /**
-     * 自定义数据，长度限制 1024 字节
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
-    UUI?: string;
+    RequestId?: string;
 }
 /**
  * StopAutoCalloutTask返回参数结构体
@@ -2068,6 +2413,19 @@ export interface StopAutoCalloutTaskResponse {
      */
     RequestId?: string;
 }
+/**
+ * AbortPredictiveDialingCampaign请求参数结构体
+ */
+export interface AbortPredictiveDialingCampaignRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 任务 ID
+     */
+    CampaignId: number;
+}
 /**
  * 技能组信息
  */
@@ -2186,6 +2544,19 @@ export interface UnbindStaffSkillGroupListResponse {
      */
     RequestId?: string;
 }
+/**
+ * ResumePredictiveDialingCampaign请求参数结构体
+ */
+export interface ResumePredictiveDialingCampaignRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 任务 ID
+     */
+    CampaignId: number;
+}
 /**
  * DeleteExtension返回参数结构体
  */
@@ -2664,13 +3035,42 @@ export interface DescribeCarrierPrivilegeNumberApplicantsResponse {
     RequestId?: string;
 }
 /**
- * HangUpCall返回参数结构体
+ * CreateCallOutSession请求参数结构体
  */
-export interface HangUpCallResponse {
+export interface CreateCallOutSessionRequest {
     /**
-     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     * 应用 ID
      */
-    RequestId?: string;
+    SdkAppId: number;
+    /**
+     * 客服用户 ID，一般为客服邮箱
+     */
+    UserId: string;
+    /**
+     * 被叫号码，须带 0086 前缀
+     */
+    Callee: string;
+    /**
+     * 主叫号码（废弃，使用Callers），须带 0086 前缀
+     */
+    Caller?: string;
+    /**
+     * 指定主叫号码列表，如果前面的号码失败了会自动换成下一个号码，须带 0086 前缀
+     */
+    Callers?: Array<string>;
+    /**
+     * 是否强制使用手机外呼，当前只支持 true，若为 true 请确保已配置白名单
+     */
+    IsForceUseMobile?: boolean;
+    /**
+     * 自定义数据，长度限制 1024 字节
+     * @deprecated
+     */
+    Uui?: string;
+    /**
+     * 自定义数据，长度限制 1024 字节
+     */
+    UUI?: string;
 }
 /**
  * BindStaffSkillGroupList返回参数结构体
@@ -2735,6 +3135,27 @@ export interface DescribeProtectedTelCdrRequest {
      */
     PageNumber: number;
 }
+/**
+ * DescribePredictiveDialingSessions请求参数结构体
+ */
+export interface DescribePredictiveDialingSessionsRequest {
+    /**
+     * 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc
+     */
+    SdkAppId: number;
+    /**
+     * 生成的任务 ID
+     */
+    CampaignId: number;
+    /**
+     * 分页尺寸，最大为 1000
+     */
+    PageSize: number;
+    /**
+     * 分页页码，从 0 开始
+     */
+    PageNumber: number;
+}
 /**
  * CreateSDKLoginToken请求参数结构体
  */