/** * DescribeExtension请求参数结构体 */ export interface DescribeExtensionRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分机号 */ ExtensionId: string; } /** * CreateCCCSkillGroup返回参数结构体 */ export interface CreateCCCSkillGroupResponse { /** * 技能组ID */ SkillGroupId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 本轮对话在画布中经过的节点路径 */ export interface AIRoundPath { /** *

画布中的节点名称

*/ NodeName?: string; /** *

画布中的节点类型

枚举值:

*/ NodeType?: string; /** *

经过当前节点的时间戳

单位:ms

*/ Timestamp?: number; /** *

接口调用节点的调用详情,包含请求、响应、耗时以及每次重试的明细。仅 NodeType 为 API_CALL 时有值,其余节点类型不返回该字段。

注意:此字段可能返回 null,表示取不到有效值。 */ APICall?: AICallAPICallDetail; } /** * StopAutoCalloutTask请求参数结构体 */ export interface StopAutoCalloutTaskRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务Id */ TaskId: number; } /** * CreateIVRSession请求参数结构体 */ export interface CreateIVRSessionRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 被叫 */ Callee: string; /** * 指定的 IVR Id,目前支持呼入和自动外呼两种类型 */ IVRId: number; /** * 主叫号码列表 */ Callers?: Array; /** * 自定义变量 */ Variables?: Array; /** * 用户数据 */ UUI?: string; /** * 最大振铃时长,达到时长阈值自动挂断。 仅自携号码支持当前参数 */ MaxRingTimeoutSecond?: number; } /** * 企业资质申请信息 */ export interface CompanyApplyInfo { /** * 申请人身份,0-公司法定代表人,1-经办人(受法定代表人委托) */ ApplicantType: number; /** * 企业名称 */ CompanyName: string; /** * 统一社会信用代码 */ BusinessId: string; /** * 营业执照扫描件(加盖公章)。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ BusinessIdPicUrl: string; /** * 法定代表人名称 */ CorporationName: string; /** * 法定代表人身份证号码 */ CorporationId: string; /** * 法定代表人身份证正反面扫描件。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ CorporationIdPicUrl: string; /** * 安全合规使用承诺书。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ NetworkCommitmentPicUrl: string; /** * 是否与腾讯云账号的资质一致,0-不一致,1-一致 */ IsEqualTencentCloud: number; /** * 法定代表人手机号 */ CorporationMobile: string; /** * 法定代表人手机号码实名认证。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ CorporationMobilePicUrl: string; /** * 通话话术。(支持doc、docx格式的文档不超过50MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ UseDescribeFileUrl: string; /** * 公司授权函。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ CompanyAuthLetterPicUrl: string; /** * 电话受理单。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ AcceptPicUrl: string; /** * 法定代表人手持身份证照,申请人类型为法定代表人时必填。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ CorporationHoldingOnIdPicUrl?: string; /** * 经办人名称,申请人类型为经办人时必填。 */ OperatorName?: string; /** * 经办人证件号码,申请人类型为经办人时必填。 */ OperatorId?: string; /** * 经办人身份证正反面扫描件,申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ OperatorIdPicUrl?: string; /** * 经办人手持身份证照,申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ OperatorHoldingOnIdPicUrl?: string; /** * 委托授权书,申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ CommissionPicUrl?: string; /** * 经办人手机号,申请人类型为经办人时必填。 */ OperatorMobile?: string; /** * 经办人邮箱,申请人类型为经办人时必填。 */ OperatorEmail?: string; /** * 经办人手机号码实名认证,申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片,每张图片应大于50K,不超过5MB,模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update) */ OperatorMobilePicUrl?: string; } /** * CreateSDKLoginToken返回参数结构体 */ export interface CreateSDKLoginTokenResponse { /** * SDK 登录 Token。 */ Token?: string; /** * 过期时间戳,Unix 时间戳。 */ ExpiredTime?: number; /** * SDK 加载路径会随着 SDK 的发布而变动。 */ SdkURL?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyStaff请求参数结构体 */ export interface ModifyStaffRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 座席账户 */ Email: string; /** * 座席名称 */ Name?: string; /** * 座席手机号(带0086前缀,示例:008618011111111) */ Phone?: string; /** * 座席昵称 */ Nick?: string; /** * 座席工号 */ StaffNo?: string; /** * 绑定技能组ID列表 */ SkillGroupIds?: Array; /** * 是否开启手机外呼开关 */ UseMobileCallOut?: boolean; /** * 手机接听模式 0 - 关闭 | 1 - 仅离线 | 2 - 始终 */ UseMobileAccept?: number; /** * 座席分机号(1 到 8 打头,4 - 6 位) */ ExtensionNumber?: string; /** * 呼叫转移配置 */ ForwardingConfig?: ForwardingConfig; } /** * DescribeAIAgentInfoList返回参数结构体 */ export interface DescribeAIAgentInfoListResponse { /** * 智能体信息列表 */ AIAgentInfoList?: Array; /** * 智能体总数量 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeIvrAudioList返回参数结构体 */ export interface DescribeIvrAudioListResponse { /** * 总数 */ TotalCount?: number; /** * 文件信息 */ FileInfo?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询预测式外呼任务列表元素 */ export interface DescribePredictiveDialingCampaignsElement { /** * 任务 ID */ CampaignId?: number; /** * 任务名称 */ Name?: string; /** * 任务状态 0 待开始 1 进行中 2 已暂停 3 已终止 4 已完成 */ Status?: number; /** * 任务状态原因 0 正常 1 手动结束 2 超时结束 */ StatusReason?: number; /** * 被叫号码个数 */ CalleeCount?: number; /** * 已完成的被叫个数 */ FinishedCalleeCount?: number; /** * 相同应用内多个任务运行优先级,从高到底 1 - 5 */ Priority?: number; /** * 使用的座席技能组 ID */ SkillGroupId?: number; } /** * SetStaffStatus返回参数结构体 */ export interface SetStaffStatusResponse { /** * 设置座席状态应答列表 */ StaffStatusList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * http return key */ export interface ReturnKey { /** * */ Key?: string; } /** * Bearer 鉴权 */ export interface BearerAuth { /** * */ BearerToken?: string; } /** * DisableCCCPhoneNumber返回参数结构体 */ export interface DisableCCCPhoneNumberResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 筛选条件 */ export interface Filter { /** * 筛选字段名 */ Name: string; /** * 筛选条件值 */ Values: Array; } /** * DescribeProtectedTelCdr返回参数结构体 */ export interface DescribeProtectedTelCdrResponse { /** * 话单记录总数 */ TotalCount?: number; /** * 话单记录 * @deprecated */ TelCdrs?: Array; /** * 话单记录 */ TelCdrList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResetExtensionPassword请求参数结构体 */ export interface ResetExtensionPasswordRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分机号 */ ExtensionId: string; } /** * DescribeAutoCalloutTask请求参数结构体 */ export interface DescribeAutoCalloutTaskRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务Id */ TaskId: number; } /** * DescribeAIAgentInfoList请求参数结构体 */ export interface DescribeAIAgentInfoListRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分页尺寸,上限 100 */ PageSize: number; /** * 分页页码,从 0 开始 */ PageNumber: number; } /** * CreateUserSig返回参数结构体 */ export interface CreateUserSigResponse { /** *

签名结果

*/ UserSig?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAICall请求参数结构体 */ export interface CreateAICallRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

被叫号码

*/ Callee: string; /** *

模型接口协议类型,目前兼容四种协议类型:

  • OpenAI协议(包括GPT、混元、DeepSeek等):"openai"
  • Azure协议:"azure"
  • Minimax协议:"minimax"
  • Dify协议: "dify"
*/ LLMType: string; /** *

模型API密钥,获取鉴权信息方式请参见各模型官网

*/ APIKey: string; /** *

模型接口地址

  • OpenAI协议
    GPT:"https://api.openai.com/v1/"
    混元:"https://api.hunyuan.cloud.tencent.com/v1"
    Deepseek:"https://api.deepseek.com/v1"

  • Azure协议
    "https://{your-resource-name}.openai.azure.com?api-version={api-version}"

  • Minimax协议
    "https://api.minimax.chat/v1"

*/ APIUrl: string; /** *

用于设定AI人设、说话规则、任务等的全局提示词。示例:## 人设您是人民医院友善、和蔼的随访医生李医生,正在给患者小明的家长打电话,原因是医院要求小明2024-08-08回院复查手术恢复情况,但小明没有来。您需要按照任务流程对小明家长进行电话随访调查。## 要求简洁回复:使用简练语言,每次最多询问一个问题,不要在一个回复中询问多个问题。富有变化:尽量使表达富有变化,表达机械重复。自然亲切:使用日常语言,尽量显得专业并亲切。提到时间时使用口语表述,如下周三、6月18日。积极主动:尝试引导对话,每个回复通常以问题或下一步建议来结尾。询问清楚:如果对方部分回答了您的问题,或者回答很模糊,请通过追问来确保回答的完整明确。遵循任务:当对方的回答偏离了您的任务时,及时引导对方回到任务中。不要从头开始重复,从偏离的地方继续询问。诚实可靠:对于客户的提问,如果不确定请务必不要编造,礼貌告知对方不清楚。不要捏造患者未提及的症状史、用药史、治疗史。其他注意点:避免提到病情恶化、恢复不理想或疾病名称等使用会使患者感到紧张的表述。不要问患者已经直接或间接回答过的问题,例如患者已经说没有不适症状,那就不要再问手术部位是否有红肿疼痛症状的问题。##任务: 1.自我介绍您是人民医院负责随访的李医生,并说明致电的目的。2.询问被叫方是否是小明家长。 - 如果不是小明家长,请礼貌表达歉意,并使用 call_end 挂断电话。- 如果小明家长没空,请礼貌告诉对方稍后会重新致电,并使用 end_call 挂断电话。3.询问小明出院后水肿情况如何,较出院时是否有变化。- 如果水肿变严重,直接跳转步骤7。4.询问出院后是否给小朋友量过体温,是否出现过发烧情况。- 如果没有量过体温,请礼貌告诉家长出院后三个月内需要每天观察体温。- 如果出现过发烧,请直接跳转步骤7。5.询问出院后是否给小朋友按时服药。- 如果没有按时服药,请友善提醒家长严格按医嘱服用药物,避免影响手术效果。6.询问小朋友在饮食上是否做到低盐低脂,适量吃优质蛋白如鸡蛋、牛奶、瘦肉等。- 如果没有做到,请友善提醒家长低盐低脂和优质蛋白有助小朋友尽快恢复。7.告知家长医生要求6月18日回院复查,但没看到有相关复诊记录。提醒家长尽快前往医院体检复查血化验、尿常规。8.询问家长是否有问题需要咨询,如果没有请礼貌道别并用call_end挂断电话。

*/ SystemPrompt?: string; /** *

模型名称,如

  • OpenAI协议
    "gpt-4o-mini","gpt-4o","hunyuan-standard", "hunyuan-turbo","deepseek-chat";

  • Azure协议
    "gpt-4o-mini", "gpt-4o";

  • Minmax协议
    "deepseek-chat".

*/ Model?: string; /** *

默认提供以下音色参数值可选择,如需自定义音色VoiceType请留空并在参数CustomTTSConfig中配置

汉语:
ZhiMei:智美,客服女声
ZhiXi: 智希 通用女声
ZhiQi:智琪 客服女声
ZhiTian:智甜 女童声
AiXiaoJing:爱小静 对话女声

英语:
WeRose:英文女声
Monika:英文女声

日语:
Nanami

韩语:
SunHi

印度尼西亚语(印度尼西亚):
Gadis

马来语(马来西亚):
Yasmin

泰米尔语(马来西亚):
Kani

泰语(泰国):
Achara

越南语(越南):
HoaiMy

*/ VoiceType?: string; /** *

主叫号码列表

*/ Callers?: Array; /** *

用于设定AI座席欢迎语。

*/ WelcomeMessage?: string; /** *

0:使用welcomeMessage(为空时,被叫先说话;不为空时,机器人先说话)
1: 使用ai根据prompt自动生成welcomeMessage并先说话

*/ WelcomeType?: number; /** *

0: 默认可打断, 2:高优先不可打断

*/ WelcomeMessagePriority?: number; /** *

最大等待时长(毫秒),默认60秒,超过这个时间用户没说话,自动挂断

*/ MaxDuration?: number; /** *

语音识别支持的语言, 默认是"zh" 中文,
填写数组,最长4个语言,第一个语言为主要识别语言,后面为可选语言,
注意:主要语言为中国方言时,可选语言无效
目前全量支持的语言如下,等号左面是语言英文名,右面是Language字段需要填写的值,该值遵循ISO639:

  1. Chinese = "zh" # 中文
  2. Chinese_TW = "zh-TW" # 中国台湾
  3. Chinese_DIALECT = "zh-dialect" # 中国方言
  4. English = "en" # 英语
  5. Vietnamese = "vi" # 越南语
  6. Japanese = "ja" # 日语
  7. Korean = "ko" # 汉语
  8. Indonesia = "id" # 印度尼西亚语
  9. Thai = "th" # 泰语
  10. Portuguese = "pt" # 葡萄牙语
  11. Turkish = "tr" # 土耳其语
  12. Arabic = "ar" # 阿拉伯语
  13. Spanish = "es" # 西班牙语
  14. Hindi = "hi" # 印地语
  15. French = "fr" # 法语
  16. Malay = "ms" # 马来语
  17. Filipino = "fil" # 菲律宾语
  18. German = "de" # 德语
  19. Italian = "it" # 意大利语
  20. Russian = "ru" # 俄语
*/ Languages?: Array; /** *

打断AI说话模式,默认为0,0表示自动打断,1表示不打断。

*/ InterruptMode?: number; /** *

InterruptMode为0时使用,单位为毫秒,默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断。

*/ InterruptSpeechDuration?: number; /** *

模型是否支持(或者开启)call_end function calling

*/ EndFunctionEnable?: boolean; /** *

EndFunctionEnable为true时生效;call_end function calling的desc,默认为 "End the call when user has to leave (like says bye) or you are instructed to do so."

*/ EndFunctionDesc?: string; /** *

模型是否支持(或者开启)transfer_to_human function calling

*/ TransferFunctionEnable?: boolean; /** *

TransferFunctionEnable为true的时候生效: 转人工配置

*/ TransferItems?: Array; /** *

模型是否支持(或者开启)转智能体function calling

*/ TransferToAgentEnable?: boolean; /** *

TransferToAgentEnable为true的时候生效: 转智能体配置

*/ TransferToAgentItems?: Array; /** *

用户多久没说话提示时长,最小10秒,默认10秒

*/ NotifyDuration?: number; /** *

用户NotifyDuration没说话,AI提示的语句,默认是"抱歉,我没听清。您可以重复下吗?"

*/ NotifyMessage?: string; /** *

最大触发AI提示音次数,默认为不限制

*/ NotifyMaxCount?: number; /** *

和VoiceType字段需要选填一个,这里是使用自己自定义的TTS,VoiceType是系统内置的一些音色

{        "TTSType": "tencent", // String TTS类型, 目前支持"tencent" 和 “minixmax”, 其他的厂商支持中     u2003 "AppId": "您的应用ID", // String 必填     u2003 "SecretId": "您的密钥ID", // String 必填     u2003 "SecretKey":  "您的密钥Key", // String 必填     u2003 "VoiceType": 101001, // Integer  必填,音色 ID,包括标准音色与精品音色,精品音色拟真度更高,价格不同于标准音色,请参见语音合成计费概述。完整的音色 ID 列表请参见语音合成音色列表。     u2003 "Speed": 1.25, // Integer 非必填,语速,范围:[-2,6],分别对应不同语速: -2: 代表0.6倍 -1: 代表0.8倍 0: 代表1.0倍(默认) 1: 代表1.2倍 2: 代表1.5倍  6: 代表2.5倍  如果需要更细化的语速,可以保留小数点后 2 位,例如0.5/1.25/2.81等。 参数值与实际语速转换,可参考 语速转换     u2003 "Volume": 5, // Integer 非必填,音量大小,范围:[0,10],分别对应11个等级的音量,默认值为0,代表正常音量。     u2003 "PrimaryLanguage": 1, // Integer 可选 主要语言 1-中文(默认) 2-英文 3-日文       "FastVoiceType": "xxxx"   //  可选参数, 快速声音复刻的参数  u2003}
{        "TTSType": "minimax",  // String TTS类型,         "Model": "speech-01-turbo",        "APIUrl": "https://api.minimax.chat/v1/t2a_v2",        "APIKey": "eyxxxx",        "GroupId": "181000000000000",        "VoiceType":"female-tianmei",        "Speed": 1.2}
  • 火山 TTS

配置音色类型参考火山TTS文档链接
语音合成音色列表–语音技术-火山引擎
大模型语音合成音色列表–语音技术-火山引擎

{    "TTSType": "volcengine",  // 必填:String TTS类型    "AppId" : "xxxxxxxx",   // 必填:String 火山引擎分配的Appid    "Token" : "TY9d4sQXHxxxxxxx", // 必填: String类型 火山引擎的访问token    "Speed" : 1.0,            // 可选参数 语速,默认为1.0    "Volume": 1.0,            // 可选参数, 音量大小, 默认为1.0    "Cluster" : "volcano_tts", // 可选参数,业务集群, 默认是 volcano_tts    "VoiceType" : "zh_male_aojiaobazong_moon_bigtts"   // 音色类型, 默认为大模型语音合成的音色。 如果使用普通语音合成,则需要填写对应的音色类型。 音色类型填写错误会导致没有声音。}
{    "TTSType": "azure", // 必填:String TTS类型    "SubscriptionKey": "xxxxxxxx", // 必填:String 订阅的Key    "Region": "chinanorth3",  // 必填:String 订阅的地区    "VoiceName": "zh-CN-XiaoxiaoNeural", // 必填:String 音色名必填    "Language": "zh-CN", // 必填:String 合成的语言      "Rate": 1 // 选填:float 语速  0.5~2 默认为 1}
  • 自定义TTS

具体协议规范请参考腾讯文档

{  "TTSType": "custom", // String 必填  "APIKey": "ApiKey", // String 必填 用来鉴权  "APIUrl": "http://0.0.0.0:8080/stream-audio" // String,必填,TTS API URL  "AudioFormat": "wav", // String, 非必填,期望输出的音频格式,如mp3, ogg_opus,pcm,wav,默认为 wav,目前只支持pcm和wav,  "SampleRate": 16000,  // Integer,非必填,音频采样率,默认为16000(16k),推荐值为16000  "AudioChannel": 1,    // Integer,非必填,音频通道数,取值:1 或 2  默认为1  }
*/ CustomTTSConfig?: string; /** *

提示词变量

* @deprecated */ PromptVariables?: Array; /** *

语音识别vad的时间,范围为240-2000,默认为1000,单位为ms。更小的值会让语音识别分句更快。

*/ VadSilenceTime?: number; /** *

通话内容提取配置

*/ ExtractConfig?: Array; /** *

模型温度控制

*/ Temperature?: number; /** *

通用变量:

提示词变量

欢迎语变量

欢迎语延迟播放(秒级):welcome-message-delay

dify变量

  1. dify-inputs-xxx 为dify的inputs变量
  2. dify-inputs-user 为dify的user值
  3. dify-inputs-conversation_id 为dify的conversation_id值
*/ Variables?: Array; /** *

模型topP

*/ TopP?: number; /** *

vad的远场人声抑制能力(不会对asr识别效果造成影响),范围为[0, 3],默认为0。推荐设置为2,有较好的远场人声抑制能力。

*/ VadLevel?: number; /** *

衔接语

*/ ToneWord?: ToneWordInfo; /** *

合规提示音,
该参数传true(默认)表示通话开始播放摩斯码,提示对话内容为 AI 生成。
该参数传false表示关闭合规提示音。该参数传false则代表您知晓并同意以下协议:
我方充分知悉和理解,根据《网络安全法》《互联网信息服务深度合成管理规定》《生成式人工智能服务管理暂行办法》《人工智能生成合成内容标识办法》的法律法规的规定,对人工智能生成合成内容应当添加显式标识和隐式标识。我方基于业务需求,请腾讯云对生成合成内容不添加显式标识,我方承诺合法合规使用生成合成内容,避免造成混淆、误认;如果使用生成合成内容对公众提供服务的,或通过网络传播的,我方将自觉主动添加符合法律规定和国家标准要求的显式标识,承担人工智能生成合成内容标识的法律义务。我方未能恰当、合理地履行人工智能内容标识义务造成不良后果的,或遭受主管部门责罚的,相关责任由我方完全承担。

*/ EnableComplianceAudio?: boolean; /** *

是否开启语音信箱识别

*/ EnableVoicemailDetection?: boolean; /** *

识别到对端为语音信箱时的行为,当EnableVoicemailDetection为True时生效
0: 挂断电话(默认)

*/ VoicemailAction?: number; /** *

大模型拓展参数, 格式为json字符串

*/ LLMExtraBody?: string; /** *

最大通话时长, 默认不限制。单位毫秒(ms)

*/ MaxCallDurationMs?: number; /** *

最大振铃时长,达到时长阈值自动挂断。 仅自携号码支持当前参数

*/ MaxRingTimeoutSecond?: number; /** *

环境音场景,没有的话不填。
coffee_shops:咖啡店氛围,背景中有人聊天
busy_office:客服中心

*/ AmbientSoundType?: string; /** *

环境音音量。如果AmbientSoundType 为空,该字段不填。取值的范围是 [0,2]。值越低,环境音越小;值越高,环境音越响亮。如果未设置,则使用默认值 1。

*/ AmbientSoundVolume?: number; /** *

智能体并发不足时,排队等待超时时间,单位秒

取值范围:[0, 5]

默认值:5

*/ AcquireTimeoutSecond?: number; /** *

自定义STT配置,请联系产品/开发后使用

*/ CustomSTTConfig?: string; } /** * 带有技能组优先级的座席信息 */ export interface StaffInfo { /** * 座席名称 */ Name?: string; /** * 座席邮箱 */ Mail?: string; /** * 座席电话号码 */ Phone?: string; /** * 座席昵称 */ Nick?: string; /** * 座席工号 */ StaffNumber?: string; /** * 用户角色 ID,一个用户绑定了多个角色时以RoleIdList为准 * @deprecated */ RoleId?: number; /** * 用户角色id列表 * @deprecated */ RoleIdList?: number; /** * 用户角色id列表 */ RoleList?: Array; /** * 所属技能组列表 */ SkillGroupList?: Array; /** * 最后修改时间 */ LastModifyTimestamp?: number; /** * 座席分机号(1 到 8 打头,4 - 6 位) */ ExtensionNumber?: string; /** * 呼叫转移配置 */ ForwardingConfig?: ForwardingConfig; } /** * CreateAdminURL返回参数结构体 */ export interface CreateAdminURLResponse { /** * 登录链接 */ URL?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PausePredictiveDialingCampaign请求参数结构体 */ export interface PausePredictiveDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务 ID */ CampaignId: number; } /** * 呼转配置 */ export interface ForwardingConfig { /** * 是否启用 */ Enabled?: boolean; /** * 1 无条件呼转 2 有条件呼转 */ Condition?: number; /** * 呼转目标 */ Target?: ForwardingTarget; } /** * ModifyStaffPassword请求参数结构体 */ export interface ModifyStaffPasswordRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 座席邮箱 */ Email: string; /** * 设置的密码 */ Password: string; } /** * DescribeAILatency请求参数结构体 */ export interface DescribeAILatencyRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 会话 ID */ SessionId: string; /** * 查找起始时间 */ StartTime: number; /** * 1737350008 */ EndTime: number; } /** * CreateCallOutSession返回参数结构体 */ export interface CreateCallOutSessionResponse { /** * 新创建的会话 ID */ SessionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 智能体信息 */ export interface AIAgentInfo { /** * 智能体ID */ AIAgentId?: number; /** * 智能体名称 */ AIAgentName?: string; /** * 智能体变量名列表 */ VariableNames?: Array; } /** * DescribeCarrierPrivilegeNumberApplicants请求参数结构体 */ export interface DescribeCarrierPrivilegeNumberApplicantsRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 默认0,从0开始 */ PageNumber?: number; /** * 默认10,最大100 */ PageSize?: number; /** * 筛选条件,Name支持ApplicantId,PhoneNumber(按号码模糊查找) */ Filters?: Array; } /** * DisableCCCPhoneNumber请求参数结构体 */ export interface DisableCCCPhoneNumberRequest { /** * 号码列表,0086开头 */ PhoneNumbers: Array; /** * 停用开关,0启用 1停用 */ Disabled: number; /** * TCCC 实例应用 ID */ SdkAppId?: number; } /** * ModifyStaffPassword返回参数结构体 */ export interface ModifyStaffPasswordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ControlAIConversation返回参数结构体 */ export interface ControlAIConversationResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TransferToManual请求参数结构体 */ export interface TransferToManualRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 会话ID */ SessionId: string; /** * 技能组Id */ SkillGroupId: number; } /** * CreatePredictiveDialingCampaign请求参数结构体 */ export interface CreatePredictiveDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务名称 */ Name: string; /** * 被叫列表,支持 E.164 或不带国家码形式的号码 */ Callees: Array; /** * 主叫列表,使用管理端展示的号码格式 */ Callers: Array; /** * 被叫呼叫顺序 0 随机 1 顺序 */ CallOrder: number; /** * 使用的座席技能组 ID */ SkillGroupId: number; /** * 相同应用内多个任务运行优先级,从高到底 1 - 5 */ Priority: number; /** * 预期呼损率,百分比,0 - 50 */ ExpectedAbandonRate: number; /** * 呼叫重试间隔时间,单位秒,60 - 86400 */ RetryInterval: number; /** * 任务启动时间,Unix 时间戳,到此时间后会自动启动任务 */ StartTime: number; /** * 任务结束时间,Unix 时间戳,到此时间后会自动终止任务 */ EndTime: number; /** * 指定的 IVR Id */ IVRId?: number; /** * 呼叫重试次数,0 - 2 */ RetryTimes?: number; /** * 自定义变量 */ Variables?: Array; /** * UUI */ UUI?: string; /** * 被叫属性 */ CalleeAttributes?: Array; /** * IANA 时区名称,参考 https://datatracker.ietf.org/doc/html/draft-ietf-netmod-iana-timezones */ TimeZone?: string; /** * 可用时间段 */ AvailableTime?: Array; } /** * RestoreMemberOnline返回参数结构体 */ export interface RestoreMemberOnlineResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AbortAgentCruiseDialingCampaign返回参数结构体 */ export interface AbortAgentCruiseDialingCampaignResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeChatMessages返回参数结构体 */ export interface DescribeChatMessagesResponse { /** * 总记录数 */ TotalCount?: number; /** * 消息列表 */ Messages?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ 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; /** *

录音链接,带鉴权和有效期,获取之后请在24 小时内拉取,不要持久化此链接。如此链接已过期,请重新调用此接口获取新的链接

*/ RecordURL?: string; /** *

录音转存第三方 COS 链接

*/ CustomRecordURL?: string; /** *

录音文本信息链接,带鉴权和有效期,获取之后请在24 小时拉取,不要持久化此链接。如此链接已过期,请重新调用此接口获取新的链接

*/ AsrURL?: string; /** *

语音留言录音链接

*/ VoicemailRecordURL?: Array; /** *

语音留言录音文本信息链接,需在控制台购买离线语音识别套餐包并开启离线语音识别开关

*/ VoicemailAsrURL?: Array; /** *

IVR 按键信息

*/ IVRKeyPressed?: Array; /** *

满意度按键信息

*/ PostIVRKeyPressed?: Array; /** *

挂机方 seat 座席 user 用户 system 系统

*/ HungUpSide?: string; /** *

客户自定义数据(User-to-User Interface)

*/ UUI?: string; /** *

通话中的事件列表

*/ Events?: Array; /** *

服务参与者列表

*/ ServeParticipants?: Array; /** *

接通后系统挂断原因状态码

详见

*/ SysHangupReason?: number; /** *

接通后系统挂断原因

详见

*/ SysHangupReasonString?: string; /** *

通话结束状态V2(灰度中)

*/ EndStatusV2?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 参与者信息 */ export interface ServeParticipant { /** * 座席邮箱 */ Mail?: string; /** * 座席电话 */ Phone?: string; /** * 振铃时间戳,Unix 秒级时间戳 */ RingTimestamp?: number; /** * 接听时间戳,Unix 秒级时间戳 */ AcceptTimestamp?: number; /** * 结束时间戳,Unix 秒级时间戳 */ EndedTimestamp?: number; /** * 录音 ID,能够索引到座席侧的录音 */ RecordId?: string; /** * 参与者类型,"staffSeat", "outboundSeat", "staffPhoneSeat" */ Type?: string; /** * 转接来源座席信息 */ TransferFrom?: string; /** * 转接来源参与者类型,取值与 Type 一致 */ TransferFromType?: string; /** * 转接去向座席信息 */ TransferTo?: string; /** * 转接去向参与者类型,取值与 Type 一致 */ TransferToType?: string; /** * 技能组 ID */ SkillGroupId?: number; /** * 结束状态 中文详情[参考](https://www.tencentcloud.com/zh/document/product/1229/71847) 英文详情[参考](https://www.tencentcloud.com/document/product/1229/71847?lang=en) */ EndStatusString?: string; /** * 录音 URL */ RecordURL?: string; /** * 参与者序号,从 0 开始 */ Sequence?: number; /** * 开始时间戳,Unix 秒级时间戳 */ StartTimestamp?: number; /** * 技能组名称 */ SkillGroupName?: string; /** * 录音转存第三方COS地址 */ CustomRecordURL?: string; } /** * PlaySoundCall返回参数结构体 */ export interface PlaySoundCallResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AI 通话提取结果。 */ export interface AICallExtractResultElement { /** * 提取信息的类型 Text 文本 Selector 选项 Boolean 布尔值 Number 数字 */ InfoType?: string; /** * 提取信息的名称 */ InfoName?: string; /** * 提取信息的具体描述 */ InfoContent?: string; /** * 提取信息的具体结果 */ Result?: AICallExtractResultInfo; } /** * DescribeTelCallInfo返回参数结构体 */ export interface DescribeTelCallInfoResponse { /** *

呼出套餐包消耗分钟数

*/ TelCallOutCount?: number; /** *

呼入套餐包消耗分钟数

*/ TelCallInCount?: number; /** *

坐席使用统计个数

*/ SeatUsedCount?: number; /** *

音频套餐包消耗分钟数

* @deprecated */ VoipCallInCount?: number; /** *

音频套餐包消耗分钟数

*/ VOIPCallInCount?: number; /** *

离线语音转文字套餐包消耗分钟数

*/ AsrOfflineCount?: number; /** *

实时语音转文字套餐包消耗分钟数

*/ AsrRealtimeCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用户发言事件 */ export interface UserReplyEvent { /** *

ASR语音识别引擎将用户语音转换成的原始文本结果

*/ ASRTranscript?: string; /** *

命中画布中该对话节点配置的回复分类

*/ MatchedIntent?: string; /** *

本轮收集到的词槽列表(TagType 为 2 或 3),json 序列化后的字符串。数组元素含 TagName(词槽名)、TagValue(词槽值)、TagType(词槽类型,2 表示必填词槽,3 表示选填词槽)三个字段;无词槽时为空字符串。

*/ ExtractedSlots?: string; /** *

用户回复命中的分支类型

枚举值:

  • Intent: 用户意图
  • Fallback: 兜底分支
  • NoResponse: 无响应跳转分支
  • SlotCollectionSuccess: 词槽收集完成跳转分支
  • SlotCollectionFail: 词槽收集失败跳转分支
  • GlobalIntent: 全局节点意图
  • LogicAnd: 逻辑判断节点 and
  • LogicOr: 逻辑判断节点 or
  • DTMFSuccess: DTMF 收号成功
  • DTMFFail: DTMF 收号失败
  • DTMFNavigation: DTMF 导航
  • DTMFExtension: DTMF 分机
  • DTMFCollection: DTMF 收号
  • TransferAgentFail: 转接智能体节点失败
  • Other: 其他分支类型
*/ BranchType?: string; } /** * DescribeExtensions返回参数结构体 */ export interface DescribeExtensionsResponse { /** * 查询总数 */ Total?: number; /** * 话机信息列表 */ ExtensionList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 座席状态相关信息 */ export interface StaffStatusMetrics { /** * 座席邮箱 */ Email?: string; /** * 座席状态 free 示闲 | busy 忙碌 | rest 小休 | notReady 示忙 | afterCallWork 话后调整 | offline 离线 */ Status?: string; /** * 座席状态补充信息 */ StatusExtra?: StaffStatusExtra; /** * 当天在线总时长 */ OnlineDuration?: number; /** * 当天示闲总时长 */ FreeDuration?: number; /** * 当天忙碌总时长 */ BusyDuration?: number; /** * 当天示忙总时长 */ NotReadyDuration?: number; /** * 当天小休总时长 */ RestDuration?: number; /** * 当天话后调整总时长 */ AfterCallWorkDuration?: number; /** * 小休原因 */ Reason?: string; /** * 是否预约小休 */ ReserveRest?: boolean; /** * 是否预约示忙 */ ReserveNotReady?: boolean; /** * 手机接听模式: 0 - 关闭 | 1 - 仅离线 | 2- 始终 */ UseMobileAccept?: number; /** * 手机外呼开关 */ UseMobileCallOut?: boolean; /** * 最近一次上线时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ LastOnlineTimestamp?: number; /** * 最近一次状态时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ LastStatusTimestamp?: number; /** * 客服登录的端信息 */ ClientInfo?: Array; } /** * DeleteExtension请求参数结构体 */ export interface DeleteExtensionRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分机号 */ ExtensionId: string; } /** * DescribePredictiveDialingCampaign请求参数结构体 */ export interface DescribePredictiveDialingCampaignRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

任务 ID

*/ CampaignId: number; } /** * DescribePredictiveDialingCampaign返回参数结构体 */ export interface DescribePredictiveDialingCampaignResponse { /** *

任务 ID

*/ CampaignId?: number; /** *

任务名称

*/ Name?: string; /** *

被叫呼叫顺序 0 随机 1 顺序

*/ CallOrder?: number; /** *

使用的座席技能组 ID

*/ 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; /** *

自定义变量

*/ Variables?: Array; /** *

UUI

*/ UUI?: string; /** *

任务状态

枚举值:

  • 0: 待开始
  • 1: 进行中
  • 2: 已暂停
  • 3: 已终止
  • 4: 已完成
*/ Status?: number; /** *

任务状态原因 0 正常 1 手动结束 2 超时结束

*/ StatusReason?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAIAgentCall返回参数结构体 */ export interface CreateAIAgentCallResponse { /** *

新创建的会话 ID

*/ SessionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AI 通话提取配置项 */ export interface AICallExtractConfigElement { /** * 配置项类型,包括 Text 文本 Selector 选项 Boolean 布尔值 Number 数字 */ InfoType: string; /** * 配置项名称,不可重复 */ InfoName: string; /** * 配置项具体内容 */ InfoContent?: string; /** * 配置项提取内容示例 */ Examples?: Array; /** * InfoType 为 Selector,需要配置此字段 */ Choices?: Array; } /** * 触发策略数组,每个策略里包含接口调用信息,挂断类型,通话标签,触发模式 */ export interface TriggerStrategyItem { /** *

http 接口相关参数

*/ InterfaceConfig?: HttpCallbackConfig; /** *

挂断类型

*/ HangupTypes?: Array; /** *

通话标签

*/ CallTags?: Array; /** *

触发模式

枚举值:

  • ONCE_PER_NUMBER: 每个号码仅第一次命中条件时触发
  • ALWAYS_ON_MATCH: 每次命中条件均触发
*/ TriggerMode?: string; } /** * DescribeAutoCalloutTasks返回参数结构体 */ export interface DescribeAutoCalloutTasksResponse { /** * 总数 */ TotalCount?: number; /** * 任务列表 */ Tasks?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 套餐包购买信息 */ export interface PackageBuyInfo { /** * 套餐包Id */ PackageId: string; /** * 套餐包类型,0-外呼套餐包|1-400呼入套餐包 */ Type: number; /** * 套餐包总量 */ CapacitySize: number; /** * 套餐包剩余量 */ CapacityRemain: number; /** * 购买时间戳 */ BuyTime: number; /** * 截止时间戳 */ EndTime: number; } /** * DescribeTelCdr请求参数结构体 */ export interface DescribeTelCdrRequest { /** *

起始时间戳,Unix 秒级时间戳,最大支持近180天。

*/ StartTimeStamp: number; /** *

结束时间戳,Unix 秒级时间戳,结束时间与开始时间的区间范围小于90天。

*/ EndTimeStamp: number; /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

分页尺寸(必填),上限 100

*/ PageSize: number; /** *

分页页码(必填),从 0 开始

*/ PageNumber: number; /** *

实例 ID(废弃)

* @deprecated */ InstanceId?: number; /** *

返回数据条数,上限(废弃)

* @deprecated */ Limit?: number; /** *

偏移(废弃)

* @deprecated */ Offset?: number; /** *

按手机号筛选

*/ Phones?: Array; /** *

按SessionId筛选

*/ SessionIds?: Array; } /** * UnbindStaffSkillGroupList请求参数结构体 */ export interface UnbindStaffSkillGroupListRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 客服邮箱 */ StaffEmail: string; /** * 解绑技能组列表 */ SkillGroupList: Array; } /** * basic 鉴权 */ export interface BasicAuth { /** * */ BasicToken?: string; } /** * 表示一轮完整的对话交互 */ export interface AICallInteractionRound { /** *

本轮对话的唯一标识 Id

*/ RoundId?: string; /** *

轮次

*/ RoundIndex?: number; /** *

本轮命中的普通标签列表(TagType 为 1),json 序列化后的字符串。数组元素含 TagName(标签名)、TagValue(标签值)、TagType(标签类型,1 表示普通标签)三个字段;无标签时为空字符串。

*/ Tags?: string; /** *

本轮涉及到的消息内容

*/ Messages?: Array; /** *

本轮对话在画布中经过的节点路径

*/ Paths?: Array; } /** * http header 参数 */ export interface HeaderParams { /** * */ Key?: string; /** * */ Value?: string; } /** * 文本会话服务记录信息 */ export interface IMCdrInfo { /** * 服务记录ID */ Id?: string; /** * 服务时长秒数 */ Duration?: number; /** * 结束状态 0 异常结束 1 正常结束 3 无座席在线 17 座席放弃接听 100 黑名单 101 座席手动转接 102 IVR阶段放弃 108 用户超时自动结束 109 用户主动结束 */ EndStatus?: number; /** * 用户昵称 */ Nickname?: string; /** * 服务类型 1为全媒体,2为文本客服 */ Type?: number; /** * 客服ID */ StaffId?: string; /** * 服务时间戳 */ Timestamp?: number; /** * 会话ID */ SessionId?: string; /** * 技能组ID */ SkillGroupId?: string; /** * 技能组名称 */ SkillGroupName?: string; /** * 满意度 注意:此字段可能返回 null,表示取不到有效值。 */ Satisfaction?: IMSatisfaction; /** * 用户ID */ ClientUserId?: string; } /** * CreateAgentCruiseDialingCampaign请求参数结构体 */ export interface CreateAgentCruiseDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务名称 */ Name: string; /** * 座席账号 */ Agent: string; /** * 单轮并发呼叫量 1-20 */ ConcurrencyNumber: number; /** * 任务启动时间,Unix 时间戳,到此时间后会自动启动任务 */ StartTime: number; /** * 任务结束时间,Unix 时间戳,到此时间后会自动终止任务 */ EndTime: number; /** * 被叫列表,支持 E.164 或不带国家码形式的号码 */ Callees?: Array; /** * 主叫列表,使用管理端展示的号码格式 */ Callers?: Array; /** * 被叫呼叫顺序 0 随机 1 顺序 */ CallOrder?: number; /** * 调用方自定义数据,最大长度 1024 */ UUI?: string; } /** * DescribeAICallExtractResult请求参数结构体 */ export interface DescribeAICallExtractResultRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 会话 ID */ SessionId: string; /** * 查找起始时间 */ StartTime: number; /** * 查找结束时间 */ EndTime: number; } /** * CreateStaff返回参数结构体 */ export interface CreateStaffResponse { /** * 错误坐席列表及错误信息 */ ErrorStaffList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ 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; /** *

任务 ID

*/ CampaignId?: number; } /** * DescribeSkillGroupInfoList返回参数结构体 */ export interface DescribeSkillGroupInfoListResponse { /** * 技能组总数 */ TotalCount?: number; /** * 技能组信息列表 */ SkillGroupList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNumbers返回参数结构体 */ export interface DescribeNumbersResponse { /** *

总数量

*/ TotalCount?: number; /** *

号码列表

*/ Numbers?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 承接语气词 */ export interface ZHToneWordsInfo { /** * 中性词列表 */ Neutral?: Array; /** * 正面词列表 */ Positive?: Array; /** * 负面词列表 */ Negative?: Array; } /** * DeletePredictiveDialingCampaign请求参数结构体 */ export interface DeletePredictiveDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务 ID */ CampaignId: number; } /** * UploadIvrAudio请求参数结构体 */ export interface UploadIvrAudioRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 音频文件列表 */ AudioList: Array; } /** * DescribeStaffInfoList返回参数结构体 */ export interface DescribeStaffInfoListResponse { /** *

坐席用户总数

*/ TotalCount?: number; /** *

坐席用户信息列表

*/ StaffList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 服务端控制AI对话机器人播报指定文本 */ export interface ServerPushText { /** * 服务端推送播报文本 */ Text?: string; /** * 是否允许该文本打断机器人说话 */ Interrupt?: boolean; /** * 播报完文本后,是否自动关闭对话任务 */ StopAfterPlay?: boolean; /** * 服务端推送播报音频 格式说明:音频必须为单声道,采样率必须跟对应TTS的采样率保持一致,编码为Base64字符串。 输入规则:当提供Audio字段时,将不接受Text字段的输入。系统将直接播放Audio字段中的音频内容。 */ Audio?: string; /** * 默认为0,仅在Interrupt为false时有效 - 0表示当前有交互发生时,会丢弃Interrupt为false的消息 - 1表示当前有交互发生时,不会丢弃Interrupt为false的消息,而是缓存下来,等待当前交互结束后,再去处理 注意:DropMode为1时,允许缓存多个消息,如果后续出现了打断,缓存的消息会被清空 */ DropMode?: number; /** * ServerPushText消息的优先级,0表示可被打断,1表示不会被打断。 注意:在接收到Priority=1的消息后,后续其他任何消息都会被忽略(包括Priority=1的消息),直到Priority=1的消息处理结束。该字段可与Interrupt、DropMode字段配合使用。 例子: - Priority=1、Interrupt=true,会打断现有交互,立刻播报,播报过程中不会被打断 - Priority=1、Interrupt=false、DropMode=1,会等待当前交互结束,再进行播报,播报过程中不会被打断 */ Priority?: number; /** * 是否将文本加入到llm历史上下文中 */ AddHistory?: boolean; } /** * AI时延统计 */ export interface AILatencyStatisticsInfo { /** * 最小值 */ MinLatency?: number; /** * 中位数 */ MiddleLatency?: number; /** * p90 */ P90Latency?: number; } /** * UnbindNumberCallOutSkillGroup请求参数结构体 */ export interface UnbindNumberCallOutSkillGroupRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 待解绑的号码 */ Number: string; /** * 待解绑的技能组Id列表 */ SkillGroupIds: Array; } /** * CreateCarrierPrivilegeNumberApplicant请求参数结构体 */ export interface CreateCarrierPrivilegeNumberApplicantRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 主叫号码,必须为实例中存在的号码,格式为0086xxxx(暂时只支持国内号码) */ Callers: Array; /** * 被叫号码,必须为实例中坐席绑定的手机号码,格式为0086xxxx(暂时只支持国内号码) */ Callees: Array; /** * 描述 */ Description?: string; } /** * ResumePredictiveDialingCampaign返回参数结构体 */ export interface ResumePredictiveDialingCampaignResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 闪信记录 */ export interface FlashSMSRecord { /** * 会话 ID */ SessionId?: string; /** * 闪信投递号码(被叫) */ DeliveryNumber?: string; /** * 呼叫关联的系统号码 */ ServingNumber?: string; /** * 投递状态,1 表示成功,其他表示失败 */ DeliveryStatus?: number; /** * 投递失败原因 */ DeliveryMessage?: string; /** * 投递时间戳,Unix 秒级时间戳 */ DeliveryTimestamp?: number; /** * 送达时间(送达成功),Unix 秒级时间戳 */ ArriveTimestamp?: number; } /** * 呼入技能组相关指标 */ export interface CallInSkillGroupMetrics { /** * 技能组ID */ SkillGroupId: number; /** * 数据指标 */ Metrics: CallInMetrics; /** * 技能组名称 */ Name: string; } /** * CreateExtension返回参数结构体 */ export interface CreateExtensionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateUserSig请求参数结构体 */ export interface CreateUserSigRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

用户 ID

*/ Uid: string; /** *

用户签名数据

*/ ClientData: string; /** *

有效期,单位秒,不超过 1 小时

*/ ExpiredTime: number; } /** * 接口调用节点的调用详情 */ export interface AICallAPICallDetail { /** *

是否异步上报。节点配置「等待接口返回」关闭时为 true,此时不处理响应也不影响流程走向,Status、StatusCode、CostMS 等结果字段均为空,只记录 Attempts 中的请求详情。

*/ Async?: boolean; /** *

本次接口调用的最终状态,重试场景为最后一次尝试的状态,Async 为 true 时为空。后续可能新增取值,请做好兼容。

枚举值:

  • success: 调通且返回 2xx,进入成功分支
  • failed: 调用失败或返回非 2xx,进入失败分支
  • terminated: 调用过程中被用户新意图打断,无最终结果
*/ Status?: string; /** *

最终 HTTP 状态码。调不通或异步上报时为 0。

*/ StatusCode?: number; /** *

失败摘要,格式为 {状态码或错误类型}:{错误信息}。调用成功时为空。

*/ Summary?: string; /** *

接口调用总耗时,包含全部重试。异步上报时为 0。

单位:ms

*/ CostMS?: number; /** *

重试次数。0 表示首次调用即结束,未发生重试。

*/ RetryCount?: number; /** *

每次尝试的明细,按时间顺序排列,至少包含首次调用。

注意:此字段可能返回 null,表示取不到有效值。 */ Attempts?: Array; } /** * DescribeAgentCruiseDialingCampaign请求参数结构体 */ export interface DescribeAgentCruiseDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务 ID */ CampaignId: number; } /** * CreateCCCSkillGroup请求参数结构体 */ export interface CreateCCCSkillGroupRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 技能组名称 */ SkillGroupName: string; /** * 技能组类型0-电话,1-在线,3-音频,4-视频 */ SkillGroupType: number; /** * 技能组接待人数上限(该技能组中1个座席可接待的人数上限)默认为1。1、若技能组类型为在线,则接待上限可设置为1及以上 2、若技能组类型为电话、音频、视频,则接待上线必须只能为1 */ MaxConcurrency?: number; } /** * AI 通话结果具体信息 */ export interface AICallExtractResultInfo { /** *

提取的类型是文本

*/ Text?: string; /** *

提取的类型是选项

*/ Chosen?: Array; /** *

提取类型是布尔值

*/ Boolean?: boolean; /** *

提取类型是数字

*/ Number?: number; } /** * DeleteCCCSkillGroup请求参数结构体 */ export interface DeleteCCCSkillGroupRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 技能组ID */ SkillGroupId: number; } /** * PauseAutoCalloutTask请求参数结构体 */ export interface PauseAutoCalloutTaskRequest { /** * 任务Id */ TaskId: number; /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; } /** * CreateCompanyApply请求参数结构体 */ export interface CreateCompanyApplyRequest { /** * 企业资质信息 */ CompanyInfo: CompanyApplyInfo; } /** * 调用服务端主动发起请求到LLM */ export interface InvokeLLM { /** * 请求LLM的内容 */ Content?: string; /** * 是否允许该文本打断机器人说话 */ Interrupt?: boolean; } /** * BindNumberCallInInterface请求参数结构体 */ export interface BindNumberCallInInterfaceRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 待绑定的号码 */ Number: string; /** * 待绑定的回调地址 */ CallInInterface?: Interface; /** * 绑定号码类型: inner: 内线号码 | number: 正常线路号码 */ NumberType?: string; } /** * DescribeTelSession请求参数结构体 */ export interface DescribeTelSessionRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 会话 ID */ SessionId: string; } /** * DescribeIMCdrs请求参数结构体 */ export interface DescribeIMCdrsRequest { /** * 起始时间(必填),Unix 秒级时间戳 */ StartTimestamp: number; /** * 结束时间(必填),Unix 秒级时间戳 */ EndTimestamp: number; /** * 实例 ID(废弃) * @deprecated */ InstanceId?: number; /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId?: number; /** * 返回记录条数,最大为100默认20 */ Limit?: number; /** * 返回记录偏移,默认为 0 */ Offset?: number; /** * 1为全媒体,2为文本客服,不填则查询全部 */ Type?: number; } /** * 通话事件 */ export interface SessionEvent { /** * 事件时间戳,Unix 秒级时间戳 */ Timestamp?: number; /** * 事件类型,目前支持 StaffHold StaffUnhold StaffMute StaffUnmute */ EventType?: string; /** * 座席相关事件详情 */ StaffEventDetail?: EventStaffDetail; } /** * DescribeSkillGroupInfoList请求参数结构体 */ export interface DescribeSkillGroupInfoListRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分页尺寸,上限 100 */ PageSize: number; /** * 分页页码,从 0 开始 */ PageNumber: number; /** * 技能组ID,查询单个技能组时使用 */ SkillGroupId?: number; /** * 查询修改时间大于等于ModifiedTime的技能组时使用 */ ModifiedTime?: number; /** * 技能组名称 */ SkillGroupName?: string; } /** * CreateCarrierPrivilegeNumberApplicant返回参数结构体 */ export interface CreateCarrierPrivilegeNumberApplicantResponse { /** * 申请单Id */ ApplicantId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 回调接口 */ export interface Interface { /** * 接口地址 */ URL: string; } /** * 接口调用的单次尝试明细 */ export interface AICallAPICallAttempt { /** *

尝试序号,从 1 开始,1 表示首次调用。

*/ Index?: number; /** *

本次尝试的发起时间戳,Unix 毫秒级时间戳。

单位:ms

*/ Timestamp?: number; /** *

本次尝试的结果状态,取值同 APICall.Status。

枚举值:

  • success: 调通且返回 2xx,进入成功分支
  • failed: 调用失败或返回非 2xx,进入失败分支
  • internal_fail: 内部调用失败
  • terminated: 调用过程中被用户新意图打断,无最终结果
*/ Status?: string; /** *

本次尝试的 HTTP 状态码。调不通时为 0。

*/ StatusCode?: number; /** *

本次尝试调不通时的错误类型,取值同 APICall.ErrorType。

枚举值:

  • timeout: 请求超时
  • connect_failed: 建立连接失败
  • dns_failed: DNS 解析失败
  • tls_failed: TLS 证书校验失败
  • other: 其他错误
*/ ErrorType?: string; /** *

本次尝试的失败摘要,格式为 {状态码或错误类型}:{错误信息}。本次尝试成功时为空。

*/ Summary?: string; /** *

本次尝试耗时。

单位:ms

*/ CostMS?: number; /** *

本次尝试的请求详情。

注意:此字段可能返回 null,表示取不到有效值。 */ Request?: AICallAPICallRequestDetail; /** *

本次尝试的响应详情。调不通(Status 为 unreachable)或异步上报时为空。

注意:此字段可能返回 null,表示取不到有效值。 */ Response?: AICallAPICallResponseDetail; } /** * 外呼任务被叫信息 */ export interface AutoCalloutTaskCalleeInfo { /** * 被叫号码 */ Callee: string; /** * 呼叫状态 0初始 1已接听 2未接听 3呼叫中 4待重试 */ State: number; /** * 会话ID列表 */ Sessions: Array; } /** * 座席用户信息 */ export interface SeatUserInfo { /** * 座席名称 */ Name: string; /** * 座席邮箱 */ Mail: string; /** * 工号 */ StaffNumber: string; /** * 座席电话号码(带0086前缀) */ Phone?: string; /** * 座席昵称 */ Nick?: string; /** * 用户ID */ UserId?: string; /** * 座席关联的技能组列表 */ SkillGroupNameList?: Array; /** * 1:管理员 2:质检员 3:普通座席 else:自定义角色ID */ Role?: number; /** * 座席分机号(1 到 8 打头,4 - 6 位) */ ExtensionNumber?: string; } /** * UpdateCCCSkillGroup返回参数结构体 */ export interface UpdateCCCSkillGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 接口调用的响应详情 */ export interface AICallAPICallResponseDetail { /** *

HTTP 状态码。

*/ StatusCode?: number; /** *

响应头,json 序列化后的字符串,键升序排列。敏感值已脱敏,无响应头时为空字符串。

*/ Headers?: string; /** *

响应体,超长时被截断,是否截断见 Truncated。

*/ Body?: string; /** *

响应体 Body 是否被截断。

*/ Truncated?: boolean; } /** * 语音转文本信息 */ export interface AsrData { /** * 用户方 */ User?: string; /** * 消息内容 */ Message?: string; /** * 时间戳 * @deprecated */ Timestamp?: number; /** * 句子开始时间,Unix 毫秒时间戳 */ Start?: number; /** * 句子结束时间,Unix 毫秒时间戳 */ End?: number; } /** * 运营商白名单号码申请单 */ export interface CarrierPrivilegeNumberApplicant { /** * 实例Id */ SdkAppId?: number; /** * 申请单Id */ ApplicantId?: number; /** * 主叫号码列表 */ Callers?: Array; /** * 被叫号码列表 */ Callees?: Array; /** * 描述 */ Description?: string; /** * 审批状态:1 待审核、2 通过、3 拒绝 */ State?: number; /** * 创建时间,unix时间戳(秒) */ CreateTime?: number; /** * 更新时间,unix时间戳(秒) */ UpdateTime?: number; } /** * 批量添加客服时,返回出错客服的信息 */ export interface ErrStaffItem { /** * 座席邮箱地址 */ StaffEmail?: string; /** * 错误码 */ Code?: string; /** * 错误描述 */ Message?: string; } /** * PausePredictiveDialingCampaign返回参数结构体 */ export interface PausePredictiveDialingCampaignResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResumePredictiveDialingCampaign请求参数结构体 */ export interface ResumePredictiveDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务 ID */ CampaignId: number; } /** * PSTN 会话类型。 */ export interface PSTNSession { /** * 会话 ID */ SessionID?: string; /** * 会话临时房间 ID */ RoomID?: string; /** * 主叫 */ Caller?: string; /** * 被叫 */ Callee?: string; /** * 开始时间,Unix 时间戳 */ StartTimestamp?: number; /** * 振铃时间,Unix 时间戳 */ RingTimestamp?: number; /** * 接听时间,Unix 时间戳 */ AcceptTimestamp?: number; /** * 座席邮箱 */ StaffEmail?: string; /** * 座席工号 */ StaffNumber?: string; /** * 会话状态 ringing 振铃中 seatJoining 等待座席接听 inProgress 进行中 finished 已完成 */ SessionStatus?: string; /** * 会话呼叫方向, 0 呼入 | 1 - 呼出 */ Direction?: number; /** * 转外线使用的号码(转外线主叫) */ OutBoundCaller?: string; /** * 转外线被叫 */ OutBoundCallee?: string; /** * 主叫号码保护ID,开启号码保护映射功能时有效,且Caller字段置空 */ ProtectedCaller?: string; /** * 被叫号码保护ID,开启号码保护映射功能时有效,且Callee字段置空 */ ProtectedCallee?: string; } /** * http 回调包体参数 */ export interface HttpCallbackConfig { /** *

http 标准 url

*/ Url?: string; /** *

http header 参数

*/ HeaderParams?: Array; /** *

http 请求包参数

*/ Params?: Array; /** *

对端输出值,由对端 url 返回的 json 包里包含该字段就行

*/ Returns?: Array; /** *

是否异步

*/ Async?: boolean; /** *

是否鉴权

枚举值:

  • 0: 不开启鉴权
  • 1: 启用鉴权
*/ AuthType?: number; /** *

basic token 鉴权

*/ BasicAuth?: BasicAuth; /** *

bearer token 鉴权

*/ BearerAuth?: BearerAuth; /** *

自定义鉴权

*/ CustomAuth?: HttpParams; /** *

oauth2 鉴权

*/ Oauth2Auth?: OauthConfig; } /** * DescribeStaffInfoList请求参数结构体 */ export interface DescribeStaffInfoListRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

分页尺寸,上限 9999

*/ PageSize: number; /** *

分页页码,从 0 开始

*/ PageNumber: number; /** *

坐席账号,查询单个坐席时使用

*/ StaffMail?: string; /** *

查询修改时间大于等于ModifiedTime的坐席时使用

*/ ModifiedTime?: number; /** *

技能组ID

*/ SkillGroupId?: number; } /** * 自动外呼任务列表项 */ export interface AutoCalloutTaskInfo { /** * 任务名 */ Name?: string; /** * 被叫数量 */ CalleeCount?: number; /** * 主叫号码列表 */ Callers?: Array; /** * 起始时间戳 */ NotBefore?: number; /** * 结束时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ NotAfter?: number; /** * 任务使用的IvrId */ IvrId?: number; /** * 任务状态: 0初始:任务创建,呼叫未开始 1运行中 2 已完成:任务中所有呼叫完成 3结束中:任务到期,但仍有部分呼叫未结束 4已结束:任务到期终止 5已暂停:可恢复继续执行 */ State?: number; /** * 任务Id */ TaskId?: number; /** * 最大振铃时长,达到时长阈值自动挂断。 仅自携号码支持当前参数 */ MaxRingTimeoutSecond?: number; } /** * DescribeIvrAudioList请求参数结构体 */ export interface DescribeIvrAudioListRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分页尺寸,上限 50 */ PageSize: number; /** * 分页页码,从 0 开始 */ PageNumber: number; /** * 文件别名 */ CustomFileName?: Array; /** * 文件名 */ AudioFileName?: Array; /** * 文件ID */ FileId?: Array; } /** * PauseAutoCalloutTask返回参数结构体 */ export interface PauseAutoCalloutTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindNumberCallInInterface返回参数结构体 */ export interface BindNumberCallInInterfaceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ForceMemberOffline请求参数结构体 */ export interface ForceMemberOfflineRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 客服ID */ UserId: string; } /** * 接口调用的请求详情 */ export interface AICallAPICallRequestDetail { /** *

HTTP 请求方法,如 GET、POST。

*/ Method?: string; /** *

请求地址。

*/ URL?: string; /** *

请求参数(节点配置的入参与 URL query),json 序列化后的字符串,键升序排列。敏感值已脱敏,无参数时为空字符串。

*/ Params?: string; /** *

请求头,json 序列化后的字符串,键升序排列。敏感值已脱敏,无请求头时为空字符串。

*/ Headers?: string; /** *

请求体,超长时被截断,是否截断见 Truncated。

*/ Body?: string; /** *

请求体 Body 是否被截断。

*/ Truncated?: boolean; } /** * 技能组信息 */ export interface SkillGroupInfoItem { /** * 技能组ID */ SkillGroupId?: number; /** * 技能组名称 */ SkillGroupName?: string; /** * (废弃)类型:IM、TEL、ALL(全媒体) */ Type?: string; /** * 会话分配策略 */ RoutePolicy?: string; /** * 会话分配是否优先上次服务座席 */ UsingLastSeat?: number; /** * 单客服最大并发数(电话类型默认1) */ MaxConcurrency?: number; /** * 最后修改时间 */ LastModifyTimestamp?: number; /** * 技能组类型0-电话,1-在线,3-音频,4-视频 */ SkillGroupType?: number; /** * 技能组内线号码 */ Alias?: string; /** * 是否同振 */ RingAll?: boolean; } /** * UploadIvrAudio返回参数结构体 */ export interface UploadIvrAudioResponse { /** * 上传失败的文件列表 */ FailedFileList?: Array; /** * 上传成功文件列表 */ SuccessFileList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAIAgentCall请求参数结构体 */ export interface CreateAIAgentCallRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

AI智能体ID

*/ AIAgentId: number; /** *

被叫号码

*/ Callee: string; /** *

主叫号码列表

*/ Callers?: Array; /** *

提示词变量

* @deprecated */ PromptVariables?: Array; /** *

通用变量:

提示词变量

欢迎语变量

欢迎语延迟播放(秒级):welcome-message-delay

dify变量

  1. dify-inputs-xxx 为dify的inputs变量
  2. dify-inputs-user 为dify的user值
  3. dify-inputs-conversation_id 为dify的conversation_id值
*/ Variables?: Array; /** *

最大振铃时长,达到时长阈值自动挂断。 仅自携号码支持当前参数

*/ MaxRingTimeoutSecond?: number; /** *

智能体并发不足时,排队等待超时时间,单位秒

取值范围:[0, 5]

默认值:5

*/ AcquireTimeoutSecond?: number; } /** * UpdateCCCSkillGroup请求参数结构体 */ export interface UpdateCCCSkillGroupRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 技能组ID */ SkillGroupID: number; /** * 修改后的技能组名字 */ SkillGroupName?: string; /** * 修改后的最大并发数,同振最大为2 */ MaxConcurrency?: number; /** * true同振,false顺振 */ RingAll?: boolean; } /** * RestoreMemberOnline请求参数结构体 */ export interface RestoreMemberOnlineRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 客服ID */ UserId: string; } /** * 智能体的响应延时 */ export interface AICallLatencyMetrics { /** *

asr时延(毫秒)

-1 表示无 asr时延

*/ AsrLatency?: number; /** *

llm首token时延(毫秒)

*/ LLMFirstTokenLatency?: number; /** *

tts时延(毫秒)

-1 表示无 tts时延

*/ TTSLatency?: number; /** *

总时延

*/ TotalLatency?: number; } /** * 时间范围,24 小时制,格式为 09:00:00 */ export interface TimeRange { /** * 开始时间 */ StartTime?: string; /** * 结束时间 */ EndTime?: string; } /** * DescribeAICallInteractionRecords返回参数结构体 */ export interface DescribeAICallInteractionRecordsResponse { /** *

返回的会话交互结果

*/ InteractionEventList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 表示一轮对话中的用户和 AI 消息 */ export interface AIRoundMessage { /** *

消息的毫秒级时间戳

单位:ms

*/ Timestamp?: number; /** *

用户消息

*/ UserReply?: UserReplyEvent; /** *

智能体响应消息

*/ AISpeak?: AISpeakEvent; } /** * 创建 staff 的信息 item */ export interface SetStaffStatusItem { /** * 座席账号 */ StaffUserId: string; /** * 状态,free 示闲 notReady 示忙 rest 小休 */ Status: string; /** * 如果设置小休状态,这里是原因 */ Reason?: string; } /** * 智能体发言事件 */ export interface AISpeakEvent { /** *

本次话术是否允许被用户VAD打断

*/ CanBeInterrupted?: boolean; /** *

智能体播报的话术文本内容

*/ SpokenText?: string; /** *

智能体发言类型

枚举值:

  • Script: 智能体话术
  • KnowledgeBase: 知识库
  • LLMFallback: 大模型兜底
  • NoResponseTip: 无响应提示
  • SmartFollowUp: 智能追问
  • FAQ: FAQ
  • TransferWaitingPrompt: 转人工 - 排队等待音
  • PlayNoResponseEndPrompt: 无响应挂断前放音
  • PlayQueuePrompt: 转人工 - 排队前放音
  • PlayPromptBeforeReception: 转人工 - 接待前放音
  • PlayQueueTimeoutPrompt: 转人工 - 排队超时放音
  • PlayTransferFailPrompt: 转人工 - 转人工失败放音
  • Dtmf: DTMF收号(按键用户输入)
  • PlayDtmfPrompt: 按键节点 - 播放提示音
  • PlayInvalidDtmfPrompt: 按键节点 - 输入错误提示音
  • PlayDtmfTimeoutPrompt: 按键节点 - 超时提示音
  • TransferAgentPrompt: 转接智能体 - 转接至目标智能体提示音
  • Other: 其他类型
*/ SpokenType?: string; /** *

本次响应生成的时延结果

注意:此字段可能返回 null,表示取不到有效值。 */ LatencyMetrics?: AICallLatencyMetrics; /** *

用户回复命中的知识库问题标题,仅 SpokenType 为 KnowledgeBase 或 FAQ 等命中知识库的场景有值。

*/ KnowledgeName?: string; /** *

节点跳转的原因,仅画布为灵活模式时有值

*/ TraverseReason?: string; } /** * ModifyStaff返回参数结构体 */ export interface ModifyStaffResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyExtension请求参数结构体 */ export interface ModifyExtensionRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分机号 */ ExtensionId: string; /** * 分机名称 */ ExtensionName?: string; /** * 所属技能组列表 */ SkillGroupIds?: Array; /** * 绑定坐席邮箱账号 */ Relation?: string; } /** * CreatePredictiveDialingCampaign返回参数结构体 */ export interface CreatePredictiveDialingCampaignResponse { /** * 生成的任务 ID */ CampaignId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAIAnalysisResult返回参数结构体 */ export interface DescribeAIAnalysisResultResponse { /** * AI会话分析结果 */ ResultList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdatePredictiveDialingCampaign返回参数结构体 */ export interface UpdatePredictiveDialingCampaignResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyOwnNumberApply请求参数结构体 */ export interface ModifyOwnNumberApplyRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 线路相关参数 */ DetailList: Array; /** * 审批单号 */ ApplyId?: number; /** * 送号前缀 */ Prefix?: string; /** * 国内长途手机前缀码 */ MobileNddPrefix?: string; /** * 同市固话去掉区号 */ LocalNumberTrimAC?: boolean; /** * 被叫格式透传 (完成透传用户输入,不做处理) */ CalleeFormatPassthrough?: boolean; /** * 主叫格式透传 (完成透传用户输入,不做处理) */ CallerFormatPassthrough?: boolean; /** * 国际长途前缀码 */ InternationalNumberPrefix?: string; } /** * PSTN 会话信息 */ export interface PSTNSessionInfo { /** * 会话 ID */ SessionID?: string; /** * 会话临时房间 ID */ RoomID?: string; /** * 主叫 */ Caller?: string; /** * 被叫 */ Callee?: string; /** * 开始时间,Unix 时间戳 */ StartTimestamp?: string; /** * 接听时间,Unix 时间戳 */ AcceptTimestamp?: string; /** * 座席邮箱 */ StaffEmail?: string; /** * 座席工号 */ StaffNumber?: string; /** * 座席状态 inProgress 进行中 */ SessionStatus?: string; /** * 会话呼叫方向, 0 呼入 | 1 - 呼出 */ Direction?: number; /** * 振铃时间,Unix 时间戳 */ RingTimestamp?: number; /** * 主叫号码保护ID,开启号码保护映射功能时有效,且Caller字段置空 */ ProtectedCaller?: string; /** * 被叫号码保护ID,开启号码保护映射功能时有效,且Callee字段置空 */ ProtectedCallee?: string; } /** * 单条消息 */ export interface Message { /** * 消息类型 */ Type?: string; /** * 消息内容 */ Content?: string; } /** * DescribeFlashSMSList返回参数结构体 */ export interface DescribeFlashSMSListResponse { /** *

记录总数

*/ Total?: number; /** *

闪信记录列表

*/ FlashSMSList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AbortPredictiveDialingCampaign返回参数结构体 */ export interface AbortPredictiveDialingCampaignResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeIMCdrs返回参数结构体 */ export interface DescribeIMCdrsResponse { /** * 总记录数 */ TotalCount?: number; /** * 服务记录列表 * @deprecated */ IMCdrs?: Array; /** * 服务记录列表 注意:此字段可能返回 null,表示取不到有效值。 */ IMCdrList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNumbers请求参数结构体 */ export interface DescribeNumbersRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

页数,从0开始

*/ PageNumber?: number; /** *

分页大小,默认20

*/ PageSize?: number; } /** * 话机信息 */ export interface ExtensionInfo { /** * 实例ID */ SdkAppId?: number; /** * 分机全名 */ FullExtensionId?: string; /** * 分机号 */ ExtensionId?: string; /** * 所属技能组列表 */ SkillGroupId?: string; /** * 分机名称 */ ExtensionName?: string; /** * 创建时间 */ CreateTime?: number; /** * 最后修改时间 */ ModifyTime?: number; /** * 话机状态(0 离线、100 空闲、200忙碌) */ Status?: number; /** * 是否注册 */ Register?: boolean; /** * 绑定座席邮箱 */ Relation?: string; /** * 绑定座席名称 */ RelationName?: string; } /** * BindNumberCallOutSkillGroup请求参数结构体 */ export interface BindNumberCallOutSkillGroupRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 待绑定的号码 */ Number: string; /** * 待绑定的技能组Id列表 */ SkillGroupIds: Array; } /** * DeletePredictiveDialingCampaign返回参数结构体 */ export interface DeletePredictiveDialingCampaignResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 转接智能体配置 */ export interface TransferToAgentItem { /** *

转智能体的function calling 名称

*/ TransferToAgentName: string; /** *

转智能体描述

*/ TransferToAgentDesc: string; /** *

目标智能体ID

*/ TransferToAgentId: number; } /** * ivr 按键信息 */ export interface IVRKeyPressedElement { /** * 命中的关键字或者按键 */ Key?: string; /** * 按键关联的标签 */ Label?: string; /** * Unix 毫秒时间戳 */ Timestamp?: number; /** * 节点标签 */ NodeLabel?: string; /** * 用户原始输入 */ OriginalContent?: string; /** * TTS 提示音内容 */ TTSPrompt?: string; } /** * DescribeFlashSMSList请求参数结构体 */ export interface DescribeFlashSMSListRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

起始时间戳,Unix 秒级时间戳,最大支持近180天。

*/ StartTimestamp: number; /** *

结束时间戳,Unix 秒级时间戳,结束时间与开始时间的区间范围小于90天。

*/ EndTimestamp: number; /** *

闪信投递号码(被叫号码)

*/ DeliveryNumber?: string; /** *

呼叫关联的系统号码

*/ ServingNumber?: string; /** *

会话 ID

*/ SessionId?: string; /** *

投递结果 1 为成功,其他为失败

*/ DeliveryStatus?: number; /** *

分页大小,默认 20,最大 1000

取值范围:[20, 1000]

单位:条

默认值:20

*/ PageSize?: number; /** *

分页页码,从 0 开始

*/ PageNumber?: number; } /** * UnbindNumberCallOutSkillGroup返回参数结构体 */ export interface UnbindNumberCallOutSkillGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAILatency返回参数结构体 */ export interface DescribeAILatencyResponse { /** * 时延明细数据 -1表示无对应数据 */ AILatencyDetail?: Array; /** * 时延统计数据 -1表示无对应数据 */ AILatencyStatistics?: AILatencyStatistics; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdatePredictiveDialingCampaign请求参数结构体 */ export interface UpdatePredictiveDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 生成的任务 ID */ CampaignId: number; /** * 任务名称 */ Name: string; /** * 被叫列表,支持 E.164 或不带国家码形式的号码 */ Callees: Array; /** * 主叫列表,使用管理端展示的号码格式 */ Callers: Array; /** * 被叫呼叫顺序 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; /** * 自定义变量 */ Variables?: Array; /** * UUI */ UUI?: string; /** * 被叫属性 */ CalleeAttributes?: Array; } /** * DescribePSTNActiveSessionList请求参数结构体 */ export interface DescribePSTNActiveSessionListRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 数据偏移 */ Offset: number; /** * 返回的数据条数,最大 25 */ Limit: number; } /** * CreateAutoCalloutTask返回参数结构体 */ export interface CreateAutoCalloutTaskResponse { /** *

任务Id

*/ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAICallExtractResult返回参数结构体 */ export interface DescribeAICallExtractResultResponse { /** * 结果列表 */ ResultList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteCCCSkillGroup返回参数结构体 */ export interface DeleteCCCSkillGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 上传音频文件失败信息 */ export interface UploadIvrAudioFailedInfo { /** * 文件名 */ FileName?: string; /** * 失败原因 */ FailedMsg?: string; } /** * DescribeSessionDetail请求参数结构体 */ export interface DescribeSessionDetailRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

通话的 session id

*/ SessionId: string; /** *

起始时间戳,Unix 秒级时间戳,最大支持近180天。

*/ StartTimestamp: number; /** *

结束时间戳,Unix 秒级时间戳,结束时间与开始时间的区间范围小于90天。

*/ EndTimestamp: number; } /** * DescribePredictiveDialingSessions返回参数结构体 */ export interface DescribePredictiveDialingSessionsResponse { /** * 数据总量 */ TotalCount?: number; /** * 呼叫的 session id 列表,通过 https://cloud.tencent.com/document/product/679/47714 可以批量获取呼叫详细话单 */ SessionList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyExtension返回参数结构体 */ export interface ModifyExtensionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAICallInteractionRecords请求参数结构体 */ export interface DescribeAICallInteractionRecordsRequest { /** *

应用 ID,可以查看 https://console.cloud.tencent.com/ccc。

*/ SdkAppId: number; /** *

查询的会话SessionID

*/ SessionId: string; } /** * DescribeCompanyList返回参数结构体 */ export interface DescribeCompanyListResponse { /** * 总数 */ TotalCount?: number; /** * 企业资质审核信息 */ CompanyInfo?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 号码信息 */ export interface NumberInfo { /** *

号码

*/ Number?: string; /** *

绑定的外呼技能组

*/ CallOutSkillGroupIds?: Array; /** *

号码状态,1-正常,2-欠费停用,4-管理员停用,5-违规停用

*/ State?: number; /** *

是否自携号码

枚举值:

  • 0: 非自携
  • 1: 自携
*/ CostType?: number; } /** * DeleteStaff请求参数结构体 */ export interface DeleteStaffRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

待删除客服邮箱列表,一次最大支持200个。

*/ StaffList: Array; } /** * 呼入实时指标 */ export interface CallInMetrics { /** * IVR驻留数量 */ IvrCount?: number; /** * 排队中数量 */ QueueCount?: number; /** * 振铃中数量 */ RingCount?: number; /** * 接通中数量 */ AcceptCount?: number; /** * 客服转接外线中数量 */ TransferOuterCount?: number; /** * 最大排队时长 */ MaxQueueDuration?: number; /** * 平均排队时长 */ AvgQueueDuration?: number; /** * 最大振铃时长 */ MaxRingDuration?: number; /** * 平均振铃时长 */ AvgRingDuration?: number; /** * 最大接通时长 */ MaxAcceptDuration?: number; /** * 平均接通时长 */ AvgAcceptDuration?: number; } /** * DescribeCCCBuyInfoList请求参数结构体 */ export interface DescribeCCCBuyInfoListRequest { /** * 应用ID列表,不传时查询所有应用 */ SdkAppIds?: Array; } /** * 用户自带号码审批明细数据类型 */ export interface OwnNumberApplyDetailItem { /** * 号码类型:0-呼入|1-呼出|2-呼入呼出 */ CallType: number; /** * 线路号码 */ PhoneNumber: string; /** * 最大并发呼叫数 */ MaxCallCount: number; /** * 每秒最大并发数 */ MaxCallPSec: number; /** * 呼出被叫格式,使用 {+E.164} 或 {E.164}, */ OutboundCalleeFormat?: string; /** * 运营商号码 */ CarrierPhoneNumber?: string; } /** * DescribeIMCdrList返回参数结构体 */ export interface DescribeIMCdrListResponse { /** * 总记录数 */ TotalCount?: number; /** * 服务记录列表 */ IMCdrList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePredictiveDialingCampaigns返回参数结构体 */ export interface DescribePredictiveDialingCampaignsResponse { /** *

数据总量

*/ TotalCount?: number; /** *

数据

*/ CampaignList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTelCallInfo请求参数结构体 */ export interface DescribeTelCallInfoRequest { /** *

起始时间戳,Unix 时间戳(查询维度仅支持天,例如查询5月1日应该传startTime:"2023-05-01 00:00:00","endTime":"2023-05-01 23:59:59"的时间戳,查5月1日和5月2日的应该传startTime:"2023-05-01 00:00:00","endTime":"2023-05-02 23:59:59"的时间戳)

*/ StartTimeStamp: number; /** *

结束时间戳,Unix 时间戳,查询时间范围最大为90天(查询维度仅支持天,例如查询5月1日应该传startTime:"2023-05-01 00:00:00","endTime":"2023-05-01 23:59:59"的时间戳,查5月1日和5月2日的应该传startTime:"2023-05-01 00:00:00","endTime":"2023-05-02 23:59:59"的时间戳)

*/ EndTimeStamp: number; /** *

应用ID列表,多个ID时,返回值为多个ID使用总和

*/ SdkAppIdList: Array; } /** * 变量 */ export interface Variable { /** * 变量名 */ Key: string; /** * 变量值 */ Value: string; } /** * 呼入线路维度相关指标 */ export interface CallInNumberMetrics { /** * 线路号码 */ Number?: string; /** * 线路相关指标 */ Metrics?: CallInMetrics; /** * 所属技能组相关指标 */ SkillGroupMetrics?: Array; } /** * CreateExtension请求参数结构体 */ export interface CreateExtensionRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分机号 */ ExtensionId: string; /** * 分机名称 */ ExtensionName: string; /** * 绑定的技能组列表 */ SkillGroupIds?: Array; /** * 绑定的坐席邮箱 */ Relation?: string; } /** * 座席绑定技能组列表 */ export interface StaffSkillGroupList { /** * 技能组ID */ SkillGroupId: number; /** * 座席在技能组中的优先级(1为最高,5最低,默认3) */ Priority?: number; } /** * SetStaffStatus请求参数结构体 */ export interface SetStaffStatusRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 设置座席状态列表,最大个数 10 */ StaffStatusList: Array; } /** * ResetExtensionPassword返回参数结构体 */ export interface ResetExtensionPasswordResponse { /** * 重置后密码 */ Password?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 呼转目标 */ export interface ForwardingTarget { /** * 呼转目标类型 1 座席 2 技能组 3 分机 */ Type?: number; /** * 呼转目标为座席的账号 Type 为 1 时填写 */ StaffUserId?: string; /** * 呼转目标为技能组的 ID,Type 为 2 时填写 */ SkillGroupId?: number; /** * 呼转目标为分机的账号,Type 为 3 时填写 */ Extension?: string; } /** * CreateAutoCalloutTask请求参数结构体 */ export interface CreateAutoCalloutTaskRequest { /** *

应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc

*/ SdkAppId: number; /** *

任务起始时间戳,Unix 秒级时间戳

*/ NotBefore: number; /** *

被叫号码列表

*/ Callees: Array; /** *

主叫号码列表

*/ Callers: Array; /** *

呼叫使用的 IVR Id,不填时需要填写 AIAgentId

*/ IvrId?: number; /** *

任务名

*/ Name?: string; /** *

任务描述

*/ Description?: string; /** *

任务停止时间戳,Unix 秒级时间戳

*/ NotAfter?: number; /** *

最大尝试次数,1-3 次

*/ Tries?: number; /** *

自定义变量(仅高级版支持),CalleeAttributes 字段中使用相同变量会覆盖此处

*/ Variables?: Array; /** *

用户自定义数据,CalleeAttributes 字段中使用 UUI 会覆盖此处

*/ UUI?: string; /** *

被叫属性

*/ CalleeAttributes?: Array; /** *

IANA 时区名称,参考 https://datatracker.ietf.org/doc/html/draft-ietf-netmod-iana-timezones

*/ TimeZone?: string; /** *

可用时间段

*/ AvailableTime?: Array; /** *

智能体 ID,不填写时需要填写 IvrId

*/ AIAgentId?: number; /** *

任务失败重试时间间隔,重试间隔 600秒~86400 秒

*/ RetryInterval?: number; /** *

最大振铃时长,达到时长阈值自动挂断。 仅自携号码支持当前参数

*/ MaxRingTimeoutSecond?: number; /** *

根据限定的挂断原因(可选挂断状态码:202,203,204,205,206,207,208,210,212,213,215,216,217,218,219,221,222,234)进行重试,只对使用AIAgentID的任务有效,挂断状态码说明

详见

*/ RetryHangupTypes?: Array; /** *

根据限定的话后标签进行重试,只对使用对话模型的AIAgentID任务有效,标签信息可在智能体配置中查询

*/ RetryTags?: Array; /** *

生效的工作时间配置。建议使用此字段代替AvailableTime 字段,当同时使用时,优先生效AvailableTime。

*/ AvailableWorkTimeConfig?: Array; /** *

触发策略

*/ TriggerStrategy?: Array; /** *

智能体并发限制

*/ ConcurrencyLimit?: number; } /** * 自动外呼限定重呼标签 */ export interface RetryTagItem { /** *

标签名称

*/ TagName?: string; /** *

标签值

*/ TagValue?: string; } /** * AI时延明细 */ export interface AILatencyDetail { /** * 对话ID */ RoundId?: string; /** * asr时延(毫秒) */ ASRLatency?: number; /** * tts时延(毫秒) */ TTSLatency?: number; /** * llm时延(毫秒) */ LLMLatency?: number; /** * llm首token时延(毫秒) */ LLMFirstTokenLatency?: number; /** * 端到端时延(毫秒) */ ETELatency?: number; } /** * AI转人工配置项 */ export interface AITransferItem { /** * 转人工的function calling 名称 */ TransferFunctionName: string; /** * TransferFunctionEnable为true时生效;transfer_to_human function calling的desc,默认为 "Transfer to human when the user has to transfer to human (like says transfer to human) or you are instructed to do so." */ TransferFunctionDesc: string; /** * 转人工的技能组ID */ TransferSkillGroupId: number; } /** * 座席信息 */ export interface EventStaffElement { /** * 座席邮箱账号 */ Mail?: string; /** * 座席工号 */ StaffNumber?: string; } /** * AbortAgentCruiseDialingCampaign请求参数结构体 */ export interface AbortAgentCruiseDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务 ID */ CampaignId: number; } /** * ForceMemberOffline返回参数结构体 */ export interface ForceMemberOfflineResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateOwnNumberApply返回参数结构体 */ export interface CreateOwnNumberApplyResponse { /** * 审批单号 */ ApplyId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindNumberCallOutSkillGroup返回参数结构体 */ export interface BindNumberCallOutSkillGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * HangUpCall返回参数结构体 */ export interface HangUpCallResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TransferToManual返回参数结构体 */ export interface TransferToManualResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopAutoCalloutTask返回参数结构体 */ export interface StopAutoCalloutTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AbortPredictiveDialingCampaign请求参数结构体 */ export interface AbortPredictiveDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务 ID */ CampaignId: number; } /** * 承接语气词信息 */ export interface ToneWordInfo { /** * 首句超时时间,单位秒 */ FirstSentenceTimeout?: number; /** * 承接语气词 */ ZHToneWords?: ZHToneWordsInfo; } /** * 电话话单信息 */ export interface TelCdrInfo { /** *

主叫号码

*/ Caller?: string; /** *

被叫号码

*/ Callee?: string; /** *

呼叫发起时间戳,Unix 时间戳

*/ Time?: number; /** *

呼入呼出方向 0 呼入 1 呼出

*/ Direction?: number; /** *

通话类型 1 呼出 2 呼入 3 音频呼入 5 预测式外呼 6 内线呼叫

*/ CallType?: number; /** *

通话时长

*/ Duration?: number; /** *

录音信息

*/ RecordURL?: string; /** *

录音 ID

*/ RecordId?: string; /** *

座席信息

*/ SeatUser?: SeatUserInfo; /** *

EndStatus与EndStatusString一一对应,具体枚举如下:

场景 EndStatus EndStatusString 状态说明

电话呼入&呼出 1 ok 正常通话

电话呼入 102 ivrGiveUp IVR期间用户放弃

电话呼入 103 waitingGiveUp 排队时用户放弃

电话呼入 104 ringingGiveUp 振铃时用户放弃

电话呼入 105 noSeatOnline 无座席在线

电话呼入 106 notWorkTime 非工作时间

电话呼入 107 ivrEnd IVR全自动结束(无人工介入)

电话呼入 100 blackList 黑名单(系统侧)

电话呼出 108 restrictedCallee 全局外呼风险号码拦截(系统侧)

电话呼出 109 tooManyRequest 外呼频控拦截(系统侧)

电话呼出 110 restrictedArea 外呼地域拦截(系统侧)

电话呼出 111 restrictedTime 外呼时段拦截(系统侧)

电话呼出 202 notAnswer 被叫未接听

电话呼出 203 userReject 被叫拒接挂断

电话呼出 204 powerOff 被叫关机

电话呼出 205 numberNotExist 被叫空号

电话呼出 206 busy 被叫忙

电话呼出 207 outOfCredit 被叫欠费

电话呼出 208 operatorError 运营商线路异常

电话呼出 209 callerCancel 主叫取消

电话呼出 210 notInService 被叫不在服务区

电话呼入&呼出 211 clientError 座席客户端错误

电话呼出 212 carrierBlocked 运营商拦截

电话呼出 213 callReminder 提示来电提醒

电话呼出 215 numberInvalid 被叫号码无效

电话呼出 216 callRestricted 提示呼叫受限

电话呼出 217 calleeRestricted 被叫黑名单受限

电话呼出 218 areaRestricted 被叫区域受限

电话呼出 219 promptCallForwarding 提示呼叫转移

电话呼出 220 callerCancelWhileRing 振铃中主叫取消

电话呼出 221 callerCancelWithoutRing 未振铃被叫号码异常

电话呼出 222 voiceMailReached 语音信箱挂断

音频呼入 501 callConflict VoIP用户呼叫冲突终止

音频呼入 502 clientTimeout VoIP用户客户端超时

音频呼入 503 voipClientError VoIP用户客户端错误

中文详情参考

英文详情参考

*/ EndStatus?: number; /** *

技能组名称

*/ SkillGroup?: string; /** *

主叫归属地

*/ CallerLocation?: string; /** *

IVR 阶段耗时

*/ IVRDuration?: number; /** *

振铃时间戳,UNIX 秒级时间戳

*/ RingTimestamp?: number; /** *

接听时间戳,UNIX 秒级时间戳

*/ AcceptTimestamp?: number; /** *

结束时间戳,UNIX 秒级时间戳

*/ EndedTimestamp?: number; /** *

IVR 按键信息 ,e.g. ["1","2","3"]

* @deprecated */ IVRKeyPressed?: Array; /** *

IVR按键信息(e.g.xa0[{"Key":"1","Label":"非常满意"}])

*/ IVRKeyPressedEx?: Array; /** *

挂机方 seat 座席 user 用户 system 系统

*/ HungUpSide?: string; /** *

服务参与者列表

*/ ServeParticipants?: Array; /** *

技能组ID

*/ SkillGroupId?: number; /** *

参考 EndStatus 字段

*/ EndStatusString?: string; /** *

会话开始时间戳,UNIX 秒级时间戳

*/ StartTimestamp?: number; /** *

进入排队时间,Unix 秒级时间戳

*/ QueuedTimestamp?: number; /** *

后置IVR按键信息(e.g.xa0[{"Key":"1","Label":"非常满意"}])

* @deprecated */ PostIVRKeyPressed?: Array; /** *

满意度按键信息 Key 为 noInput 表示进入满意度但无按键

*/ PostIVRKeyPressedEx?: Array; /** *

排队技能组Id

*/ QueuedSkillGroupId?: number; /** *

会话 ID

*/ SessionId?: string; /** *

主叫号码保护ID,开启号码保护映射功能时有效,且Caller字段置空

*/ ProtectedCaller?: string; /** *

被叫号码保护ID,开启号码保护映射功能时有效,且Callee字段置空

*/ ProtectedCallee?: string; /** *

客户自定义数据(User-to-User Interface)

注意:此字段可能返回 null,表示取不到有效值。 * @deprecated */ Uui?: string; /** *

客户自定义数据(User-to-User Interface)

*/ UUI?: string; /** *

获取录音ASR文本信息地址

*/ AsrUrl?: string; /** *

AsrUrl的状态:Complete
已完成;
Processing
正在生成中;
NotExists
无记录(未开启生成离线asr或者无套餐包)

*/ AsrStatus?: string; /** *

录音转存第三方COS地址

*/ CustomRecordURL?: string; /** *

备注

*/ Remark?: string; /** *

排队技能组名称

*/ QueuedSkillGroupName?: string; /** *

通话中语音留言录音URL

*/ VoicemailRecordURL?: Array; /** *

通话中语音留言ASR文本信息地址

*/ VoicemailAsrURL?: Array; /** *

如果是智能体相关通话,这里是智能体 ID

*/ AIAgentId?: number; /** *

如果是智能体相关通话,这里是智能体名称

*/ AIAgentName?: string; /** *

接通后系统挂断原因,枚举类似

*/ SysHangupReason?: number; /** *

接通后系统挂断原因,文字描述信息

*/ SysHangupReasonString?: string; /** *

通话结束状态V2(灰度中)

*/ EndStatusV2?: number; } /** * 技能组信息 */ export interface SkillGroupItem { /** * 技能组ID */ SkillGroupId: number; /** * 技能组名称 */ SkillGroupName: string; /** * 优先级 */ Priority: number; /** * 类型:IM、TEL、ALL(全媒体) */ Type: string; } /** * 聊天消息 */ export interface MessageBody { /** * 消息时间戳 */ Timestamp?: number; /** * 发消息的用户ID */ From?: string; /** * 消息列表 */ Messages?: Array; } /** * 号码购买信息 */ export interface PhoneNumBuyInfo { /** * 电话号码 */ PhoneNum: string; /** * 号码类型,0-固话|1-虚商号码|2-运营商号码|3-400号码 */ Type: number; /** * 号码呼叫类型,1-呼入|2-呼出|3-呼入呼出 */ CallType: number; /** * 购买时间戳 */ BuyTime: number; /** * 截止时间戳 */ EndTime: number; /** * 号码状态,1正常|2欠费停用|4管理员停用|5违规停用 */ State: number; } /** * DescribeAIAnalysisResult请求参数结构体 */ export interface DescribeAIAnalysisResultRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 会话 ID */ SessionId: string; /** * 查找起始时间 */ StartTime: number; /** * 1737350008 */ EndTime: number; } /** * ModifyCompanyApply返回参数结构体 */ export interface ModifyCompanyApplyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCCCBuyInfoList返回参数结构体 */ export interface DescribeCCCBuyInfoListResponse { /** * 应用总数 */ TotalCount?: number; /** * 应用购买信息列表 */ SdkAppIdBuyList?: Array; /** * 套餐包购买信息列表 */ PackageBuyList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 生效运营商白名单号码 */ export interface ActiveCarrierPrivilegeNumber { /** * 实例Id */ SdkAppId?: number; /** * 主叫号码 */ Caller?: string; /** * 被叫号码 */ Callee?: string; /** * 生效unix时间戳(秒) */ CreateTime?: number; } /** * UnbindStaffSkillGroupList返回参数结构体 */ export interface UnbindStaffSkillGroupListResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResumeAutoCalloutTask请求参数结构体 */ export interface ResumeAutoCalloutTaskRequest { /** * 任务Id */ TaskId: number; /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; } /** * ControlAIConversation请求参数结构体 */ export interface ControlAIConversationRequest { /** * 会话 ID */ SessionId: string; /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 控制命令,目前支持命令如下: - ServerPushText,服务端发送文本给AI机器人,AI机器人会播报该文本 - InvokeLLM,服务端发送文本给大模型,触发对话 */ Command?: string; /** * 服务端发送播报文本命令,当Command为ServerPushText时必填 */ ServerPushText?: ServerPushText; /** * 服务端发送命令主动请求大模型,当Command为InvokeLLM时会把content请求到大模型,头部增加X-Invoke-LLM="1" */ InvokeLLM?: InvokeLLM; } /** * 上传音频文件信息 */ export interface UploadAudioInfo { /** * 文件别名(可重复) */ CustomFileName: string; /** * 音频文件链接。(支持mp3和wav格式,文件不超过5MB) */ AudioUrl: string; } /** * 公司资质审核状态信息 */ export interface CompanyStateInfo { /** * 申请单ID */ Id?: number; /** * 公司名称 */ CompanyName?: string; /** * 创建时间 */ CreateTime?: number; /** * 审核时间 */ CheckTime?: number; /** * 审核备注 */ CheckMsg?: string; /** * 审核状态,1-待审核,2-审核通过,3-驳回 */ State?: number; /** * 公司统一社会信用代码 */ BusinessId?: string; /** * 修改时间 */ ModifyTime?: number; /** * 合同编号 */ ContractNo?: string; } /** * DeleteExtension返回参数结构体 */ export interface DeleteExtensionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindStaffSkillGroupList请求参数结构体 */ export interface BindStaffSkillGroupListRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 座席邮箱 */ StaffEmail: string; /** * 绑定技能组列表(必填) */ StaffSkillGroupList: Array; /** * 绑定技能组列表 * @deprecated */ SkillGroupList?: Array; } /** * CreateAgentCruiseDialingCampaign返回参数结构体 */ export interface CreateAgentCruiseDialingCampaignResponse { /** * 生成的任务 ID */ CampaignId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyOwnNumberApply返回参数结构体 */ export interface ModifyOwnNumberApplyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 工作时间配置 */ export interface AvailableTimeConfig { /** *

日期类型,默认为每天

枚举值:

  • EveryDay: 每天
  • BusinessDay: 法定工作日
  • Holiday: 法定休息日
  • Custom: 自定义
*/ DayType?: string; /** *

仅在 DayType 为 Custom 时生效,指定适用的星期几

枚举值:

  • Monday: 星期一
  • Tuesday: 星期二
  • Wednesday: 星期三
  • Thursday: 星期四
  • Friday: 星期五
  • Saturday: 星期六
  • Sunday: 星期日
*/ DaysOfWeek?: Array; /** *

该日期类型下的时间段列表

*/ TimeRanges?: Array; } /** * DescribeCallInMetrics返回参数结构体 */ export interface DescribeCallInMetricsResponse { /** * 时间戳 */ Timestamp?: number; /** * 总体指标 */ TotalMetrics?: CallInMetrics; /** * 线路维度指标 */ NumberMetrics?: Array; /** * 技能组维度指标 */ SkillGroupMetrics?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyCompanyApply请求参数结构体 */ export interface ModifyCompanyApplyRequest { /** * 申请单ID(只能修改状态为“驳回”或者“待审核”的申请单) */ ApplyId: number; /** * 企业资质信息 */ CompanyInfo: CompanyApplyInfo; } /** * DescribeAgentCruiseDialingCampaign返回参数结构体 */ export interface DescribeAgentCruiseDialingCampaignResponse { /** * 任务名称 */ Name?: string; /** * 座席账号 */ Agent?: string; /** * 单轮并发呼叫量 1-20 */ ConcurrencyNumber?: number; /** * 任务启动时间,Unix 时间戳,到此时间后会自动启动任务 */ StartTime?: number; /** * 任务结束时间,Unix 时间戳,到此时间后会自动终止任务 */ EndTime?: number; /** * 被叫呼叫顺序 0 随机 1 顺序 */ CallOrder?: number; /** * 调用方自定义数据,最大长度 1024 */ UUI?: string; /** * 任务状态 0 未启动 1 运行中 2 已完成 3 已终止 */ State?: number; /** * 被叫总数 */ TotalCalleeCount?: number; /** * 已呼被叫数 */ CalledCalleeCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAICall返回参数结构体 */ export interface CreateAICallResponse { /** *

新创建的会话 ID

*/ SessionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCompanyList请求参数结构体 */ export interface DescribeCompanyListRequest { /** * 分页尺寸,上限 100 */ PageSize: number; /** * 分页页码,从 0 开始 */ PageNumber: number; /** * 公司名称 */ CompanyName?: Array; /** * 审核状态,1-待审核,2-审核通过,3-驳回 */ State?: Array; /** * 申请ID */ ApplyID?: Array; } /** * CreateIVRSession返回参数结构体 */ export interface CreateIVRSessionResponse { /** * 新创建的会话 ID */ SessionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * IM满意度 */ export interface IMSatisfaction { /** * 满意度值 */ Id?: number; /** * 满意度标签 */ Label?: string; } /** * DescribeActiveCarrierPrivilegeNumber返回参数结构体 */ export interface DescribeActiveCarrierPrivilegeNumberResponse { /** * 总数量 */ TotalCount?: number; /** * 生效列表 */ ActiveCarrierPrivilegeNumbers?: Array; /** * 待审核单号 */ PendingApplicantIds?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * HangUpCall请求参数结构体 */ export interface HangUpCallRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 会话ID */ SessionId: string; } /** * 座席登录的终端信息 */ export interface ClientInfo { /** * 登录的端类型,"Web"表示web工作台,"WeChatMiniProgram"表示微信小程序 */ ClientType?: string; /** * 当前登录的端是否在前台。若登录的端是Web,则该值为true;若登录的端是WeChatMiniProgram,true表示打开着微信小程序,false表示微信小程序退到后台 */ IsConnected?: boolean; } /** * DescribeTelCdr返回参数结构体 */ export interface DescribeTelCdrResponse { /** *

话单记录总数

*/ TotalCount?: number; /** *

话单记录

* @deprecated */ TelCdrs?: Array; /** *

话单记录

*/ TelCdrList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStaffStatusHistory返回参数结构体 */ export interface DescribeStaffStatusHistoryResponse { /** * 座席状态数据 */ Data?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStaffStatusMetrics请求参数结构体 */ export interface DescribeStaffStatusMetricsRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 筛选坐席列表,默认不传返回全部坐席信息 */ StaffList?: Array; /** * 筛选技能组ID列表 */ GroupIdList?: Array; /** * 筛选坐席状态列表 座席状态 free 示闲 | busy 忙碌 | rest 小休 | notReady 示忙 | afterCallWork 话后调整 | offline 离线 */ StatusList?: Array; } /** * DeleteStaff返回参数结构体 */ export interface DeleteStaffResponse { /** *

无法删除的状态为在线的客服列表

*/ OnlineStaffList?: Array; /** *

坐席删除详情

*/ DeleteStatusInfo?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 被叫属性 */ export interface CalleeAttribute { /** * 被叫号码 */ Callee: string; /** * 随路数据 */ UUI?: string; /** * 参数 */ Variables?: Array; } /** * 座席状态补充信息 */ export interface StaffStatusExtra { /** * im - 文本 | tel - 电话 | all - 全媒体 */ Type?: string; /** * in - 呼入 | out - 呼出 */ 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请求参数结构体 */ export interface CreateStaffRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 客服信息,个数不超过 10 */ Staffs: Array; /** * 是否发送密码邮件,默认true */ SendPassword?: boolean; } /** * CreateCompanyApply返回参数结构体 */ export interface CreateCompanyApplyResponse { /** * 申请单ID */ Id?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 应用购买信息 */ export interface SdkAppIdBuyInfo { /** * 应用ID */ SdkAppId?: number; /** * 应用名称 */ Name?: string; /** * 座席购买数(还在有效期内) */ StaffBuyNum?: number; /** * 座席购买列表 (还在有效期内) */ StaffBuyList?: Array; /** * 号码购买列表 */ PhoneNumBuyList?: Array; /** * 办公电话购买数(还在有效期内) */ SipBuyNum?: number; } /** * DescribePSTNActiveSessionList返回参数结构体 */ export interface DescribePSTNActiveSessionListResponse { /** * 列表总条数 */ Total?: number; /** * 列表内容 */ Sessions?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 座席事件相关详情 */ export interface EventStaffDetail { /** * 座席数据 */ Staffs?: Array; } /** * AI时延统计 */ export interface AILatencyStatistics { /** * asr时延统计 */ ASRLatency?: AILatencyStatisticsInfo; /** * tts时延统计 */ TTSLatency?: AILatencyStatisticsInfo; /** * llm时延统计 */ LLMLatency?: AILatencyStatisticsInfo; /** * 端到端时延统计 */ ETELatency?: AILatencyStatisticsInfo; } /** * 座席状态 */ export interface StaffStatus { /** * 查询使用的游标,分页场景使用 */ Cursor?: string; /** * 状态时间戳,Unix 秒级时间戳 */ Timestamp?: number; /** * 座席状态 free 示闲 | busy 忙碌 | rest 小休 | notReady 示忙 | afterCallWork 话后调整 | offline 离线 */ Status?: string; /** * 状态关联的会话 Id */ SessionId?: string; /** * 小休原因 */ Reason?: string; /** * 座席邮箱 */ StaffEmail?: string; /** * 座席工号 */ StaffNo?: string; } /** * DescribeIMCdrList请求参数结构体 */ export interface DescribeIMCdrListRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 起始时间(必填),Unix 秒级时间戳 */ StartTimestamp: number; /** * 结束时间(必填),Unix 秒级时间戳 */ EndTimestamp: number; /** * 返回记录条数,最大为100默认20 */ Limit?: number; /** * 返回记录偏移,默认为 0 */ Offset?: number; /** * 1为全媒体,2为文本客服,不填则查询全部 */ Type?: number; } /** * AI会话分析结果 */ export interface AIAnalysisResult { /** * summary: 会话小结 mood: 情绪分析 intention: 意向提取 */ Type?: string; /** * AI会话分析结果 */ Result?: string; } /** * DescribeAutoCalloutTasks请求参数结构体 */ export interface DescribeAutoCalloutTasksRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分页大小 */ PageSize: number; /** * 页数 */ PageNumber: number; } /** * PlaySoundCall请求参数结构体 */ export interface PlaySoundCallRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 会话ID */ SessionId: string; /** * 音频文件 ID,参见管理端-电话客服-放音文件管理 */ FileId?: number; /** * 放音次数,默认 1 次 */ PlayTimes?: number; } /** * DescribeChatMessages请求参数结构体 */ export interface DescribeChatMessagesRequest { /** * 应用 ID,可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 实例 ID(废弃) * @deprecated */ InstanceId?: number; /** * 服务记录ID(废弃) * @deprecated */ CdrId?: string; /** * 返回记录条数,最大为100 默认20 */ Limit?: number; /** * 返回记录偏移,默认为 0 */ Offset?: number; /** * 1为从早到晚,2为从晚到早,默认为2 */ Order?: number; /** * 服务记录 SessionID */ SessionId?: string; } /** * Oauth2鉴权 */ export interface OauthConfig { /** * */ TokenURL?: string; /** * */ ClientId?: string; /** * */ ClientSecret?: string; } /** * DescribeTelSession返回参数结构体 */ export interface DescribeTelSessionResponse { /** * 会话信息 */ Session?: PSTNSession; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 设置 staff 状态应答 item */ export interface SetStaffStatusRspItem { /** * 座席账号 */ StaffUserId?: string; /** * 错误码,参考协议整体错误码 */ ErrorCode?: string; /** * 错误信息 */ ErrorMessage?: string; /** * 当前状态 */ Status?: string; /** * 当前状态如果是小休,这里是原因 */ Reason?: string; /** * 之前状态 */ PreviousStatus?: string; /** * 之前状态如果是小休,这里是原因 */ PreviousReason?: string; } /** * http 请求包体 */ export interface HttpParams { /** * */ Key?: string; /** * */ Value?: string; /** * */ ValueType?: string; } /** * CreateAdminURL请求参数结构体 */ export interface CreateAdminURLRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 管理员账号 */ SeatUserId: string; } /** * DescribeAutoCalloutTask返回参数结构体 */ export interface DescribeAutoCalloutTaskResponse { /** * 任务名 */ Name?: string; /** * 任务描述 */ Description?: string; /** * 任务起始时间戳 */ NotBefore?: number; /** * 任务结束时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ NotAfter?: number; /** * 主叫列表 */ Callers?: Array; /** * 被叫信息列表 */ Callees?: Array; /** * 任务使用的IvrId */ IvrId?: number; /** * 任务状态 0初始 1运行中 2已完成 3结束中 4已终止 5已暂停 */ State?: number; /** * 最大振铃时长,达到时长阈值自动挂断。 仅自携号码支持当前参数 */ MaxRingTimeoutSecond?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStaffStatusMetrics返回参数结构体 */ export interface DescribeStaffStatusMetricsResponse { /** * 坐席状态实时信息 */ Metrics?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResumeAutoCalloutTask返回参数结构体 */ export interface ResumeAutoCalloutTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 音频文件审核信息 */ export interface AudioFileInfo { /** * 文件ID */ FileId?: number; /** * 文件别名 */ CustomFileName?: string; /** * 文件名 */ AudioFileName?: string; /** * 审核状态,0-未审核,1-审核通过,2-审核拒绝 */ Status?: number; } /** * DescribeCarrierPrivilegeNumberApplicants返回参数结构体 */ export interface DescribeCarrierPrivilegeNumberApplicantsResponse { /** * 筛选出的总申请单数量 */ TotalCount?: number; /** * 申请单列表 */ Applicants?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCallOutSession请求参数结构体 */ export interface CreateCallOutSessionRequest { /** * 应用 ID */ SdkAppId: number; /** * 座席邮箱,确保已经绑定了手机号 https://cloud.tencent.com/document/product/679/76067#.E6.AD.A5.E9.AA.A42.EF.BC.9A.E5.AE.8C.E5.96.84.E8.B4.A6.E5.8F.B7.E4.BF.A1.E6.81.AF */ UserId: string; /** * 被叫号码,须带 0086 前缀 */ Callee: string; /** * 主叫号码(废弃,使用Callers),须带 0086 前缀 */ Caller?: string; /** * 指定主叫号码列表,如果前面的号码失败了会自动换成下一个号码,须带 0086 前缀 */ Callers?: Array; /** * 是否强制使用手机外呼,当前只支持 true,若为 true 请确保已配置白名单 https://cloud.tencent.com/document/product/679/76744#.E6.93.8D.E4.BD.9C.E6.AD.A5.E9.AA.A4 */ IsForceUseMobile?: boolean; /** * 自定义数据,长度限制 1024 字节 * @deprecated */ Uui?: string; /** * 自定义数据,长度限制 1024 字节 */ UUI?: string; } /** * BindStaffSkillGroupList返回参数结构体 */ export interface BindStaffSkillGroupListResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTelRecordAsr返回参数结构体 */ export interface DescribeTelRecordAsrResponse { /** * 录音转文本信息 */ AsrDataList?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeExtensions请求参数结构体 */ export interface DescribeExtensionsRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分页页号(从0开始) */ PageNumber: number; /** * 筛选分机号列表 */ ExtensionIds?: Array; /** * 分页大小 */ PageSize?: number; /** * 模糊查询字段(模糊查询分机号、分机名称、坐席邮箱、坐席名称) */ FuzzingKeyWord?: string; /** * 是否需要返回话机当前状态 */ IsNeedStatus?: boolean; } /** * DescribeProtectedTelCdr请求参数结构体 */ export interface DescribeProtectedTelCdrRequest { /** * 起始时间戳,Unix 秒级时间戳 */ StartTimeStamp: number; /** * 结束时间戳,Unix 秒级时间戳 */ EndTimeStamp: number; /** * 应用 ID,可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分页尺寸,上限 100 */ PageSize: number; /** * 分页页码,从 0 开始 */ 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请求参数结构体 */ export interface CreateSDKLoginTokenRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 座席账号。 */ SeatUserId: string; /** * 生成的token是否一次性校验 */ OnlyOnce?: boolean; } /** * DescribeActiveCarrierPrivilegeNumber请求参数结构体 */ export interface DescribeActiveCarrierPrivilegeNumberRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 默认0 */ PageNumber?: number; /** * 默认10,最大100 */ PageSize?: number; /** * 筛选条件 Name支持PhoneNumber(按号码模糊查找) */ Filters?: Array; } /** * 座席购买信息 */ export interface StaffBuyInfo { /** * 购买座席数量 */ Num?: number; /** * 购买时间戳 */ BuyTime?: number; /** * 截止时间戳 */ EndTime?: number; /** * 购买办公电话数量 */ SipNum?: number; } /** * CreateOwnNumberApply请求参数结构体 */ export interface CreateOwnNumberApplyRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * SIP通道ID */ SipTrunkId: number; /** * 线路相关参数 */ DetailList: Array; /** * 送号前缀 */ Prefix?: string; /** * 国内长途手机前缀码 */ MobileNddPrefix?: string; /** * 同市固话去掉区号 */ LocalNumberTrimAC?: boolean; /** * 被叫格式透传 (完成透传用户输入,不做处理) */ CalleeFormatPassthrough?: boolean; /** * 主叫格式透传 (完成透传用户输入,不做处理) */ CallerFormatPassthrough?: boolean; /** * 国际长途前缀码 */ InternationalNumberPrefix?: string; } /** * DescribeCallInMetrics请求参数结构体 */ export interface DescribeCallInMetricsRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 是否返回技能组维度信息,默认“是” */ EnabledSkillGroup?: boolean; /** * 是否返回线路维度信息,默认“否” */ EnabledNumber?: boolean; /** * 筛选技能组列表 */ GroupIdList?: Array; } /** * DescribeExtension返回参数结构体 */ export interface DescribeExtensionResponse { /** * 分机号 */ ExtensionId?: string; /** * 域名 */ ExtensionDomain?: string; /** * 注册密码 */ Password?: string; /** * 代理服务器地址 */ OutboundProxy?: string; /** * 传输协议 */ Transport?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTelRecordAsr请求参数结构体 */ export interface DescribeTelRecordAsrRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 会话 ID */ SessionId: string; }