{ "name": "ccc", "display_name": "云联络中心", "description": "介绍如何使用API对腾讯云联络中心进行操作，包括拉取会话记录、管理坐席信息和管理联络中心参数等。", "domain": "other", "api_version": "2020-02-10", "endpoint": "ccc.tencentcloudapi.com", "actions": [ { "name": "AbortAgentCruiseDialingCampaign", "description": "停止座席巡航式外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "任务 ID", "example": "2569" } ], "required": [ "SdkAppId", "CampaignId" ] }, { "name": "AbortPredictiveDialingCampaign", "description": "停止预测式外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "任务 ID", "example": "2569" } ], "required": [ "SdkAppId", "CampaignId" ] }, { "name": "BindNumberCallInInterface", "description": "绑定号码呼入回调接口", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Number", "type": "string", "required": true, "description": "待绑定的号码", "example": "\"0086075512345678\"" }, { "name": "CallInInterface", "type": "object", "required": false, "description": "待绑定的回调地址", "example": "无", "children": [ { "name": "URL", "type": "string", "required": true, "description": "接口地址", "example": "https://cloud.tencent.com/" } ] }, { "name": "NumberType", "type": "string", "required": false, "description": "绑定号码类型: inner: 内线号码 | number: 正常线路号码", "example": "number" } ], "required": [ "SdkAppId", "Number" ] }, { "name": "BindNumberCallOutSkillGroup", "description": "绑定号码外呼技能组", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Number", "type": "string", "required": true, "description": "待绑定的号码", "example": "\"0086075512345678\"" }, { "name": "SkillGroupIds", "type": "array", "required": true, "description": "待绑定的技能组Id列表", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "SdkAppId", "Number", "SkillGroupIds" ] }, { "name": "BindStaffSkillGroupList", "description": "绑定座席所属技能组", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "StaffEmail", "type": "string", "required": true, "description": "座席邮箱", "example": "staff1@xx.com" }, { "name": "StaffSkillGroupList", "type": "array", "required": true, "description": "绑定技能组列表(必填)", "example": "[{\"SkillGroupId\":100,\"Priority\":1},{\"SkillGroupId\":200,\"Priority\":2}]", "item_type": "object", "children": [ { "name": "SkillGroupId", "type": "integer", "required": true, "description": "技能组ID", "example": "2134" }, { "name": "Priority", "type": "integer", "required": false, "description": "座席在技能组中的优先级（1为最高，5最低，默认3）", "example": "1" } ] } ], "required": [ "SdkAppId", "StaffEmail", "StaffSkillGroupList" ] }, { "name": "ControlAIConversation", "description": "提供服务端控制机器人的功能", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "会话 ID", "example": "7cb26a84-83b2-42d8-a19b-7dae78e9b78e" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Command", "type": "string", "required": false, "description": "控制命令，目前支持命令如下： - ServerPushText，服务端发送文本给AI机器人，AI机器人会播报该文本 - InvokeLLM，服务端发送文本给大模型，触发对话", "example": "ServerPushText" }, { "name": "ServerPushText", "type": "object", "required": false, "description": "服务端发送播报文本命令，当Command为ServerPushText时必填", "example": "无", "children": [ { "name": "Text", "type": "string", "required": false, "description": "服务端推送播报文本", "example": "无" }, { "name": "Interrupt", "type": "boolean", "required": false, "description": "是否允许该文本打断机器人说话", "example": "无" }, { "name": "StopAfterPlay", "type": "boolean", "required": false, "description": "播报完文本后，是否自动关闭对话任务", "example": "无" }, { "name": "Audio", "type": "string", "required": false, "description": "服务端推送播报音频 格式说明：音频必须为单声道，采样率必须跟对应TTS的采样率保持一致，编码为Base64字符串。 输入规则：当提供Audio字段时，将不接受Text字段的输入。系统将直接播放Audio字段中的音频内容。", "example": "无" }, { "name": "DropMode", "type": "integer", "required": false, "description": "默认为0，仅在Interrupt为false时有效 - 0表示当前有交互发生时，会丢弃Interrupt为false的消息 - 1表示当前有交互发生时，不会丢弃Interrupt为false的消息，而是缓存下来，等待当前交互结束后，再去处理 注意：DropMode为1时，允许缓存多个消息，如果后续出现了打断，缓存的消息会被清空", "example": "0" }, { "name": "Priority", "type": "integer", "required": false, "description": "ServerPushText消息的优先级，0表示可被打断，1表示不会被打断。 注意：在接收到Priority=1的消息后，后续其他任何消息都会被忽略（包括Priority=1的消息），直到Priority=1的消息处理结束。该字段可与Interrupt、DropMode字段配合使用。 例子： - Priority=1、Interrupt=true，会打断现有交互，立刻播报，播报过程中不会被打断 - Priority=1、Interrupt=false、DropMode=1，会等待当前交互结束，再进行播\ufffd...", "example": "0" }, { "name": "AddHistory", "type": "boolean", "required": false, "description": "是否将文本加入到llm历史上下文中", "example": "true" } ] }, { "name": "InvokeLLM", "type": "object", "required": false, "description": "服务端发送命令主动请求大模型,当Command为InvokeLLM时会把content请求到大模型,头部增加X-Invoke-LLM=\"1\"", "example": "无", "children": [ { "name": "Content", "type": "string", "required": false, "description": "请求LLM的内容", "example": "今天天气怎么样" }, { "name": "Interrupt", "type": "boolean", "required": false, "description": "是否允许该文本打断机器人说话", "example": "false" } ] } ], "required": [ "SessionId", "SdkAppId" ] }, { "name": "CreateAIAgentCall", "description": "用于创建**一次性的智能体外呼通话**。你可以在管理端-智能体管理中，新建语音智能体，进行 [对话流程配置](https://cloud.tencent.com/document/product/679/119796) 。该接口可调用配置完成的智能体发起单次的外呼任务。若需创建批量智能体外呼任务，请参考文档 [创建自动外呼任务](https://cloud.tencent.com/document/product/679/69194)。 该功能需购买语音智能体通话套餐，并且仅限自有电话号码使...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "AIAgentId", "type": "integer", "required": true, "description": "AI智能体ID", "example": "1" }, { "name": "Callee", "type": "string", "required": true, "description": "被叫号码", "example": "008613012345678" }, { "name": "Callers", "type": "array", "required": false, "description": "主叫号码列表", "example": "[\"008601012341234\", \"008601012341235\"]", "item_type": "string" }, { "name": "Variables", "type": "array", "required": false, "description": "通用变量： 提示词变量 欢迎语变量 欢迎语延迟播放(秒级)：welcome-message-delay dify变量 1. dify-inputs-xxx 为dify的inputs变量 2. dify-inputs-user 为dify的user值 3. dify-inputs-conversation_id 为dify的conversation_id值", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] }, { "name": "MaxRingTimeoutSecond", "type": "integer", "required": false, "description": "最大振铃时长，达到时长阈值自动挂断。 仅自携号码支持当前参数", "example": "15" } ], "required": [ "SdkAppId", "AIAgentId", "Callee" ] }, { "name": "CreateAICall", "description": "用于 **直接调用AI模型** 发起 **单次** 外呼通话，支持通过API参数直接配置模型、提示词、语音等全部通话要素。 该功能需购买语音智能体通话套餐，并且仅限自有电话号码使用。详情请参考 [语音智能体通话购买指引](https://cloud.tencent.com/document/product/679/125953)。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Callee", "type": "string", "required": true, "description": "被叫号码", "example": "0086xxx" }, { "name": "LLMType", "type": "string", "required": true, "description": "模型接口协议类型，目前兼容四种协议类型： - OpenAI协议(包括GPT、混元、DeepSeek等)：\"openai\" - Azure协议：\"azure\" - Minimax协议：\"minimax\" - Dify协议: \"dify\"", "example": "openai" }, { "name": "APIKey", "type": "string", "required": true, "description": "模型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\u0026pivots=programming-language-studio#key-settings)； - Minima...", "example": "sk-proj-xxxx" }, { "name": "APIUrl", "type": "string", "required": true, "description": "模型接口地址 - 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\"", "example": "https://api.openai.com/v1/" }, { "name": "SystemPrompt", "type": "string", "required": false, "description": "用于设定AI人设、说话规则、任务等的全局提示词。示例：## 人设您是人民医院友善、和蔼的随访医生李医生，正在给患者小明的家长打电话，原因是医院要求小明2024-08-08回院复查手术恢复情况，但小明没有来。您需要按照任务流程对小明家长进行电话随访调查。## 要求简洁回复：使用简练语言，每次最多询问一个问题，不要在一个回复中询问多个问题。富有变化：尽量使表\ufffd\ufffd...", "example": "示例值请看上方描述" }, { "name": "Model", "type": "string", "required": false, "description": "模型名称，如 - OpenAI协议 \"gpt-4o-mini\",\"gpt-4o\"，\"hunyuan-standard\", \"hunyuan-turbo\"，\"deepseek-chat\"； - Azure协议 \"gpt-4o-mini\", \"gpt-4o\"； - Minmax协议 \"deepseek-chat\".", "example": "gpt-4o-mini" }, { "name": "VoiceType", "type": "string", "required": false, "description": "默认提供以下音色参数值可选择，如需自定义音色VoiceType请留空并在参数CustomTTSConfig中配置 汉语： ZhiMei：智美，客服女声 ZhiXi： 智希 通用女声 ZhiQi：智琪 客服女声 ZhiTian：智甜 女童声 AiXiaoJing：爱小静 对话女声 英语: WeRose：英文女声 Monika：英文女声 日语： Nanami 韩语： SunHi 印度尼西亚语(印度尼西亚)： Gadis 马来语（马来西亚）: Yasmin 泰米尔语（马来西亚）: Kani 泰语（泰国...", "example": "ZhiQi" }, { "name": "Callers", "type": "array", "required": false, "description": "主叫号码列表", "example": "[\"string\"]", "item_type": "string" }, { "name": "WelcomeMessage", "type": "string", "required": false, "description": "用于设定AI座席欢迎语。", "example": "您好" }, { "name": "WelcomeType", "type": "integer", "required": false, "description": "0：使用welcomeMessage(为空时，被叫先说话；不为空时，机器人先说话) 1: 使用ai根据prompt自动生成welcomeMessage并先说话", "example": "0" }, { "name": "WelcomeMessagePriority", "type": "integer", "required": false, "description": "0: 默认可打断， 2：高优先不可打断", "example": "0" }, { "name": "MaxDuration", "type": "integer", "required": false, "description": "最大等待时长(毫秒)，默认60秒，超过这个时间用户没说话，自动挂断", "example": "60000" }, { "name": "Languages", "type": "array", "required": false, "description": "语音识别支持的语言, 默认是\"zh\" 中文, 填写数组,最长4个语言，第一个语言为主要识别语言，后面为可选语言， 注意:主要语言为中国方言时，可选语言无效 目前全量支持的语言如下，等号左面是语言英文名，右面是Language字段需要填写的值，该值遵循ISO639： 1. Chinese = \"zh\" # 中文 2. Chinese_TW = \"zh-TW\" # 中国台湾 3. Chinese_DIALECT = \"zh-dialect\" # 中国方言 4. English = \"en\" # 英语 5. Vietnamese = \"...", "example": "[\"zh\",\"en\"]", "item_type": "string" }, { "name": "InterruptMode", "type": "integer", "required": false, "description": "打断AI说话模式，默认为0，0表示自动打断，1表示不打断。", "example": "1" }, { "name": "InterruptSpeechDuration", "type": "integer", "required": false, "description": "InterruptMode为0时使用，单位为毫秒，默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断。", "example": "500" }, { "name": "EndFunctionEnable", "type": "boolean", "required": false, "description": "模型是否支持(或者开启)call_end function calling", "example": "true" }, { "name": "EndFunctionDesc", "type": "string", "required": false, "description": "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.\"", "example": "在用户不想继续通话或者展现出不开心的情绪时挂断通话" }, { "name": "TransferFunctionEnable", "type": "boolean", "required": false, "description": "模型是否支持(或者开启)transfer_to_human function calling", "example": "true" }, { "name": "TransferItems", "type": "array", "required": false, "description": "TransferFunctionEnable为true的时候生效: 转人工配置", "example": "无", "item_type": "object", "children": [ { "name": "TransferFunctionName", "type": "string", "required": true, "description": "转人工的function calling 名称", "example": "transfer_to_human" }, { "name": "TransferFunctionDesc", "type": "string", "required": true, "description": "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.\"", "example": "当客户表达出需要人工服务，或者机器人无法处理问题时，转人工" }, { "name": "TransferSkillGroupId", "type": "integer", "required": true, "description": "转人工的技能组ID", "example": "1" } ] }, { "name": "NotifyDuration", "type": "integer", "required": false, "description": "用户多久没说话提示时长,最小10秒,默认10秒", "example": "10000" }, { "name": "NotifyMessage", "type": "string", "required": false, "description": "用户NotifyDuration没说话，AI提示的语句，默认是\"抱歉，我没听清。您可以重复下吗？\"", "example": "抱歉，我没听清。您可以重复下吗？" }, { "name": "NotifyMaxCount", "type": "integer", "required": false, "description": "最大触发AI提示音次数，默认为不限制", "example": "1" }, { "name": "CustomTTSConfig", "type": "string", "required": false, "description": "和VoiceType字段需要选填一个，这里是使用自己自定义的TTS，VoiceType是系统内置的一些音色 Tencent TTS 配置请参考腾讯云TTS文档链接 { \u0026quot;TTSType\u0026quot;: \u0026quot;tencent\u0026quot;, // String TTS类型, 目前支持\u0026quot;tencent\u0026quot; 和 “minixmax”， 其他的厂商支持中   \u0026quot;AppId\u0026quot;: \u0026quot;您的应用ID\u0026quot;, // String 必填   \u0026quot;SecretId\u0026quot;: \u0026quot;您的密钥ID\u0026quot;, // String 必填   \u0026quot;SecretKey\u0026quot;: \u0026quot;您的密钥Ke...", "example": "{ \"TTSType\": \"azure\", \"SubscriptionKey\": \"xx\", \"Region\": \"chinanorth3\", \"VoiceName\": \"zh-CN-\", \"Language\": \"zh-CN\", \"Rate\": 1 }" }, { "name": "VadSilenceTime", "type": "integer", "required": false, "description": "语音识别vad的时间，范围为240-2000，默认为1000，单位为ms。更小的值会让语音识别分句更快。", "example": "500" }, { "name": "ExtractConfig", "type": "array", "required": false, "description": "通话内容提取配置", "example": "无", "item_type": "object", "children": [ { "name": "InfoType", "type": "string", "required": true, "description": "配置项类型，包括 Text 文本 Selector 选项 Boolean 布尔值 Number 数字", "example": "Number" }, { "name": "InfoName", "type": "string", "required": true, "description": "配置项名称，不可重复", "example": "姓名" }, { "name": "InfoContent", "type": "string", "required": false, "description": "配置项具体内容", "example": "客户姓名" }, { "name": "Examples", "type": "array", "required": false, "description": "配置项提取内容示例", "example": "[\"张三\"]", "item_type": "string" }, { "name": "Choices", "type": "array", "required": false, "description": "InfoType 为 Selector，需要配置此字段", "example": "[\"动力\",\"内饰\",\"价格\"]", "item_type": "string" } ] }, { "name": "Temperature", "type": "float", "required": false, "description": "模型温度控制", "example": "0.1" }, { "name": "Variables", "type": "array", "required": false, "description": "通用变量： 提示词变量 欢迎语变量 欢迎语延迟播放(秒级)：welcome-message-delay dify变量 1. dify-inputs-xxx 为dify的inputs变量 2. dify-inputs-user 为dify的user值 3. dify-inputs-conversation_id 为dify的conversation_id值", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] }, { "name": "TopP", "type": "float", "required": false, "description": "模型topP", "example": "0.8" }, { "name": "VadLevel", "type": "integer", "required": false, "description": "vad的远场人声抑制能力（不会对asr识别效果造成影响），范围为[0, 3]，默认为0。推荐设置为2，有较好的远场人声抑制能力。", "example": "1" }, { "name": "ToneWord", "type": "object", "required": false, "description": "衔接语", "example": "无", "children": [ { "name": "FirstSentenceTimeout", "type": "float", "required": false, "description": "首句超时时间，单位秒", "example": "0.4" }, { "name": "ZHToneWords", "type": "object", "required": false, "description": "承接语气词", "example": "{\"Positive\":[\"真不错\",\"挺好的\"],\"Negative\":[\"好悲催\",\"太差劲了\"],\"Neutral\":[\"嘿嘿\",\"差不多\"]}", "children": [ { "name": "Neutral", "type": "array", "required": false, "description": "中性词列表", "example": "[\"嗯嗯\"]", "item_type": "string" }, { "name": "Positive", "type": "array", "required": false, "description": "正面词列表", "example": "[\"嗯嗯\"]", "item_type": "string" }, { "name": "Negative", "type": "array", "required": false, "description": "负面词列表", "example": "[\"嗯嗯\"]", "item_type": "string" } ] } ] }, { "name": "EnableComplianceAudio", "type": "boolean", "required": false, "description": "合规提示音， 该参数传true（默认）表示通话开始播放摩斯码，提示对话内容为 AI 生成。 该参数传false表示关闭合规提示音。该参数传false则代表您知晓并同意以下协议： 我方充分知悉和理解，根据[《网络安全法》](https://www.cac.gov.cn/2016-11/07/c_1119867116.htm)[《互联网信息服务深度合成管理规定》](https://www.gov.cn/zhengce/zhengceku/2022-12/12/content_5731431.htm)[《生成式人工智能服务管理暂\ufffd\ufffd...", "example": "false" }, { "name": "EnableVoicemailDetection", "type": "boolean", "required": false, "description": "是否开启语音信箱识别", "example": "true" }, { "name": "VoicemailAction", "type": "integer", "required": false, "description": "识别到对端为语音信箱时的行为，当EnableVoicemailDetection为True时生效 0: 挂断电话（默认）", "example": "0" }, { "name": "LLMExtraBody", "type": "string", "required": false, "description": "大模型拓展参数， 格式为json字符串", "example": "\"{}\"" }, { "name": "MaxCallDurationMs", "type": "integer", "required": false, "description": "最大通话时长， 默认不限制。单位毫秒(ms)", "example": "600000" }, { "name": "MaxRingTimeoutSecond", "type": "integer", "required": false, "description": "最大振铃时长，达到时长阈值自动挂断。 **仅自携号码支持当前参数**", "example": "15" }, { "name": "AmbientSoundType", "type": "string", "required": false, "description": "环境音场景，没有的话不填。 coffee_shops：咖啡店氛围，背景中有人聊天 busy_office：客服中心", "example": "coffee_shops" }, { "name": "AmbientSoundVolume", "type": "float", "required": false, "description": "环境音音量。如果AmbientSoundType 为空，该字段不填。取值的范围是 [0,2]。值越低，环境音越小；值越高，环境音越响亮。如果未设置，则使用默认值 1。", "example": "1" } ], "required": [ "SdkAppId", "Callee", "LLMType", "APIKey", "APIUrl" ] }, { "name": "CreateAdminURL", "description": "创建管理端访问链接", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SeatUserId", "type": "string", "required": true, "description": "管理员账号", "example": "foo@tencent.com" } ], "required": [ "SdkAppId", "SeatUserId" ] }, { "name": "CreateAgentCruiseDialingCampaign", "description": "座席巡航式外呼。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Name", "type": "string", "required": true, "description": "任务名称", "example": "新能源SUV推荐" }, { "name": "Agent", "type": "string", "required": true, "description": "座席账号", "example": "foo@tencent.com" }, { "name": "ConcurrencyNumber", "type": "integer", "required": true, "description": "单轮并发呼叫量 1-20", "example": "3" }, { "name": "StartTime", "type": "integer", "required": true, "description": "任务启动时间，Unix 时间戳，到此时间后会自动启动任务", "example": "1708483433" }, { "name": "EndTime", "type": "integer", "required": true, "description": "任务结束时间，Unix 时间戳，到此时间后会自动终止任务", "example": "1708485433" }, { "name": "Callees", "type": "array", "required": false, "description": "被叫列表，支持 E.164 或不带国家码形式的号码", "example": "+8613012345678", "item_type": "string" }, { "name": "Callers", "type": "array", "required": false, "description": "主叫列表，使用管理端展示的号码格式", "example": "0086075586013388", "item_type": "string" }, { "name": "CallOrder", "type": "integer", "required": false, "description": "被叫呼叫顺序 0 随机 1 顺序", "example": "0" }, { "name": "UUI", "type": "string", "required": false, "description": "调用方自定义数据，最大长度 1024", "example": "foobar" } ], "required": [ "SdkAppId", "Name", "Agent", "ConcurrencyNumber", "StartTime", "EndTime" ] }, { "name": "CreateAutoCalloutTask", "description": "用于**创建批量自动外呼通话**，系统将根据任务配置，自动向指定的**被叫号码列表**发起外呼通话。该接口可调用配置完成的智能体发起批量的外呼任务，你可以在管理端-智能体管理中，新建语音智能体，进行 [对话流程配置](https://cloud.tencent.com/document/product/679/119796)。若需创建单次智能体外呼任务，请参考文档 [创建单次智能体通话](https://cloud.tencent.com/document/product/679/115681)...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "NotBefore", "type": "integer", "required": true, "description": "任务起始时间戳，Unix 秒级时间戳", "example": "1642500621" }, { "name": "Callees", "type": "array", "required": true, "description": "被叫号码列表", "example": "[\"0086139xxxxxxxx\",\"0086130xxxxxxxxx\"]", "item_type": "string" }, { "name": "Callers", "type": "array", "required": true, "description": "主叫号码列表", "example": "[\"0086010xxxxxxxx\"]", "item_type": "string" }, { "name": "IvrId", "type": "integer", "required": false, "description": "呼叫使用的 IVR Id，不填时需要填写 AIAgentId", "example": "3" }, { "name": "Name", "type": "string", "required": false, "description": "任务名", "example": "任务1" }, { "name": "Description", "type": "string", "required": false, "description": "任务描述", "example": "任务描述1" }, { "name": "NotAfter", "type": "integer", "required": false, "description": "任务停止时间戳，Unix 秒级时间戳", "example": "1642500622" }, { "name": "Tries", "type": "integer", "required": false, "description": "最大尝试次数，1-3 次", "example": "1" }, { "name": "Variables", "type": "array", "required": false, "description": "自定义变量（仅高级版支持），CalleeAttributes 字段中使用相同变量会覆盖此处", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] }, { "name": "UUI", "type": "string", "required": false, "description": "用户自定义数据，CalleeAttributes 字段中使用 UUI 会覆盖此处", "example": "foobar" }, { "name": "CalleeAttributes", "type": "array", "required": false, "description": "被叫属性", "example": "无", "item_type": "object", "children": [ { "name": "Callee", "type": "string", "required": true, "description": "被叫号码", "example": "0086130xxxxxxxx" }, { "name": "UUI", "type": "string", "required": false, "description": "随路数据", "example": "foobar" }, { "name": "Variables", "type": "array", "required": false, "description": "参数", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] } ] }, { "name": "TimeZone", "type": "string", "required": false, "description": "IANA 时区名称，参考 https://datatracker.ietf.org/doc/html/draft-ietf-netmod-iana-timezones", "example": "Asia/Shanghai" }, { "name": "AvailableTime", "type": "array", "required": false, "description": "可用时间段", "example": "无", "item_type": "object", "children": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "09:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "14:00:00" } ] }, { "name": "AIAgentId", "type": "integer", "required": false, "description": "智能体 ID，不填写时需要填写 IvrId", "example": "5845" }, { "name": "RetryInterval", "type": "integer", "required": false, "description": "任务失败重试时间间隔，重试间隔 600秒～86400 秒", "example": "600" }, { "name": "MaxRingTimeoutSecond", "type": "integer", "required": false, "description": "最大振铃时长，达到时长阈值自动挂断。 仅自携号码支持当前参数", "example": "15" } ], "required": [ "SdkAppId", "NotBefore", "Callees", "Callers" ] }, { "name": "CreateCCCSkillGroup", "description": "新建技能组", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SkillGroupName", "type": "string", "required": true, "description": "技能组名称", "example": "foobar技能组" }, { "name": "SkillGroupType", "type": "integer", "required": true, "description": "技能组类型0-电话，1-在线，3-音频，4-视频", "example": "0" }, { "name": "MaxConcurrency", "type": "integer", "required": false, "description": "技能组接待人数上限（该技能组中1个座席可接待的人数上限）默认为1。1、若技能组类型为在线，则接待上限可设置为1及以上 2、若技能组类型为电话、音频、视频，则接待上线必须只能为1", "example": "1" } ], "required": [ "SdkAppId", "SkillGroupName", "SkillGroupType" ] }, { "name": "CreateCallOutSession", "description": "创建外呼会话，当前仅支持双呼，即先使用平台号码呼出到座席手机上，座席接听后，然后再外呼用户，而且由于运营商频率限制，座席手机号必须先加白名单，避免频控导致外呼失败。所以调用此接口前，下述操作均已完成 1. UserId 指定的座席已经[绑定手机号](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) 2. 座席绑定\ufffd...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID", "example": "14000000000" }, { "name": "UserId", "type": "string", "required": true, "description": "座席邮箱，确保已经绑定了手机号 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", "example": "foo@tencent.com" }, { "name": "Callee", "type": "string", "required": true, "description": "被叫号码，须带 0086 前缀", "example": "008613012345678" }, { "name": "Caller", "type": "string", "required": false, "description": "主叫号码（废弃，使用Callers），须带 0086 前缀", "example": "008610086" }, { "name": "Callers", "type": "array", "required": false, "description": "指定主叫号码列表，如果前面的号码失败了会自动换成下一个号码，须带 0086 前缀", "example": "[\"0086075512345678\",\"0086075512345679\"]", "item_type": "string" }, { "name": "IsForceUseMobile", "type": "boolean", "required": false, "description": "是否强制使用手机外呼，当前只支持 true，若为 true 请确保已配置白名单 https://cloud.tencent.com/document/product/679/76744#.E6.93.8D.E4.BD.9C.E6.AD.A5.E9.AA.A4", "example": "true" }, { "name": "UUI", "type": "string", "required": false, "description": "自定义数据，长度限制 1024 字节", "example": "dGhpcyBpcyBhIGV4YW1wbGU" } ], "required": [ "SdkAppId", "UserId", "Callee" ] }, { "name": "CreateCarrierPrivilegeNumberApplicant", "description": "用于无限频率地呼叫坐席手机", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "140000000" }, { "name": "Callers", "type": "array", "required": true, "description": "主叫号码，必须为实例中存在的号码，格式为0086xxxx（暂时只支持国内号码）", "example": "[\"008601012345678\"]", "item_type": "string" }, { "name": "Callees", "type": "array", "required": true, "description": "被叫号码，必须为实例中坐席绑定的手机号码，格式为0086xxxx（暂时只支持国内号码）", "example": "[\"008618612345678\"]", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "foobar" } ], "required": [ "SdkAppId", "Callers", "Callees" ] }, { "name": "CreateCompanyApply", "description": "创建公司资质申请（1、首次使用接口，建议先在云联络中心控制台查看各个资料模板:https://console.cloud.tencent.com/ccc/enterprise/update。2、参数中图片Url建议使用腾讯云Cos存储的临时链接）", "status": "online", "parameters": [ { "name": "CompanyInfo", "type": "object", "required": true, "description": "企业资质信息", "example": "无", "children": [ { "name": "ApplicantType", "type": "integer", "required": true, "description": "申请人身份，0-公司法定代表人，1-经办人（受法定代表人委托）", "example": "1" }, { "name": "CompanyName", "type": "string", "required": true, "description": "企业名称", "example": "北京XXCC有限责任公司" }, { "name": "BusinessId", "type": "string", "required": true, "description": "统一社会信用代码", "example": "91411111111111111" }, { "name": "BusinessIdPicUrl", "type": "string", "required": true, "description": "营业执照扫描件(加盖公章)。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "CorporationName", "type": "string", "required": true, "description": "法定代表人名称", "example": "王某某" }, { "name": "CorporationId", "type": "string", "required": true, "description": "法定代表人身份证号码", "example": "610000000000008" }, { "name": "CorporationIdPicUrl", "type": "string", "required": true, "description": "法定代表人身份证正反面扫描件。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "NetworkCommitmentPicUrl", "type": "string", "required": true, "description": "安全合规使用承诺书。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "IsEqualTencentCloud", "type": "integer", "required": true, "description": "是否与腾讯云账号的资质一致,0-不一致,1-一致", "example": "1" }, { "name": "CorporationMobile", "type": "string", "required": true, "description": "法定代表人手机号", "example": "18011111111" }, { "name": "CorporationMobilePicUrl", "type": "string", "required": true, "description": "法定代表人手机号码实名认证。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "UseDescribeFileUrl", "type": "string", "required": true, "description": "通话话术。(支持doc、docx格式的文档不超过50MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "CompanyAuthLetterPicUrl", "type": "string", "required": true, "description": "公司授权函。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "AcceptPicUrl", "type": "string", "required": true, "description": "电话受理单。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "CorporationHoldingOnIdPicUrl", "type": "string", "required": false, "description": "法定代表人手持身份证照，申请人类型为法定代表人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "OperatorName", "type": "string", "required": false, "description": "经办人名称，申请人类型为经办人时必填。", "example": "李某某" }, { "name": "OperatorId", "type": "string", "required": false, "description": "经办人证件号码，申请人类型为经办人时必填。", "example": "61011111111111111" }, { "name": "OperatorIdPicUrl", "type": "string", "required": false, "description": "经办人身份证正反面扫描件，申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "OperatorHoldingOnIdPicUrl", "type": "string", "required": false, "description": "经办人手持身份证照，申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "CommissionPicUrl", "type": "string", "required": false, "description": "委托授权书，申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "OperatorMobile", "type": "string", "required": false, "description": "经办人手机号，申请人类型为经办人时必填。", "example": "18022222222" }, { "name": "OperatorEmail", "type": "string", "required": false, "description": "经办人邮箱，申请人类型为经办人时必填。", "example": "111@qq.com" }, { "name": "OperatorMobilePicUrl", "type": "string", "required": false, "description": "经办人手机号码实名认证，申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" } ] } ], "required": [ "CompanyInfo" ] }, { "name": "CreateExtension", "description": "创建话机账号", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "ExtensionId", "type": "string", "required": true, "description": "分机号", "example": "1001" }, { "name": "ExtensionName", "type": "string", "required": true, "description": "分机名称", "example": "分机1" }, { "name": "SkillGroupIds", "type": "array", "required": false, "description": "绑定的技能组列表", "example": "[1,2,3,4,5]", "item_type": "integer" }, { "name": "Relation", "type": "string", "required": false, "description": "绑定的坐席邮箱", "example": "aaa@bbb.com" } ], "required": [ "SdkAppId", "ExtensionId", "ExtensionName" ] }, { "name": "CreateIVRSession", "description": "创建关联 IVR 的会话，仅高级版支持，目前支持呼入和自动外呼两种 IVR 类型。收到请求后 TCCC 会先尝试呼通被叫，然后进入 IVR 流程。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Callee", "type": "string", "required": true, "description": "被叫", "example": "+8613012345678" }, { "name": "IVRId", "type": "integer", "required": true, "description": "指定的 IVR Id，目前支持呼入和自动外呼两种类型", "example": "4600" }, { "name": "Callers", "type": "array", "required": false, "description": "主叫号码列表", "example": "[\"008602155066897\"]", "item_type": "string" }, { "name": "Variables", "type": "array", "required": false, "description": "自定义变量", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] }, { "name": "UUI", "type": "string", "required": false, "description": "用户数据", "example": "foobar" }, { "name": "MaxRingTimeoutSecond", "type": "integer", "required": false, "description": "最大振铃时长，达到时长阈值自动挂断。 仅自携号码支持当前参数", "example": "15" } ], "required": [ "SdkAppId", "Callee", "IVRId" ] }, { "name": "CreateOwnNumberApply", "description": "创建客户自携号码接入审核", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SipTrunkId", "type": "integer", "required": true, "description": "SIP通道ID", "example": "1" }, { "name": "DetailList", "type": "array", "required": true, "description": "线路相关参数", "example": "无", "item_type": "object", "children": [ { "name": "CallType", "type": "integer", "required": true, "description": "号码类型：0-呼入|1-呼出|2-呼入呼出", "example": "2" }, { "name": "PhoneNumber", "type": "string", "required": true, "description": "线路号码", "example": "02066660000" }, { "name": "MaxCallCount", "type": "integer", "required": true, "description": "最大并发呼叫数", "example": "1" }, { "name": "MaxCallPSec", "type": "integer", "required": true, "description": "每秒最大并发数", "example": "1" }, { "name": "OutboundCalleeFormat", "type": "string", "required": false, "description": "呼出被叫格式，使用 {+E.164} 或 {E.164},", "example": "{+E.164}" }, { "name": "CarrierPhoneNumber", "type": "string", "required": false, "description": "运营商号码", "example": "66660000" } ] }, { "name": "Prefix", "type": "string", "required": false, "description": "送号前缀", "example": "0" }, { "name": "MobileNddPrefix", "type": "string", "required": false, "description": "国内长途手机前缀码", "example": "0" }, { "name": "LocalNumberTrimAC", "type": "boolean", "required": false, "description": "同市固话去掉区号", "example": "false" } ], "required": [ "SdkAppId", "SipTrunkId", "DetailList" ] }, { "name": "CreatePredictiveDialingCampaign", "description": "创建预测式外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Name", "type": "string", "required": true, "description": "任务名称", "example": "新能源SUV推荐" }, { "name": "Callees", "type": "array", "required": true, "description": "被叫列表，支持 E.164 或不带国家码形式的号码", "example": "[\"+8613012345678\"]", "item_type": "string" }, { "name": "Callers", "type": "array", "required": true, "description": "主叫列表，使用管理端展示的号码格式", "example": "[\"0086075586013388\"]", "item_type": "string" }, { "name": "CallOrder", "type": "integer", "required": true, "description": "被叫呼叫顺序 0 随机 1 顺序", "example": "0" }, { "name": "SkillGroupId", "type": "integer", "required": true, "description": "使用的座席技能组 ID", "example": "255" }, { "name": "Priority", "type": "integer", "required": true, "description": "相同应用内多个任务运行优先级，从高到底 1 - 5", "example": "3" }, { "name": "ExpectedAbandonRate", "type": "integer", "required": true, "description": "预期呼损率，百分比，0 - 50", "example": "10" }, { "name": "RetryInterval", "type": "integer", "required": true, "description": "呼叫重试间隔时间，单位秒，60 - 86400", "example": "1800" }, { "name": "StartTime", "type": "integer", "required": true, "description": "任务启动时间，Unix 时间戳，到此时间后会自动启动任务", "example": "1708483433" }, { "name": "EndTime", "type": "integer", "required": true, "description": "任务结束时间，Unix 时间戳，到此时间后会自动终止任务", "example": "1708485433" }, { "name": "IVRId", "type": "integer", "required": false, "description": "指定的 IVR Id", "example": "4600" }, { "name": "RetryTimes", "type": "integer", "required": false, "description": "呼叫重试次数，0 - 2", "example": "2" }, { "name": "Variables", "type": "array", "required": false, "description": "自定义变量", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] }, { "name": "UUI", "type": "string", "required": false, "description": "UUI", "example": "foobar" }, { "name": "CalleeAttributes", "type": "array", "required": false, "description": "被叫属性", "example": "无", "item_type": "object", "children": [ { "name": "Callee", "type": "string", "required": true, "description": "被叫号码", "example": "0086130xxxxxxxx" }, { "name": "UUI", "type": "string", "required": false, "description": "随路数据", "example": "foobar" }, { "name": "Variables", "type": "array", "required": false, "description": "参数", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] } ] }, { "name": "TimeZone", "type": "string", "required": false, "description": "IANA 时区名称，参考 https://datatracker.ietf.org/doc/html/draft-ietf-netmod-iana-timezones", "example": "Asia/Shanghai" }, { "name": "AvailableTime", "type": "array", "required": false, "description": "可用时间段", "example": "无", "item_type": "object", "children": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "09:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "14:00:00" } ] } ], "required": [ "SdkAppId", "Name", "Callees", "Callers", "CallOrder", "SkillGroupId", "Priority", "ExpectedAbandonRate", "RetryInterval", "StartTime", "EndTime" ] }, { "name": "CreateSDKLoginToken", "description": "创建 SDK 登录 Token。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SeatUserId", "type": "string", "required": true, "description": "座席账号。", "example": "FooOrBar@tencent.com" }, { "name": "OnlyOnce", "type": "boolean", "required": false, "description": "生成的token是否一次性校验", "example": "false" } ], "required": [ "SdkAppId", "SeatUserId" ] }, { "name": "CreateStaff", "description": "创建客服账号。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Staffs", "type": "array", "required": true, "description": "客服信息，个数不超过 10", "example": "[{\"Name\":\"John Doe\",\"Mail\":\"john.doe@example.com\",\"Phone\":\"00861234567890\",\"StaffNumber\":\"123456\",\"Role\":1},{\"Name\":\"Jane Smith\",\"Mail\":\"jane.smith@example.com\",\"Phone\":\"00861234567890\",\"StaffNumber\":\"789012\",\"Role\":1}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "座席名称", "example": "张三" }, { "name": "Mail", "type": "string", "required": true, "description": "座席邮箱", "example": "foo@tencent.com" }, { "name": "StaffNumber", "type": "string", "required": true, "description": "工号", "example": "007" }, { "name": "Phone", "type": "string", "required": false, "description": "座席电话号码（带0086前缀）", "example": "008613012345678" }, { "name": "Nick", "type": "string", "required": false, "description": "座席昵称", "example": "三三" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "foo@tencent.com" }, { "name": "SkillGroupNameList", "type": "array", "required": false, "description": "座席关联的技能组列表", "example": "[\"测试技能组\"]", "item_type": "string" }, { "name": "Role", "type": "integer", "required": false, "description": "1:管理员 2:质检员 3:普通座席 else:自定义角色ID", "example": "1" }, { "name": "ExtensionNumber", "type": "string", "required": false, "description": "座席分机号（1 到 8 打头，4 - 6 位）", "example": "1003" } ] }, { "name": "SendPassword", "type": "boolean", "required": false, "description": "是否发送密码邮件，默认true", "example": "false" } ], "required": [ "SdkAppId", "Staffs" ] }, { "name": "CreateUserSig", "description": "创建用户数据签名", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Uid", "type": "string", "required": true, "description": "用户 ID，该值必须与 ClientData 字段中 Uid 的值一致", "example": "foo" }, { "name": "ClientData", "type": "string", "required": true, "description": "用户签名数据，必填字段，为标准 JSON 格式", "example": "参考下文示例" }, { "name": "ExpiredTime", "type": "integer", "required": true, "description": "有效期，单位秒，不超过 1 小时", "example": "3600" } ], "required": [ "SdkAppId", "Uid", "ClientData", "ExpiredTime" ] }, { "name": "DeleteCCCSkillGroup", "description": "删除技能组", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SkillGroupId", "type": "integer", "required": true, "description": "技能组ID", "example": "58832" } ], "required": [ "SdkAppId", "SkillGroupId" ] }, { "name": "DeleteExtension", "description": "删除话机账号", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "ExtensionId", "type": "string", "required": true, "description": "分机号", "example": "1001" } ], "required": [ "SdkAppId", "ExtensionId" ] }, { "name": "DeletePredictiveDialingCampaign", "description": "删除预测式外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "任务 ID", "example": "2569" } ], "required": [ "SdkAppId", "CampaignId" ] }, { "name": "DeleteStaff", "description": "删除坐席信息", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "StaffList", "type": "array", "required": true, "description": "待删除客服邮箱列表，一次最大支持200个。", "example": "[\"staff1@xxx.com\",\"staff2@xxx.com\"]", "item_type": "string" } ], "required": [ "SdkAppId", "StaffList" ] }, { "name": "DescribeAIAgentInfoList", "description": "本接口用于分页查询指定实例（SdkAppId）下已配置的智能体信息列表，包括智能体ID和名称等基本信息。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400692008" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸，上限 100", "example": "1" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码，从 0 开始", "example": "5" } ], "required": [ "SdkAppId", "PageSize", "PageNumber" ] }, { "name": "DescribeAIAnalysisResult", "description": "获取 AI 会话分析结果", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话 ID", "example": "6bb56a09-2787-40bc-80c5-dc6dab783eff" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查找起始时间", "example": "1737350008" }, { "name": "EndTime", "type": "integer", "required": true, "description": "1737350008", "example": "1737350008" } ], "required": [ "SdkAppId", "SessionId", "StartTime", "EndTime" ] }, { "name": "DescribeAICallExtractResult", "description": "本接口用于：在语音智能体通话结束后，通过 Session ID 查询指定会话的 **话后标签** 结果。相关话后标签需提前在管理端完成配置，具体说明请参见 [话后标签](https://cloud.tencent.com/document/product/679/119800) 。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话 ID", "example": "adcf61b8-dbb9-4c20-87bf-c0744c04bade" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查找起始时间", "example": "1737350008" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查找结束时间", "example": "1737356008" } ], "required": [ "SdkAppId", "SessionId", "StartTime", "EndTime" ] }, { "name": "DescribeAILatency", "description": "调用该接口，可以通过 Session ID 查询指定会话在特定时间段内，AI服务的处理时延明细与统计数据，时延信息包括： - 端到端（ETE）时延：统计从用户语音输入到 AI 返回完整响应的整体耗时。 - 自动语音识别（ASR）时延：统计语音输入被识别为文本所需的处理耗时。 - 大语言模型（LLM）时延：统计 AI 模型生成文本内容的推理耗时。 - 语音合成（TTS）时延：统计文本转换为语音\ufffd...", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话 ID", "example": "6bb56a09-2787-40bc-80c5-dc6dab783eff" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查找起始时间", "example": "1737350008" }, { "name": "EndTime", "type": "integer", "required": true, "description": "1737350008", "example": "1737350008" } ], "required": [ "SdkAppId", "SessionId", "StartTime", "EndTime" ] }, { "name": "DescribeActiveCarrierPrivilegeNumber", "description": "查询生效运营商白名单规则", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "默认0", "example": "0" }, { "name": "PageSize", "type": "integer", "required": false, "description": "默认10，最大100", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "筛选条件 Name支持PhoneNumber(按号码模糊查找)", "example": "[]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "筛选字段名", "example": "Key" }, { "name": "Values", "type": "array", "required": true, "description": "筛选条件值", "example": "[\"Value1\",\"Value2\"]", "item_type": "string" } ] } ], "required": [ "SdkAppId" ] }, { "name": "DescribeAgentCruiseDialingCampaign", "description": "查询 座席巡航式外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "任务 ID", "example": "2569" } ], "required": [ "SdkAppId", "CampaignId" ] }, { "name": "DescribeAutoCalloutTask", "description": "用于通过 TaskId 查询**自动外呼任务的详细信息**，包括任务基础配置、起止时间、外呼名单、执行状态以及实际通话情况等。 该接口通常与 [创建批量自动外呼任务](https://cloud.tencent.com/document/product/679/69194) 配合使用，用于在任务创建后查看任务配置是否生效、任务当前状态，以及后续执行过程中的实时进展。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务Id", "example": "3" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeAutoCalloutTasks", "description": "批量查询自动外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页大小", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页数", "example": "0" } ], "required": [ "SdkAppId", "PageSize", "PageNumber" ] }, { "name": "DescribeCCCBuyInfoList", "description": "获取用户购买信息列表", "status": "online", "parameters": [ { "name": "SdkAppIds", "type": "array", "required": false, "description": "应用ID列表，不传时查询所有应用", "example": "[1400000,14000001]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeCallInMetrics", "description": "获取呼入实时数据统计指标", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "EnabledSkillGroup", "type": "boolean", "required": false, "description": "是否返回技能组维度信息，默认“是”", "example": "true" }, { "name": "EnabledNumber", "type": "boolean", "required": false, "description": "是否返回线路维度信息，默认“否”", "example": "false" }, { "name": "GroupIdList", "type": "array", "required": false, "description": "筛选技能组列表", "example": "[1,2,3,4,5]", "item_type": "integer" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeCarrierPrivilegeNumberApplicants", "description": "查询单状态", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "默认0，从0开始", "example": "0" }, { "name": "PageSize", "type": "integer", "required": false, "description": "默认10，最大100", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "筛选条件,Name支持ApplicantId,PhoneNumber(按号码模糊查找)", "example": "[{\"Name\":\"ApplicantId\", \"Values\":\"1\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "筛选字段名", "example": "Key" }, { "name": "Values", "type": "array", "required": true, "description": "筛选条件值", "example": "[\"Value1\",\"Value2\"]", "item_type": "string" } ] } ], "required": [ "SdkAppId" ] }, { "name": "DescribeChatMessages", "description": "获取指定服务记录文本聊天内容，需要先使用查询在线客服记录（DescribeIMCdrs） API 获取服务记录 SessionId。 文本聊天记录只保存了 1 年内的，1 年之前会自动清理。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID，可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，最大为100 默认20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回记录偏移，默认为 0", "example": "0" }, { "name": "Order", "type": "integer", "required": false, "description": "1为从早到晚，2为从晚到早，默认为2", "example": "1" }, { "name": "SessionId", "type": "string", "required": false, "description": "服务记录 SessionID", "example": "d6253538-7c28-477b-998a-919059801899" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeCompanyList", "description": "查询公司资质申请列表", "status": "online", "parameters": [ { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸，上限 100", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码，从 0 开始", "example": "0" }, { "name": "CompanyName", "type": "array", "required": false, "description": "公司名称", "example": "foobar科技有限公司", "item_type": "string" }, { "name": "State", "type": "array", "required": false, "description": "审核状态，1-待审核，2-审核通过，3-驳回", "example": "1", "item_type": "integer" }, { "name": "ApplyID", "type": "array", "required": false, "description": "申请ID", "example": "1", "item_type": "integer" } ], "required": [ "PageSize", "PageNumber" ] }, { "name": "DescribeExtension", "description": "获取话机信息", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "ExtensionId", "type": "string", "required": true, "description": "分机号", "example": "1001" } ], "required": [ "SdkAppId", "ExtensionId" ] }, { "name": "DescribeExtensions", "description": "查询话机列表信息", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页号（从0开始）", "example": "0" }, { "name": "ExtensionIds", "type": "array", "required": false, "description": "筛选分机号列表", "example": "[\"1001\",\"1002\"]", "item_type": "string" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小", "example": "50" }, { "name": "FuzzingKeyWord", "type": "string", "required": false, "description": "模糊查询字段（模糊查询分机号、分机名称、坐席邮箱、坐席名称）", "example": "foobar" }, { "name": "IsNeedStatus", "type": "boolean", "required": false, "description": "是否需要返回话机当前状态", "example": "false" } ], "required": [ "SdkAppId", "PageNumber" ] }, { "name": "DescribeFlashSMSList", "description": "获取闪信记录列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1500098920" }, { "name": "StartTimestamp", "type": "integer", "required": true, "description": "起始时间戳，Unix 秒级时间戳，最大支持近180天。", "example": "1769730111" }, { "name": "EndTimestamp", "type": "integer", "required": true, "description": "结束时间戳，Unix 秒级时间戳，结束时间与开始时间的区间范围小于90天。", "example": "1769749111" }, { "name": "DeliveryNumber", "type": "string", "required": false, "description": "闪信投递号码（被叫号码）", "example": "00860755******88" }, { "name": "ServingNumber", "type": "string", "required": false, "description": "呼叫关联的系统号码", "example": "0086021******07" }, { "name": "SessionId", "type": "string", "required": false, "description": "会话 ID", "example": "15adb830-****-****-****-20c7d825d845" }, { "name": "DeliveryStatus", "type": "integer", "required": false, "description": "投递结果 1 为成功，其他为失败", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小，默认 20，最大 1000取值范围：[20, 1000]单位：条默认值：20", "example": "20" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "分页页码，从 0 开始", "example": "0" } ], "required": [ "SdkAppId", "StartTimestamp", "EndTimestamp" ] }, { "name": "DescribeIMCdrList", "description": "获取包括全媒体和文本会话两种类型的服务记录。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "StartTimestamp", "type": "integer", "required": true, "description": "起始时间（必填），Unix 秒级时间戳", "example": "1603877878" }, { "name": "EndTimestamp", "type": "integer", "required": true, "description": "结束时间（必填），Unix 秒级时间戳", "example": "1603877879" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，最大为100默认20", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回记录偏移，默认为 0", "example": "0" }, { "name": "Type", "type": "integer", "required": false, "description": "1为全媒体，2为文本客服，不填则查询全部", "example": "2" } ], "required": [ "SdkAppId", "StartTimestamp", "EndTimestamp" ] }, { "name": "DescribeIMCdrs", "description": "获取包括全媒体和文本会话两种类型的服务记录。", "status": "online", "parameters": [ { "name": "StartTimestamp", "type": "integer", "required": true, "description": "起始时间（必填），Unix 秒级时间戳", "example": "1603877878" }, { "name": "EndTimestamp", "type": "integer", "required": true, "description": "结束时间（必填），Unix 秒级时间戳", "example": "1603877879" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，最大为100默认20", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回记录偏移，默认为 0", "example": "0" }, { "name": "Type", "type": "integer", "required": false, "description": "1为全媒体，2为文本客服，不填则查询全部", "example": "2" } ], "required": [ "StartTimestamp", "EndTimestamp" ] }, { "name": "DescribeIvrAudioList", "description": "查询IVR音频文件列表信息", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1600000001" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸，上限 50", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码，从 0 开始", "example": "0" }, { "name": "CustomFileName", "type": "array", "required": false, "description": "文件别名", "example": "欢迎", "item_type": "string" }, { "name": "AudioFileName", "type": "array", "required": false, "description": "文件名", "example": "aaa.mp3", "item_type": "string" }, { "name": "FileId", "type": "array", "required": false, "description": "文件ID", "example": "12", "item_type": "integer" } ], "required": [ "SdkAppId", "PageSize", "PageNumber" ] }, { "name": "DescribeNumbers", "description": "查询号码列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数，从0开始", "example": "0" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小，默认20", "example": "20" } ], "required": [ "SdkAppId" ] }, { "name": "DescribePSTNActiveSessionList", "description": "获取当前正在通话的会话列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Offset", "type": "integer", "required": true, "description": "数据偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回的数据条数，最大 25", "example": "25" } ], "required": [ "SdkAppId", "Offset", "Limit" ] }, { "name": "DescribePredictiveDialingCampaign", "description": "查询预测式外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "任务 ID", "example": "2569" } ], "required": [ "SdkAppId", "CampaignId" ] }, { "name": "DescribePredictiveDialingCampaigns", "description": "查询预测式外呼任务列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸，最大为 100", "example": "25" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码，从 0 开始", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "查询任务列表名称关键字", "example": "推荐" }, { "name": "SkillGroupId", "type": "integer", "required": false, "description": "查询任务列表技能组 ID", "example": "255" } ], "required": [ "SdkAppId", "PageSize", "PageNumber" ] }, { "name": "DescribePredictiveDialingSessions", "description": "查询预测式外呼呼叫列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "生成的任务 ID", "example": "2569" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸，最大为 1000", "example": "25" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码，从 0 开始", "example": "0" } ], "required": [ "SdkAppId", "CampaignId", "PageSize", "PageNumber" ] }, { "name": "DescribeProtectedTelCdr", "description": "获取主被叫受保护的电话服务记录与录音", "status": "online", "parameters": [ { "name": "StartTimeStamp", "type": "integer", "required": true, "description": "起始时间戳，Unix 秒级时间戳", "example": "1611631881" }, { "name": "EndTimeStamp", "type": "integer", "required": true, "description": "结束时间戳，Unix 秒级时间戳", "example": "1611631881" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID，可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸，上限 100", "example": "100" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码，从 0 开始", "example": "0" } ], "required": [ "StartTimeStamp", "EndTimeStamp", "SdkAppId", "PageSize", "PageNumber" ] }, { "name": "DescribeSessionDetail", "description": "此接口用于在通话结束后，通过 session id 和时间戳，查询单一通话的通话详情。包括：主被叫信息、录音等。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SessionId", "type": "string", "required": true, "description": "通话的 session id", "example": "6164325c-39aa-45dc-83e2-2ecbc9b37ad5" }, { "name": "StartTimestamp", "type": "integer", "required": true, "description": "起始时间戳，Unix 秒级时间戳，最大支持近180天。", "example": "1756372067" }, { "name": "EndTimestamp", "type": "integer", "required": true, "description": "结束时间戳，Unix 秒级时间戳，结束时间与开始时间的区间范围小于90天。", "example": "1756372167" } ], "required": [ "SdkAppId", "SessionId", "StartTimestamp", "EndTimestamp" ] }, { "name": "DescribeSkillGroupInfoList", "description": "获取技能组信息列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸，上限 100", "example": "100" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码，从 0 开始", "example": "0" }, { "name": "SkillGroupId", "type": "integer", "required": false, "description": "技能组ID，查询单个技能组时使用", "example": "12" }, { "name": "ModifiedTime", "type": "integer", "required": false, "description": "查询修改时间大于等于ModifiedTime的技能组时使用", "example": "1611631881" }, { "name": "SkillGroupName", "type": "string", "required": false, "description": "技能组名称", "example": "销售组" } ], "required": [ "SdkAppId", "PageSize", "PageNumber" ] }, { "name": "DescribeStaffInfoList", "description": "获取坐席信息列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸，上限 9999", "example": "9999" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码，从 0 开始", "example": "0" }, { "name": "StaffMail", "type": "string", "required": false, "description": "坐席账号，查询单个坐席时使用", "example": "102992@qq.com" }, { "name": "ModifiedTime", "type": "integer", "required": false, "description": "查询修改时间大于等于ModifiedTime的坐席时使用", "example": "1611631881" }, { "name": "SkillGroupId", "type": "integer", "required": false, "description": "技能组ID", "example": "1145" } ], "required": [ "SdkAppId", "PageSize", "PageNumber" ] }, { "name": "DescribeStaffStatusHistory", "description": "查询座席状态历史", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "StaffUserId", "type": "string", "required": true, "description": "座席账号", "example": "foo@tencent.com" }, { "name": "StartTimestamp", "type": "integer", "required": true, "description": "起始时间戳，Unix 秒级时间戳，最大支持近180天。", "example": "1753925234" }, { "name": "EndTimestamp", "type": "integer", "required": true, "description": "结束时间戳，Unix 秒级时间戳，结束时间与开始时间的区间范围小于 7 天。", "example": "1753926234" }, { "name": "Cursor", "type": "string", "required": false, "description": "分页检索时使用的游标", "example": "foo-and-bar" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页尺寸", "example": "1000" } ], "required": [ "SdkAppId", "StaffUserId", "StartTimestamp", "EndTimestamp" ] }, { "name": "DescribeStaffStatusMetrics", "description": "获取坐席实时状态统计指标", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "StaffList", "type": "array", "required": false, "description": "筛选坐席列表，默认不传返回全部坐席信息", "example": "[a@tencent.com,b@tencent.com,c@tencent.com]", "item_type": "string" }, { "name": "GroupIdList", "type": "array", "required": false, "description": "筛选技能组ID列表", "example": "[1,2,3,4,5,6]", "item_type": "integer" }, { "name": "StatusList", "type": "array", "required": false, "description": "筛选坐席状态列表 座席状态 free 示闲 | busy 忙碌 | rest 小休 | notReady 示忙 | afterCallWork 话后调整 | offline 离线", "example": "[\"free\"]", "item_type": "string" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeTelCallInfo", "description": "按实例获取电话消耗统计", "status": "online", "parameters": [ { "name": "StartTimeStamp", "type": "integer", "required": true, "description": "起始时间戳，Unix 时间戳(查询维度仅支持天，例如查询5月1日应该传startTime:\u0026quot;2023-05-01 00:00:00\u0026quot;,\u0026quot;endTime\u0026quot;:\u0026quot;2023-05-01 23:59:59\u0026quot;的时间戳,查5月1日和5月2日的应该传startTime:\u0026quot;2023-05-01 00:00:00\u0026quot;,\u0026quot;endTime\u0026quot;:\u0026quot;2023-05-02 23:59:59\u0026quot;的时间戳)", "example": "1773041460" }, { "name": "EndTimeStamp", "type": "integer", "required": true, "description": "结束时间戳，Unix 时间戳，查询时间范围最大为90天(查询维度仅支持天，例如查询5月1日应该传startTime:\u0026quot;2023-05-01 00:00:00\u0026quot;,\u0026quot;endTime\u0026quot;:\u0026quot;2023-05-01 23:59:59\u0026quot;的时间戳,查5月1日和5月2日的应该传startTime:\u0026quot;2023-05-01 00:00:00\u0026quot;,\u0026quot;endTime\u0026quot;:\u0026quot;2023-05-02 23:59:59\u0026quot;的时间戳)", "example": "1773042460" }, { "name": "SdkAppIdList", "type": "array", "required": true, "description": "应用ID列表，多个ID时，返回值为多个ID使用总和", "example": "[140000000]", "item_type": "integer" } ], "required": [ "StartTimeStamp", "EndTimeStamp", "SdkAppIdList" ] }, { "name": "DescribeTelCdr", "description": "获取电话服务记录与录音", "status": "online", "parameters": [ { "name": "StartTimeStamp", "type": "integer", "required": true, "description": "起始时间戳，Unix 秒级时间戳，最大支持近180天。", "example": "1611631881" }, { "name": "EndTimeStamp", "type": "integer", "required": true, "description": "结束时间戳，Unix 秒级时间戳，结束时间与开始时间的区间范围小于90天。", "example": "1611631881" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页尺寸（必填），上限 100", "example": "100" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "分页页码（必填），从 0 开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数据条数，上限（废弃）", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移（废弃）", "example": "0" }, { "name": "Phones", "type": "array", "required": false, "description": "按手机号筛选", "example": "[\"008613012345678\"]", "item_type": "string" }, { "name": "SessionIds", "type": "array", "required": false, "description": "按SessionId筛选", "example": "[\"7cb26a84-83b2-42d8-a19b-7dae78e9b78e\"]", "item_type": "string" } ], "required": [ "StartTimeStamp", "EndTimeStamp", "SdkAppId", "PageSize", "PageNumber" ] }, { "name": "DescribeTelRecordAsr", "description": "拉取会话录音转文本信息", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话 ID", "example": "6bb56a09-2787-40bc-80c5-dc6dab783eff" } ], "required": [ "SdkAppId", "SessionId" ] }, { "name": "DescribeTelSession", "description": "获取 PSTN 会话信息", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话 ID", "example": "6bb56a09-2787-40bc-80c5-dc6dab783eff" } ], "required": [ "SdkAppId", "SessionId" ] }, { "name": "DisableCCCPhoneNumber", "description": "停用号码", "status": "online", "parameters": [ { "name": "PhoneNumbers", "type": "array", "required": true, "description": "号码列表，0086开头", "example": "['00860755XXXX','0086021XXXX']", "item_type": "string" }, { "name": "Disabled", "type": "integer", "required": true, "description": "停用开关，0启用 1停用", "example": "1" }, { "name": "SdkAppId", "type": "integer", "required": false, "description": "TCCC 实例应用 ID", "example": "1400000000" } ], "required": [ "PhoneNumbers", "Disabled" ] }, { "name": "ForceMemberOffline", "description": "强制客服下线", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "UserId", "type": "string", "required": true, "description": "客服ID", "example": "user@example.com" } ], "required": [ "SdkAppId", "UserId" ] }, { "name": "HangUpCall", "description": "挂断电话", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话ID", "example": "1001" } ], "required": [ "SdkAppId", "SessionId" ] }, { "name": "ModifyCompanyApply", "description": "修改公司资质申请，只能修改状态为驳回或待审核的申请单。（1、首次使用接口，建议先在云联络中心控制台查看各个资料模板:https://console.cloud.tencent.com/ccc/enterprise/update。2、参数中图片Url建议使用腾讯云Cos存储的临时链接）", "status": "online", "parameters": [ { "name": "ApplyId", "type": "integer", "required": true, "description": "申请单ID(只能修改状态为“驳回”或者“待审核”的申请单)", "example": "1" }, { "name": "CompanyInfo", "type": "object", "required": true, "description": "企业资质信息", "example": "无", "children": [ { "name": "ApplicantType", "type": "integer", "required": true, "description": "申请人身份，0-公司法定代表人，1-经办人（受法定代表人委托）", "example": "1" }, { "name": "CompanyName", "type": "string", "required": true, "description": "企业名称", "example": "北京XXCC有限责任公司" }, { "name": "BusinessId", "type": "string", "required": true, "description": "统一社会信用代码", "example": "91411111111111111" }, { "name": "BusinessIdPicUrl", "type": "string", "required": true, "description": "营业执照扫描件(加盖公章)。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "CorporationName", "type": "string", "required": true, "description": "法定代表人名称", "example": "王某某" }, { "name": "CorporationId", "type": "string", "required": true, "description": "法定代表人身份证号码", "example": "610000000000008" }, { "name": "CorporationIdPicUrl", "type": "string", "required": true, "description": "法定代表人身份证正反面扫描件。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "NetworkCommitmentPicUrl", "type": "string", "required": true, "description": "安全合规使用承诺书。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "IsEqualTencentCloud", "type": "integer", "required": true, "description": "是否与腾讯云账号的资质一致,0-不一致,1-一致", "example": "1" }, { "name": "CorporationMobile", "type": "string", "required": true, "description": "法定代表人手机号", "example": "18011111111" }, { "name": "CorporationMobilePicUrl", "type": "string", "required": true, "description": "法定代表人手机号码实名认证。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "UseDescribeFileUrl", "type": "string", "required": true, "description": "通话话术。(支持doc、docx格式的文档不超过50MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "CompanyAuthLetterPicUrl", "type": "string", "required": true, "description": "公司授权函。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "AcceptPicUrl", "type": "string", "required": true, "description": "电话受理单。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" }, { "name": "CorporationHoldingOnIdPicUrl", "type": "string", "required": false, "description": "法定代表人手持身份证照，申请人类型为法定代表人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "OperatorName", "type": "string", "required": false, "description": "经办人名称，申请人类型为经办人时必填。", "example": "李某某" }, { "name": "OperatorId", "type": "string", "required": false, "description": "经办人证件号码，申请人类型为经办人时必填。", "example": "61011111111111111" }, { "name": "OperatorIdPicUrl", "type": "string", "required": false, "description": "经办人身份证正反面扫描件，申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "OperatorHoldingOnIdPicUrl", "type": "string", "required": false, "description": "经办人手持身份证照，申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "CommissionPicUrl", "type": "string", "required": false, "description": "委托授权书，申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg\t" }, { "name": "OperatorMobile", "type": "string", "required": false, "description": "经办人手机号，申请人类型为经办人时必填。", "example": "18022222222" }, { "name": "OperatorEmail", "type": "string", "required": false, "description": "经办人邮箱，申请人类型为经办人时必填。", "example": "111@qq.com" }, { "name": "OperatorMobilePicUrl", "type": "string", "required": false, "description": "经办人手机号码实名认证，申请人类型为经办人时必填。(支持jpg、png、gif、jpeg格式的图片，每张图片应大于50K，不超过5MB，模板参见控制台:https://console.cloud.tencent.com/ccc/enterprise/update)", "example": "https://xxxx.com/xxxxx.jpg" } ] } ], "required": [ "ApplyId", "CompanyInfo" ] }, { "name": "ModifyExtension", "description": "修改话机账号(绑定技能组、绑定坐席账号)", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "ExtensionId", "type": "string", "required": true, "description": "分机号", "example": "1001" }, { "name": "ExtensionName", "type": "string", "required": false, "description": "分机名称", "example": "分机1" }, { "name": "SkillGroupIds", "type": "array", "required": false, "description": "所属技能组列表", "example": "[1,2,3,4,5,6]", "item_type": "integer" }, { "name": "Relation", "type": "string", "required": false, "description": "绑定坐席邮箱账号", "example": "xxx@xxx.com" } ], "required": [ "SdkAppId", "ExtensionId" ] }, { "name": "ModifyOwnNumberApply", "description": "修改客户自携号码审批单", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "DetailList", "type": "array", "required": true, "description": "线路相关参数", "example": "无", "item_type": "object", "children": [ { "name": "CallType", "type": "integer", "required": true, "description": "号码类型：0-呼入|1-呼出|2-呼入呼出", "example": "2" }, { "name": "PhoneNumber", "type": "string", "required": true, "description": "线路号码", "example": "02066660000" }, { "name": "MaxCallCount", "type": "integer", "required": true, "description": "最大并发呼叫数", "example": "1" }, { "name": "MaxCallPSec", "type": "integer", "required": true, "description": "每秒最大并发数", "example": "1" }, { "name": "OutboundCalleeFormat", "type": "string", "required": false, "description": "呼出被叫格式，使用 {+E.164} 或 {E.164},", "example": "{+E.164}" }, { "name": "CarrierPhoneNumber", "type": "string", "required": false, "description": "运营商号码", "example": "66660000" } ] }, { "name": "ApplyId", "type": "integer", "required": false, "description": "审批单号", "example": "1" }, { "name": "Prefix", "type": "string", "required": false, "description": "送号前缀", "example": "0" }, { "name": "MobileNddPrefix", "type": "string", "required": false, "description": "国内长途手机前缀码", "example": "0" }, { "name": "LocalNumberTrimAC", "type": "boolean", "required": false, "description": "同市固话去掉区号", "example": "false" } ], "required": [ "SdkAppId", "DetailList" ] }, { "name": "ModifyStaff", "description": "修改客服账号", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000" }, { "name": "Email", "type": "string", "required": true, "description": "座席账户", "example": "xx@tencent.com" }, { "name": "Name", "type": "string", "required": false, "description": "座席名称", "example": "小王" }, { "name": "Phone", "type": "string", "required": false, "description": "座席手机号（带0086前缀,示例：008618011111111）", "example": "008618088888888" }, { "name": "Nick", "type": "string", "required": false, "description": "座席昵称", "example": "小管家" }, { "name": "StaffNo", "type": "string", "required": false, "description": "座席工号", "example": "114514" }, { "name": "SkillGroupIds", "type": "array", "required": false, "description": "绑定技能组ID列表", "example": "[123,134]", "item_type": "integer" }, { "name": "UseMobileCallOut", "type": "boolean", "required": false, "description": "是否开启手机外呼开关", "example": "true" }, { "name": "UseMobileAccept", "type": "integer", "required": false, "description": "手机接听模式 0 - 关闭 | 1 - 仅离线 | 2 - 始终", "example": "0" }, { "name": "ExtensionNumber", "type": "string", "required": false, "description": "座席分机号（1 到 8 打头，4 - 6 位）", "example": "1003" }, { "name": "ForwardingConfig", "type": "object", "required": false, "description": "呼叫转移配置", "example": "{\"Enabled\":true,\"Condition\":2,\"Target\":{\"Type\":1,\"StaffUserId\":\"foo@tencent.com\"}}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "Condition", "type": "integer", "required": false, "description": "1 无条件呼转 2 有条件呼转", "example": "2" }, { "name": "Target", "type": "object", "required": false, "description": "呼转目标", "example": "{\"Type\":1,\"StaffUserId\":\"foo@tencent.com\"}", "children": [ { "name": "Type", "type": "integer", "required": false, "description": "呼转目标类型 1 座席 2 技能组 3 分机", "example": "1" }, { "name": "StaffUserId", "type": "string", "required": false, "description": "呼转目标为座席的账号 Type 为 1 时填写", "example": "foo@tencent.com" }, { "name": "SkillGroupId", "type": "integer", "required": false, "description": "呼转目标为技能组的 ID，Type 为 2 时填写", "example": "1254" }, { "name": "Extension", "type": "string", "required": false, "description": "呼转目标为分机的账号，Type 为 3 时填写", "example": "1003@1400000000.sip.tccc.qcloud.com" } ] } ] } ], "required": [ "SdkAppId", "Email" ] }, { "name": "ModifyStaffPassword", "description": "修改座席的密码", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "16000000" }, { "name": "Email", "type": "string", "required": true, "description": "座席邮箱", "example": "a@qq.com" }, { "name": "Password", "type": "string", "required": true, "description": "设置的密码", "example": "abcdefg" } ], "required": [ "SdkAppId", "Email", "Password" ] }, { "name": "PauseAutoCalloutTask", "description": "用于通过 TaskId **暂停一个正在执行的自动外呼任务**。调用该接口后，任务将被临时中断，不再发起新的外呼请求；已发起的通话不受影响。 暂停后的任务可通过 [恢复暂停的自动外呼任务](https://cloud.tencent.com/document/product/679/125356) 接口继续执行。如需永久终止任务，请参考 [停止自动外呼任务](https://cloud.tencent.com/document/product/679/69192)。", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务Id", "example": "16498" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400692008" } ], "required": [ "TaskId", "SdkAppId" ] }, { "name": "PausePredictiveDialingCampaign", "description": "暂停预测式外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "任务 ID", "example": "2569" } ], "required": [ "SdkAppId", "CampaignId" ] }, { "name": "PlaySoundCall", "description": "对与座席通话中的会话，进行放音", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400692008" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话ID", "example": "f3be95fb-2786-466a-beab-5e3d8cb76272" }, { "name": "FileId", "type": "integer", "required": false, "description": "音频文件 ID，参见管理端-电话客服-放音文件管理", "example": "27500" }, { "name": "PlayTimes", "type": "integer", "required": false, "description": "放音次数，默认 1 次", "example": "1" } ], "required": [ "SdkAppId", "SessionId" ] }, { "name": "ResetExtensionPassword", "description": "重置话机注册密码", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "ExtensionId", "type": "string", "required": true, "description": "分机号", "example": "1001" } ], "required": [ "SdkAppId", "ExtensionId" ] }, { "name": "RestoreMemberOnline", "description": "恢复客服上线", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "UserId", "type": "string", "required": true, "description": "客服ID", "example": "user@example.com" } ], "required": [ "SdkAppId", "UserId" ] }, { "name": "ResumeAutoCalloutTask", "description": "用于通过 TaskId **恢复一个已被暂停的自动外呼任务**。该接口适用于在调用 [暂停自动外呼任务](https://cloud.tencent.com/document/product/679/125357) 后，需继续执行剩余外呼计划的场景。调用成功后，任务将从暂停状态恢复，重新发起未完成的外呼请求。", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务Id", "example": "16497" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400692008" } ], "required": [ "TaskId", "SdkAppId" ] }, { "name": "ResumePredictiveDialingCampaign", "description": "恢复预测式外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "任务 ID", "example": "2569" } ], "required": [ "SdkAppId", "CampaignId" ] }, { "name": "SetStaffStatus", "description": "设置 staff 状态", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400692008" }, { "name": "StaffStatusList", "type": "array", "required": true, "description": "设置座席状态列表，最大个数 10", "example": "无", "item_type": "object", "children": [ { "name": "StaffUserId", "type": "string", "required": true, "description": "座席账号" }, { "name": "Status", "type": "string", "required": true, "description": "状态，free 示闲 notReady 示忙 rest 小休" }, { "name": "Reason", "type": "string", "required": false, "description": "如果设置小休状态，这里是原因" } ] } ], "required": [ "SdkAppId", "StaffStatusList" ] }, { "name": "StopAutoCalloutTask", "description": "停止自动外呼任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务Id", "example": "1" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "TransferToManual", "description": "特定场景下讲会话转接到人工坐席", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话ID", "example": "d6253538-7c28-477b-998a-919059801899" }, { "name": "SkillGroupId", "type": "integer", "required": true, "description": "技能组Id", "example": "5002" } ], "required": [ "SdkAppId", "SessionId", "SkillGroupId" ] }, { "name": "UnbindNumberCallOutSkillGroup", "description": "解绑号码外呼技能组", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "Number", "type": "string", "required": true, "description": "待解绑的号码", "example": "\"0086075512345678\"" }, { "name": "SkillGroupIds", "type": "array", "required": true, "description": "待解绑的技能组Id列表", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "SdkAppId", "Number", "SkillGroupIds" ] }, { "name": "UnbindStaffSkillGroupList", "description": "解绑坐席所属技能组", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "StaffEmail", "type": "string", "required": true, "description": "客服邮箱", "example": "staff1@xx.com" }, { "name": "SkillGroupList", "type": "array", "required": true, "description": "解绑技能组列表", "example": "[1,2,3,4,5,6]", "item_type": "integer" } ], "required": [ "SdkAppId", "StaffEmail", "SkillGroupList" ] }, { "name": "UpdateCCCSkillGroup", "description": "更新技能组", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "SkillGroupID", "type": "integer", "required": true, "description": "技能组ID", "example": "12345678" }, { "name": "SkillGroupName", "type": "string", "required": false, "description": "修改后的技能组名字", "example": "客户一组" }, { "name": "MaxConcurrency", "type": "integer", "required": false, "description": "修改后的最大并发数,同振最大为2", "example": "1" }, { "name": "RingAll", "type": "boolean", "required": false, "description": "true同振，false顺振", "example": "true" } ], "required": [ "SdkAppId", "SkillGroupID" ] }, { "name": "UpdatePredictiveDialingCampaign", "description": "任务未启动前，更新预测式外呼任务。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1400000000" }, { "name": "CampaignId", "type": "integer", "required": true, "description": "生成的任务 ID", "example": "2569" }, { "name": "Name", "type": "string", "required": true, "description": "任务名称", "example": "新能源SUV推荐" }, { "name": "Callees", "type": "array", "required": true, "description": "被叫列表，支持 E.164 或不带国家码形式的号码", "example": "+8613012345678", "item_type": "string" }, { "name": "Callers", "type": "array", "required": true, "description": "主叫列表，使用管理端展示的号码格式", "example": "0086075586013388", "item_type": "string" }, { "name": "CallOrder", "type": "integer", "required": true, "description": "被叫呼叫顺序 0 随机 1 顺序", "example": "0" }, { "name": "SkillGroupId", "type": "integer", "required": true, "description": "使用的座席技能组 ID", "example": "255" }, { "name": "Priority", "type": "integer", "required": true, "description": "相同应用内多个任务运行优先级，从高到底 1 - 5", "example": "3" }, { "name": "ExpectedAbandonRate", "type": "integer", "required": true, "description": "预期呼损率，百分比，5 - 50", "example": "10" }, { "name": "RetryInterval", "type": "integer", "required": true, "description": "呼叫重试间隔时间，单位秒，60 - 86400", "example": "1800" }, { "name": "StartTime", "type": "integer", "required": true, "description": "任务启动时间，Unix 时间戳，到此时间后会自动启动任务", "example": "1708483433" }, { "name": "EndTime", "type": "integer", "required": true, "description": "任务结束时间，Unix 时间戳，到此时间后会自动终止任务", "example": "1708485433" }, { "name": "IVRId", "type": "integer", "required": false, "description": "指定的 IVR ID", "example": "4600" }, { "name": "RetryTimes", "type": "integer", "required": false, "description": "呼叫重试次数，0 - 2", "example": "2" }, { "name": "Variables", "type": "array", "required": false, "description": "自定义变量", "example": "[{\"Key\":\"foo\",\"Value\":\"bar\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] }, { "name": "UUI", "type": "string", "required": false, "description": "UUI", "example": "foobar" }, { "name": "CalleeAttributes", "type": "array", "required": false, "description": "被叫属性", "example": "[{\"Callee\":\"13012345678\",\"UUI\":\"foobar\",\"Variables\":[{\"Key\":\"foo\":\"Value\":\"bar\"}]}]", "item_type": "object", "children": [ { "name": "Callee", "type": "string", "required": true, "description": "被叫号码", "example": "0086130xxxxxxxx" }, { "name": "UUI", "type": "string", "required": false, "description": "随路数据", "example": "foobar" }, { "name": "Variables", "type": "array", "required": false, "description": "参数", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "变量名", "example": "foo" }, { "name": "Value", "type": "string", "required": true, "description": "变量值", "example": "bar" } ] } ] } ], "required": [ "SdkAppId", "CampaignId", "Name", "Callees", "Callers", "CallOrder", "SkillGroupId", "Priority", "ExpectedAbandonRate", "RetryInterval", "StartTime", "EndTime" ] }, { "name": "UploadIvrAudio", "description": "上传IVR中使用的音频文件，每日上传文件限制50个。（参数中音频文件Url建议使用腾讯云Cos存储的临时链接）", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc", "example": "1600000001" }, { "name": "AudioList", "type": "array", "required": true, "description": "音频文件列表", "example": "无", "item_type": "object", "children": [ { "name": "CustomFileName", "type": "string", "required": true, "description": "文件别名（可重复）", "example": "呼入使用" }, { "name": "AudioUrl", "type": "string", "required": true, "description": "音频文件链接。(支持mp3和wav格式，文件不超过5MB)", "example": "http://xxx.com/aa.mp3" } ] } ], "required": [ "SdkAppId", "AudioList" ] } ] }