UNPKG

tencentcloud-sdk-nodejs

Version:
2,492 lines (2,465 loc) 119 kB
/** * DescribeExtension请求参数结构体 */ export interface DescribeExtensionRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分机号 */ ExtensionId: string; } /** * 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<string>; /** * 自定义变量 */ Variables?: Array<Variable>; /** * 用户数据 */ UUI?: string; } /** * 企业资质申请信息 */ 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<number | bigint>; /** * 是否开启手机外呼开关 */ UseMobileCallOut?: boolean; /** * 手机接听模式 0 - 关闭 | 1 - 仅离线 | 2 - 始终 */ UseMobileAccept?: number; /** * 座席分机号(1 到 8 打头,4 - 6 位) */ ExtensionNumber?: string; } /** * DescribeIvrAudioList返回参数结构体 */ export interface DescribeIvrAudioListResponse { /** * 总数 */ TotalCount?: number; /** * 文件信息 */ FileInfo?: Array<AudioFileInfo>; /** * 唯一请求 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; } /** * ResetExtensionPassword请求参数结构体 */ export interface ResetExtensionPasswordRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分机号 */ ExtensionId: string; } /** * DisableCCCPhoneNumber返回参数结构体 */ export interface DisableCCCPhoneNumberResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeProtectedTelCdr返回参数结构体 */ export interface DescribeProtectedTelCdrResponse { /** * 话单记录总数 */ TotalCount?: number; /** * 话单记录 * @deprecated */ TelCdrs?: Array<TelCdrInfo>; /** * 话单记录 */ TelCdrList?: Array<TelCdrInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAutoCalloutTask请求参数结构体 */ export interface DescribeAutoCalloutTaskRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务Id */ TaskId: 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密钥,获取鉴权信息方式请参见各模型官网 - OpenAI协议:[GPT](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key),[混元](https://cloud.tencent.com/document/product/1729/111008),[DeepSeek](https://api-docs.deepseek.com/zh-cn/); - Azure协议:[Azure GPT](https://learn.microsoft.com/en-us/azure/ai-services/openai/chatgpt-quickstart?tabs=command-line%2Ctypescript%2Cpython-new&pivots=programming-language-studio#key-settings); - Minimax:[Minimax](https://platform.minimaxi.com/document/Fast%20access?key=66701cf51d57f38758d581b2) */ 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<string>; /** * 用于设定AI座席欢迎语。 */ WelcomeMessage?: string; /** * 0:使用welcomeMessage(为空时,被叫先说话;不为空时,机器人先说话) 1: 使用ai根据prompt自动生成welcomeMessage并先说话 */ WelcomeType?: number; /** * 0: 默认可打断, 1:高优先不可打断 */ 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<string>; /** * 打断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<AITransferItem>; /** * 用户多久没说话提示时长,最小10秒,默认10秒 */ NotifyDuration?: number; /** * 用户NotifyDuration没说话,AI提示的语句,默认是"抱歉,我没听清。您可以重复下吗?" */ NotifyMessage?: string; /** * 最大触发AI提示音次数,默认为不限制 */ NotifyMaxCount?: number; /** * <p>和VoiceType字段需要选填一个,这里是使用自己自定义的TTS,VoiceType是系统内置的一些音色</p> <ul> <li>Tencent TTS<br> 配置请参考<a href="https://cloud.tencent.com/document/product/1073/92668#55924b56-1a73-4663-a7a1-a8dd82d6e823" target="_blank">腾讯云TTS文档链接</a></li> </ul> <div><div class="v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class"><pre class="v-md-prism-"><code>{ &quot;TTSType&quot;: &quot;tencent&quot;, // String TTS类型, 目前支持&quot;tencent&quot; 和 “minixmax”, 其他的厂商支持中 &quot;AppId&quot;: &quot;您的应用ID&quot;, // String 必填 &quot;SecretId&quot;: &quot;您的密钥ID&quot;, // String 必填 &quot;SecretKey&quot;: &quot;您的密钥Key&quot;, // String 必填 &quot;VoiceType&quot;: 101001, // Integer 必填,音色 ID,包括标准音色与精品音色,精品音色拟真度更高,价格不同于标准音色,请参见语音合成计费概述。完整的音色 ID 列表请参见语音合成音色列表。 &quot;Speed&quot;: 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等。 参数值与实际语速转换,可参考 语速转换 &quot;Volume&quot;: 5, // Integer 非必填,音量大小,范围:[0,10],分别对应11个等级的音量,默认值为0,代表正常音量。 &quot;PrimaryLanguage&quot;: 1, // Integer 可选 主要语言 1-中文(默认) 2-英文 3-日文 &quot;FastVoiceType&quot;: &quot;xxxx&quot; // 可选参数, 快速声音复刻的参数 } </code></pre> </div></div><ul> <li>Minimax TTS<br> 配置请参考<a href="https://platform.minimaxi.com/document/T2A%20V2?key=66719005a427f0c8a5701643" target="_blank">Minimax TTS文档链接</a>。注意Minimax TTS存在频率限制,超频可能会导致回答卡顿,<a href="https://platform.minimaxi.com/document/Rate%20limits?key=66b19417290299a26b234572" target="_blank">Minimax TTS频率限制相关文档链接</a>。</li> </ul> <div><div class="v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class"><pre class="v-md-prism-"><code>{ &quot;TTSType&quot;: &quot;minimax&quot;, // String TTS类型, &quot;Model&quot;: &quot;speech-01-turbo&quot;, &quot;APIUrl&quot;: &quot;https://api.minimax.chat/v1/t2a_v2&quot;, &quot;APIKey&quot;: &quot;eyxxxx&quot;, &quot;GroupId&quot;: &quot;181000000000000&quot;, &quot;VoiceType&quot;:&quot;female-tianmei-jingpin&quot;, &quot;Speed&quot;: 1.2 } </code></pre> </div></div><ul> <li>火山 TTS</li> </ul> <p>配置音色类型参考<a href="https://www.volcengine.com/docs/6561/162929" target="_blank">火山TTS文档链接</a><br> 语音合成音色列表–语音技术-火山引擎<br> 大模型语音合成音色列表–语音技术-火山引擎</p> <div><div class="v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class"><pre class="v-md-prism-"><code>{ &quot;TTSType&quot;: &quot;volcengine&quot;, // 必填:String TTS类型 &quot;AppId&quot; : &quot;xxxxxxxx&quot;, // 必填:String 火山引擎分配的Appid &quot;Token&quot; : &quot;TY9d4sQXHxxxxxxx&quot;, // 必填: String类型 火山引擎的访问token &quot;Speed&quot; : 1.0, // 可选参数 语速,默认为1.0 &quot;Volume&quot;: 1.0, // 可选参数, 音量大小, 默认为1.0 &quot;Cluster&quot; : &quot;volcano_tts&quot;, // 可选参数,业务集群, 默认是 volcano_tts &quot;VoiceType&quot; : &quot;zh_male_aojiaobazong_moon_bigtts&quot; // 音色类型, 默认为大模型语音合成的音色。 如果使用普通语音合成,则需要填写对应的音色类型。 音色类型填写错误会导致没有声音。 } </code></pre> </div></div><ul> <li>Azure TTS<br> 配置请参考<a href="https://docs.azure.cn/zh-cn/ai-services/speech-service/speech-synthesis-markup-voice" target="_blank">AzureTTS文档链接</a></li> </ul> <div><div class="v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class"><pre class="v-md-prism-"><code>{ &quot;TTSType&quot;: &quot;azure&quot;, // 必填:String TTS类型 &quot;SubscriptionKey&quot;: &quot;xxxxxxxx&quot;, // 必填:String 订阅的Key &quot;Region&quot;: &quot;chinanorth3&quot;, // 必填:String 订阅的地区 &quot;VoiceName&quot;: &quot;zh-CN-XiaoxiaoNeural&quot;, // 必填:String 音色名必填 &quot;Language&quot;: &quot;zh-CN&quot;, // 必填:String 合成的语言 &quot;Rate&quot;: 1 // 选填:float 语速 0.5~2 默认为 1 } </code></pre> </div></div><ul> <li>自定义</li> </ul> <p>TTS<br> 具体协议规范请参考<a href="https://doc.weixin.qq.com/doc/w3_ANQAiAbdAFwHILbJBmtSqSbV1WZ3L?scode=AJEAIQdfAAo5a1xajYANQAiAbdAFw" target="_blank">腾讯文档</a></p> <div><div class="v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class"><pre class="v-md-prism-"><code>{ &quot;TTSType&quot;: &quot;custom&quot;, // String 必填 &quot;APIKey&quot;: &quot;ApiKey&quot;, // String 必填 用来鉴权 &quot;APIUrl&quot;: &quot;http://0.0.0.0:8080/stream-audio&quot; // String,必填,TTS API URL &quot;AudioFormat&quot;: &quot;wav&quot;, // String, 非必填,期望输出的音频格式,如mp3, ogg_opus,pcm,wav,默认为 wav,目前只支持pcm和wav, &quot;SampleRate&quot;: 16000, // Integer,非必填,音频采样率,默认为16000(16k),推荐值为16000 &quot;AudioChannel&quot;: 1, // Integer,非必填,音频通道数,取值:1 或 2 默认为1 } </code></pre> </div></div> */ CustomTTSConfig?: string; /** * 提示词变量 */ PromptVariables?: Array<Variable>; /** * 语音识别vad的时间,范围为240-2000,默认为1000,单位为ms。更小的值会让语音识别分句更快。 */ VadSilenceTime?: number; /** * 通话内容提取配置 */ ExtractConfig?: Array<AICallExtractConfigElement>; /** * 模型温度控制 */ Temperature?: number; /** * 通用变量: <p>提示词变量</p> <p>欢迎语变量</p> <p> dify变量</p> 1. dify-inputs-xxx 为dify的inputs变量 2. dify-inputs-user 为dify的user值 3. dify-inputs-conversation_id 为dify的conversation_id值 */ Variables?: Array<Variable>; } /** * 带有技能组优先级的座席信息 */ export interface StaffInfo { /** * 座席名称 */ Name?: string; /** * 座席邮箱 */ Mail?: string; /** * 座席电话号码 */ Phone?: string; /** * 座席昵称 */ Nick?: string; /** * 座席工号 */ StaffNumber?: string; /** * 用户角色id 一个用户绑定了多个角色时以RoleIdList为准 * @deprecated */ RoleId?: number; /** * 用户角色id列表 */ RoleIdList?: number; /** * 所属技能组列表 */ SkillGroupList?: Array<SkillGroupItem>; /** * 最后修改时间 */ LastModifyTimestamp?: number; /** * 座席分机号(1 到 8 打头,4 - 6 位) */ ExtensionNumber?: string; } /** * 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; } /** * CreateCallOutSession返回参数结构体 */ export interface CreateCallOutSessionResponse { /** * 新创建的会话 ID */ SessionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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<Filter>; } /** * DisableCCCPhoneNumber请求参数结构体 */ export interface DisableCCCPhoneNumberRequest { /** * 号码列表,0086开头 */ PhoneNumbers: Array<string>; /** * 停用开关,0启用 1停用 */ Disabled: number; /** * TCCC 实例应用 ID */ SdkAppId?: number; } /** * ModifyStaffPassword返回参数结构体 */ export interface ModifyStaffPasswordResponse { /** * 唯一请求 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<string>; /** * 主叫列表,使用管理端展示的号码格式 */ Callers: Array<string>; /** * 被叫呼叫顺序 0 随机 1 顺序 */ CallOrder: number; /** * 使用的座席技能组 ID */ SkillGroupId: number; /** * 相同应用内多个任务运行优先级,从高到底 1 - 5 */ Priority: number; /** * 预期呼损率,百分比,5 - 50 */ ExpectedAbandonRate: number; /** * 呼叫重试间隔时间,单位秒,60 - 86400 */ RetryInterval: number; /** * 任务启动时间,Unix 时间戳,到此时间后会自动启动任务 */ StartTime: number; /** * 任务结束时间,Unix 时间戳,到此时间后会自动终止任务 */ EndTime: number; /** * 指定的 IVR Id */ IVRId?: number; /** * 呼叫重试次数,0 - 2 */ RetryTimes?: number; /** * 自定义变量 */ Variables?: Array<Variable>; /** * UUI */ UUI?: string; /** * 被叫属性 */ CalleeAttributes?: Array<CalleeAttribute>; /** * IANA 时区名称,参考 https://datatracker.ietf.org/doc/html/draft-ietf-netmod-iana-timezones */ TimeZone?: string; /** * 可用时间段 */ AvailableTime?: Array<TimeRange>; } /** * AbortAgentCruiseDialingCampaign返回参数结构体 */ export interface AbortAgentCruiseDialingCampaignResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCompanyApply返回参数结构体 */ export interface CreateCompanyApplyResponse { /** * 申请单ID */ Id?: 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; /** * 结束状态 */ EndStatusString?: string; /** * 录音 URL */ RecordURL?: string; /** * 参与者序号,从 0 开始 */ Sequence?: number; /** * 开始时间戳,Unix 秒级时间戳 */ StartTimestamp?: number; /** * 技能组名称 */ SkillGroupName?: string; /** * 录音转存第三方COS地址 */ CustomRecordURL?: 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; } /** * DescribeExtensions返回参数结构体 */ export interface DescribeExtensionsResponse { /** * 查询总数 */ Total?: number; /** * 话机信息列表 */ ExtensionList?: Array<ExtensionInfo>; /** * 唯一请求 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; } /** * 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; /** * 唯一请求 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<string>; /** * InfoType 为 Selector,需要配置此字段 */ Choices?: Array<string>; } /** * DescribeAutoCalloutTasks返回参数结构体 */ export interface DescribeAutoCalloutTasksResponse { /** * 总数 */ TotalCount?: number; /** * 任务列表 */ Tasks?: Array<AutoCalloutTaskInfo>; /** * 唯一请求 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(废弃) * @deprecated */ InstanceId?: number; /** * 返回数据条数,上限(废弃) */ Limit?: number; /** * 偏移(废弃) */ Offset?: number; /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId?: number; /** * 分页尺寸(必填),上限 100 */ PageSize?: number; /** * 分页页码(必填),从 0 开始 */ PageNumber?: number; /** * 按手机号筛选 */ Phones?: Array<string>; /** * 按SessionId筛选 */ SessionIds?: Array<string>; } /** * AI 通话结果具体信息 */ export interface AICallExtractResultInfo { /** * 提取的类型是文本 */ Text?: string; /** * 提取的内型是选项 */ Chosen?: Array<string>; /** * 提取类型是布尔值 */ Boolean?: boolean; /** * 提取类型是数字 */ Number?: number; } /** * 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<string>; /** * 主叫列表,使用管理端展示的号码格式 */ Callers?: Array<string>; /** * 被叫呼叫顺序 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<ErrStaffItem>; /** * 唯一请求 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; } /** * DescribeSkillGroupInfoList返回参数结构体 */ export interface DescribeSkillGroupInfoListResponse { /** * 技能组总数 */ TotalCount?: number; /** * 技能组信息列表 */ SkillGroupList?: Array<SkillGroupInfoItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNumbers返回参数结构体 */ export interface DescribeNumbersResponse { /** * 总数量 */ TotalCount?: number; /** * 号码列表 */ Numbers?: Array<NumberInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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<UploadAudioInfo>; } /** * DescribeStaffInfoList返回参数结构体 */ export interface DescribeStaffInfoListResponse { /** * 坐席用户总数 */ TotalCount?: number; /** * 坐席用户信息列表 */ StaffList?: Array<StaffInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UnbindNumberCallOutSkillGroup请求参数结构体 */ export interface UnbindNumberCallOutSkillGroupRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 待解绑的号码 */ Number: string; /** * 待解绑的技能组Id列表 */ SkillGroupIds: Array<number | bigint>; } /** * CreateAutoCalloutTask请求参数结构体 */ export interface CreateAutoCalloutTaskRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 任务起始时间戳,Unix 秒级时间戳 */ NotBefore: number; /** * 被叫号码列表 */ Callees: Array<string>; /** * 主叫号码列表 */ Callers: Array<string>; /** * 呼叫使用的 IVR Id,不填时需要填写 AIAgentId */ IvrId?: number; /** * 任务名 */ Name?: string; /** * 任务描述 */ Description?: string; /** * 任务停止时间戳,Unix 秒级时间戳 */ NotAfter?: number; /** * 最大尝试次数,1-3 次 */ Tries?: number; /** * 自定义变量(仅高级版支持) */ Variables?: Array<Variable>; /** * UUI */ UUI?: string; /** * 被叫属性 */ CalleeAttributes?: Array<CalleeAttribute>; /** * IANA 时区名称,参考 https://datatracker.ietf.org/doc/html/draft-ietf-netmod-iana-timezones */ TimeZone?: string; /** * 可用时间段 */ AvailableTime?: Array<TimeRange>; /** * 智能体 ID,不填写时需要填写 IvrId */ AIAgentId?: number; } /** * ResumePredictiveDialingCampaign返回参数结构体 */ export interface ResumePredictiveDialingCampaignResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 呼入技能组相关指标 */ 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,该值必须与 ClientData 字段中 Uid 的值一致 */ Uid: string; /** * 有效期,单位秒,不超过 1 小时 */ ExpiredTime: number; /** * 用户签名数据,必填字段,为标准 JSON 格式 */ ClientData?: string; } /** * 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; } /** * DescribePredictiveDialingSessions返回参数结构体 */ export interface DescribePredictiveDialingSessionsResponse { /** * 数据总量 */ TotalCount?: number; /** * 呼叫的 session id 列表,通过 https://cloud.tencent.com/document/product/679/47714 可以批量获取呼叫详细话单 */ SessionList?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAutoCalloutTask返回参数结构体 */ export interface DescribeAutoCalloutTaskResponse { /** * 任务名 */ Name?: string; /** * 任务描述 */ Description?: string; /** * 任务起始时间戳 */ NotBefore?: number; /** * 任务结束时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ NotAfter?: number; /** * 主叫列表 */ Callers?: Array<string>; /** * 被叫信息列表 */ Callees?: Array<AutoCalloutTaskCalleeInfo>; /** * 任务使用的IvrId */ IvrId?: number; /** * 任务状态 0初始 1运行中 2已完成 3结束中 4已终止 */ State?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCompanyApply请求参数结构体 */ export interface CreateCompanyApplyRequest { /** * 企业资质信息 */ CompanyInfo: CompanyApplyInfo; } /** * CreateCCCSkillGroup返回参数结构体 */ export interface CreateCCCSkillGroupResponse { /** * 技能组ID */ SkillGroupId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * 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 AutoCalloutTaskCalleeInfo { /** * 被叫号码 */ Callee: string; /** * 呼叫状态 0初始 1已接听 2未接听 3呼叫中 4待重试 */ State: number; /** * 会话ID列表 */ Sessions: Array<string>; } /** * 座席用户信息 */ export interface SeatUserInfo { /** * 座席名称 */ Name: string; /** * 座席邮箱 */ Mail: string; /** * 工号 */ StaffNumber: string; /** * 座席电话号码(带0086前缀) */ Phone?: string; /** * 座席昵称 */ Nick?: string; /** * 用户ID */ UserId?: string; /** * 座席关联的技能组列表 */ SkillGroupNameList?: Array<string>; /** * 1:管理员 2:质检员 3:普通座席 else:自定义角色ID */ Role?: number; /** * 座席分机号(1 到 8 打头,4 - 6 位) */ ExtensionNumber?: string; } /** * UpdateCCCSkillGroup返回参数结构体 */ export interface UpdateCCCSkillGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 语音转文本信息 */ 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<string>; /** * 被叫号码列表 */ Callees?: Array<string>; /** * 描述 */ 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; } /** * 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; } /** * UpdatePredictiveDialingCampaign请求参数结构体 */ export interface UpdatePredictiveDialingCampaignRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 生成的任务 ID */ CampaignId: number; /** * 任务名称 */ Name: string; /** * 被叫列表,支持 E.164 或不带国家码形式的号码 */ Callees: Array<string>; /** * 主叫列表,使用管理端展示的号码格式 */ Callers: Array<string>; /** * 被叫呼叫顺序 0 随机 1 顺序 */ CallOrder: number; /** * 使用的座席技能组 ID */ SkillGroupId: number; /** * 相同应用内多个任务运行优先级,从高到底 1 - 5 */ Priority: number; /** * 预期呼损率,百分比,5 - 50 */ ExpectedAbandonRate: number; /** * 呼叫重试间隔时间,单位秒,60 - 86400 */ RetryInterval: number; /** * 任务启动时间,Unix 时间戳,到此时间后会自动启动任务 */ StartTime: number; /** * 任务结束时间,Unix 时间戳,到此时间后会自动终止任务 */ EndTime: number; /** * 指定的 IVR ID */ IVRId?: number; /** * 呼叫重试次数,0 - 2 */ RetryTimes?: number; /** * 自定义变量 */ Variables?: Array<Variable>; /** * UUI */ UUI?: string; /** * 被叫属性 */ CalleeAttributes?: Array<CalleeAttribute>; } /** * 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<string>; /** * 起始时间戳 */ NotBefore?: number; /** * 结束时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ NotAfter?: number; /** * 任务使用的IvrId */ IvrId?: number; /** * 任务状态: 0初始:任务创建,呼叫未开始 1运行中 2 已完成:任务中所有呼叫完成 3结束中:任务到期,但仍有部分呼叫未结束 4已结束:任务到期终止 */ State?: number; /** * 任务Id */ TaskId?: number; } /** * DescribeIvrAudioList请求参数结构体 */ export interface DescribeIvrAudioListRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 分页尺寸,上限 50 */ PageSize: number; /** * 分页页码,从 0 开始 */ PageNumber: number; /** * 文件别名 */ CustomFileName?: Array<string>; /** * 文件名 */ AudioFileName?: Array<string>; /** * 文件ID */ FileId?: Array<number | bigint>; } /** * 技能组信息 */ 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; } /** * CreateAIAgentCall请求参数结构体 */ export interface CreateAIAgentCallRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * AI智能体ID */ AIAgentId: number; /** * 被叫号码 */ Callee: string; /** * 主叫号码列表 */ Callers?: Array<string>; /** * 提示词变量 */ PromptVariables?: Array<Variable>; /** * 通用变量: <p>提示词变量</p> <p>欢迎语变量</p> <p> dify变量</p> 1. dify-inputs-xxx 为dify的inputs变量 2. dify-inputs-user 为dify的user值 3. dify-inputs-conversation_id 为dify的conversation_id值 */ Variables?: Array<Variable>; } /** * 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; } /** * 时间范围,24 小时制,格式为 09:00:00 */ export interface TimeRange { /** * 开始时间 */ StartTime?: string; /** * 结束时间 */ EndTime?: string; } /** * ModifyStaffPassword请求参数结构体 */ export interface ModifyStaffPasswordRequest { /** * 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc */ SdkAppId: number; /** * 座席邮箱 */ Email: string; /** * 设置的密码 */ Password: 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<number | bigint>; /** * 绑定坐席邮箱账号 */ Relation?: string; } /** * CreatePredictiveDialingCampaign返回参数结构体 */ export interface CreatePredictiveDialingCampaignResponse { /** * 生成的任务 ID */ CampaignId?: number; /** * 唯一请求 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<OwnNumberApplyDetailItem>; /** * 审批单号 */ ApplyId?: number; /** * 送号前缀 */ Prefix?: string; } /** * PSTN 会话信息 */ export interface PSTNSessionInfo { /** * 会话 ID */ SessionID?: string; /** * 会话临时房间 ID */ RoomID?: string; /** * 主叫 */ Caller?: string; /** * 被叫 */ Callee?: string; /** * 开始时间,Unix 时间戳 */ StartTimestamp?: string; /** * 接听时间,Unix 时间戳 */ Accep