本产品（OutboundBot/2019-12-26）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
系统管理
|
API |
标题 |
API概述 |
| SaveBaseStrategyPeriod | 编辑全局可外呼时间段 | 在系统管理中编辑全局可外呼时间段。 |
| SaveMaxAttemptsPerDay | 保存被叫号码每日拨打上限 | 保存被叫号码每日拨打上限。 |
| SaveContactWhiteList | 保存外呼白名单 | 保存外呼白名单。 |
| SaveContactBlockList | 保存禁止外呼名单 | 添加该实例下“禁呼名单”。 |
| SaveAfterAnswerDelayPlayback | 保存接听后延迟播报时间 | 保存接听后延迟播报时间。 |
| GetMaxAttemptsPerDay | 查询被叫号码每日拨打上限 | 查询被叫号码每日拨打上限。 |
| GetContactWhiteList | 获取外呼白名单列表 | 获取全局外呼策略白名单。 |
| GetContactBlockList | 获取禁止外呼名单 | 获取禁止外呼名单。 |
| GetBaseStrategyPeriod | 获取全局可外呼时间段 | 获取外呼系统中全局可外呼时间段。 |
| GetAfterAnswerDelayPlayback | 查询接听后延迟播报时间 | 获取接通后延迟放音时间。 |
| DeleteContactWhiteList | 删除外呼白名单 | 删除全局外呼策略白名单。 |
| DeleteContactBlockList | 删除禁止外呼名单 | 删除禁呼名单。 |
意图管理 （旧画布使用）
|
API |
标题 |
API概述 |
| ListIntents | 查询意图列表-旧画布接口 | 查询意图列表，旧画布接口。 |
| DescribeIntent | 获取一个意图-旧画布接口 | 获取一个意图，旧画布接口。 |
| ModifyIntent | 修改意图-旧画布接口 | 旧画布场景中修改意图，旧画布接口。 |
| DeleteIntent | 删除意图-旧画布接口 | 删除意图，旧画布接口。 |
意图管理（小模型接口）
|
API |
标题 |
API概述 |
| DescribeBeebotIntent | 【获取小模型接口】获取小蜜机器人意图 | 获取小模型场景中的意图。 |
| DescribeIntentStatistics | 查询意图统计信息 | 查询任务组下的意图统计信息。 |
| ListBeebotIntentLgf | 【小模型接口】列表展示小蜜机器人意图问法模版 | 列表小模型场景意图问法模版。 |
| ListBeebotIntentUserSay | 【小模型接口】列表展示小蜜机器人用户问法 | 列表展示小模型场景意图用户问法。 |
| DeleteBeebotIntentUserSay | 【小模型接口】删除小蜜意图用户问法 | 删除小模型场景意图用户问法。 |
| DeleteBeebotIntentLgf | 【小模型接口】删除小蜜机器人意图问法模版 | 删除小模型场景意图问法模版。 |
| DeleteBeebotIntent | 【小模型接口】删除小蜜机器人意图 | 删除小模型场景中的意图。 |
| ModifyBeebotIntentUserSay | 【小模型接口】修改小蜜机器人意图用户问法 | 修改小模型场景意图用户问法。 |
| ModifyBeebotIntentLgf | 【小模型接口】修改小蜜机器人意图问法模版 | 修改小模型场景意图问法模版。 |
| ModifyBeebotIntent | 【小模型接口】修改小蜜机器人意图 | 修改小模型场景的意图。 |
| CreateBeebotIntentUserSay | 【小模型接口】创建小蜜机器人意图用户问法 | 创建小模型场景的意图问法。 |
| CreateBeebotIntentLgf | 【小模型接口】创建小蜜机器人意图问法模版 | 创建小模型场景意图问法模版。 |
| CreateBeebotIntent | 【小模型接口】创建小蜜机器人意图 | 小模型场景中创建意图。 |
| ListBeebotIntent | 【小模型接口】列表展示小蜜机器人意图 | 小模型场景中展示意图列表。 |
对话外呼
|
API |
标题 |
API概述 |
| TerminateCall | 终止通话 | 通话过程中终止通话。 |
| TaskPreparing | 准备执行任务 | 准备执行任务。 |
| SuspendCallWithFile | 根据文件数据止呼 | 根据文件数据止呼。 |
| SuspendCall | 根据列表数据止呼 | 根据列表数据止呼。 |
| Dialogue | 和机器人对话 | CC回调外呼的机器人对话接口。（已废弃）。 |
| DescribeDialogueNodeStatistics | 查询对话节点数据统计 | 返回任务标签的统计信息。 |
| ListDialogueFlows | 【旧画布接口】查询一个场景下的对话流程列表 | 旧画布场景中查询一个话术下的对话流程列表。 |
| ModifyDialogueFlow | 修改对话流程-旧画布接口 | 修改对话流程，旧画布接口。 |
| DeleteDialogueFlow | 删除对话流程-旧画布接口 | 删除对话流程，旧画布接口。 |
| CreateDialogueFlow | 创建对话流程 -旧画布接口 | 创建对话流程，旧画布接口。 |
标注
|
API |
标题 |
API概述 |
| ModifyAnnotationMission | 修改标注任务 | 修改标注任务状态与名称。 |
| ListIntentions | 标注中心列表查询意图 | 标注中心列表查询意图。 |
| SaveAnnotationMissionTagInfoList | 保存标注标签映射关系 | 批量保存实例标签信息。 |
| SaveAnnotationMissionSessionList | 保存标注chat实例列表 | 保存标注chat实例列表。 |
| ListAnnotationMissionSession | 获取标注任务chat实例列表 | ListAnnotationMissionSession |
| GetAnnotationMissionSummary | 获取标注任务统计信息 | null |
| ListAnnotationMission | 获取标注任务列表 | 获取标注任务列表。 |
| CreateAnnotationMission | 创建标注任务 | 创建标注任务 |
资源标签（旧画布接口）
|
API |
标题 |
API概述 |
| ListTags | 查询话术下的标签-旧画布接口 | 查询话术下的标签，旧画布接口。 |
| DescribeTagHitsSummary | 查询标签统计数据-旧画布接口 | 查询标签统计数据，旧画布接口。 |
| ModifyTagGroups | 修改标签组-旧画布接口 | 修改标签组，旧画布接口。 |
| CreateTag | 创建标签-旧画布使用 | 创建标签，旧画布中使用。 |
通话录音
|
API |
标题 |
API概述 |
| ListScriptRecording | 【小模型接口】查询录音文件列表 | 查询录音文件列表，小模型场景使用。 |
| DownloadScriptRecording | 【小模型接口】下载录音（获取录音地址） | 下载录音（获取录音地址），小模型场景专用。 |
| DownloadRecording | 下载通话录音 | 下载通话录音。 |
外呼任务管理
|
API |
标题 |
API概述 |
| SearchTask | 搜索任务 | 搜索任务。 |
| QueryJobsWithResult | 根据任务结果查询任务 | 根据任务结果查询任务。 |
| GetTaskByUuid | 根据任务ID获取任务 | 根据UUID获取任务。 |
| GetAssignJobsAsyncResult | 获取异步创建外呼任务结果 | 获取异步外呼任务上传结果。 |
| CreateTaskExportTask | 外呼历史导出 | 创建外呼历史导出异步任务。 |
| CreateJobDataParsingTask | 创建任务数据解析任务 | 创建任务数据解析任务。 |
| AssignJobsAsync | 异步创建外呼任务 | 异步创建外呼任务。 |
| AssignJobs | 批量创建外呼任务 | 批量创建外呼任务。 |
| SuspendJobs | 暂停作业 | 暂停作业。 |
| ResumeJobs | 重启暂停的作业 | 重启暂停的作业。 |
| CancelJobs | 取消即将执行或执行中的作业 | 取消创建后即将执行的作业或者执行中的作业（已经在通话中的作业取消无效）。 |
| QueryJobs | 查询作业列表 | 查询作业列表。 |
| ListJobs | 查询多个作业 | 查询多个作业。 |
| DescribeJobDataParsingTaskProgress | 返回一个作业的进度信息 | 获取上传的作业文件解析进度。 |
| DescribeJob | 返回一个作业的对话数据 | 返回一个作业的对话数据。 |
| StartJob | 创建一个作业 | 不经过外呼调度系统直接发起呼叫。该接口只针对白名单用户开放。 |
外呼任务组管理
|
API |
标题 |
API概述 |
| DescribeGroupExecutingInfo | 返回任务执行情况 | 返回任务组内任务执行的情况。 |
| DescribeDsReports | 获取作业组命中标签统计 | DescribeDsReports |
| CreateBatchRepeatJob | 复制任务组重新发起外呼 | 复制已创建的任务组重新发起外呼任务。 |
| ListFlashSmsTemplates | 获取闪信模板 | 使用ListFlashSmsTemplates获取闪信模板。 |
| GetJobDataUploadParams | 获取作业数据上传参数 | 获取作业数据上传参数。 |
| CreateDownloadUrl | 创建下载文件URL | 创建下载中心任务的URL链接。 |
| ListDownloadTasks | 任务下载列表 | 查看下载中心列表。 |
| ListJobsByGroup | 根据作业组查询作业 | 根据作业组查询作业。 |
| CreateJobGroupExportTask | 创建外呼作业组导出任务 | 创建外呼作业组导出任务。 |
| DeleteJobGroup | 删除一个任务组 | 删除一个任务组。 |
| ListJobGroupsAsync | 异步查询任务组列表 | 异步获取外呼任务组列表。当在调用ListJobGroup接口时指定了Async时，使用此接口获取异步ListJobGroup的结果。 |
| ListJobGroups | 查询任务组列表 | 查询外呼任务组列表。 |
| ModifyJobGroup | 修改任务组数据 | 修改智能外呼任务组。 |
| DescribeJobGroup | 查询外呼任务组 | 查询智能外呼任务数据。 |
| CreateJobGroup | 创建外呼任务组 | 创建作业组。 |
场景语音配置
|
API |
标题 |
API概述 |
| DescribeTTSDemo | TTS 试听 | TTS试听。 |
旧画布专用
|
API |
标题 |
API概述 |
| ListGlobalQuestions | 【旧画布接口】查询全局问题列表 | 查询关键问题列表，旧画布接口。 |
| DuplicateScript | 【旧画布接口】复制话术 | 从原有的话术复制一个新的话术（旧画布专用）。 |
| CreateGlobalQuestion | 【旧画布接口】创建全局问题 | 旧画布场景中创建全局问题。 |
| ModifyScriptVoiceConfig | 【旧画布接口】修改场景声音配置 | 修改旧画布场景中场景声音配置。 |
| ModifyGlobalQuestion | 【旧画布接口】修改全局问题 | 旧画布接口中修改全局问题。 |
| DescribeScriptVoiceConfig | 【旧画布接口】返回一个场景声音配置 | 旧画布场景中返回一个场景声音配置。 |
| CreateIntent | 【旧画布接口】创建意图 | 旧画布场景下创建触发意图。 |
| ListScriptVoiceConfigs | 【旧画布接口】查询场景声音配置列表 | 旧画布场景中查询场景声音列表。 |
| DeleteGlobalQuestion | 【旧画布接口】删除全局问题 | 旧画布场景中删除全局问题。 |
| DescribeGlobalQuestion | 【旧画布接口】返回一个全局问题的数据 | 旧画布场景中返回一个全局问题的数据。 |
场景管理
|
API |
标题 |
API概述 |
| ModifyAgentProfile | 修改智能体配置 | 修改智能体配置。 |
| ListApiPlugins | 查询API插件列表 | 查询API插件列表。 |
| ImportScript | 导入场景 | 导入场景。 |
| GetAgentProfile | 获取智能体配置 | 获取智能体配置。 |
| DeleteScriptRecording | 【小模型接口】删除小模型场景中的录音 | 删除小模型场景中已上传的录音。 |
| CreateAgentProfile | 创建智能体配置 | 创建智能配置。 |
| ExportScript | 创建导出场景任务 | 导出一个场景。 |
| RollbackScript | 回滚发布的场景（仅小模型） | 回滚发布的小模型场景。 |
| ListScriptPublishHistories | 【小模型接口】查询外呼小模型场景发布历史列表 | 查询小模型外呼发布历史列表。 |
| ModifyScript | 修改话术信息 | 修改话术信息。 |
| SubmitScriptReview | 提交场景发布审核 | 提交场景发布审核。 |
| WithdrawScriptReview | 撤销话术审核 | 撤销话术审核。 |
| QueryScriptsByStatus | 根据场景状态查询场景信息 | 根据场景状态查询场景信息。 |
| ListScripts | 查询话术列表 | 查询话术列表。 |
| DescribeScript | 返回一个话术的信息 | 返回一个话术的信息。 |
| CreateScript | 创建场景 | 创建场景。 |
| DeleteScript | 删除一个话术 | 删除一个话术。 |
实例管理
|
API |
标题 |
API概述 |
| UntagResources | 删除资源标签 | 删除资源标签。 |
| TagResources | 给实例资源打标签 | 给实例资源打标签。 |
| ListResourceTags | 查询实例资源标签 | 查询实例业务资源的标签。 |
| ListInstances | 查询业务实例列表 | 查询智能外呼业务实例列表。 |
| GetSummaryInfo | 外呼实例总览 | 外呼实例总览。 |
| DeleteInstance | 删除业务实例 | 删除一个智能外呼业务实例。 |
| ModifyInstance | 修改业务实例 | 修改智能外呼业务实例。 |
| DescribeInstance | 查询业务实例信息 | 查询智能外呼业务实例信息。 |
| CreateInstance | 创建业务实例 | 创建一个智能外呼业务实例。 |
号码管理
|
API |
标题 |
API概述 |
| ListOutboundCallNumbers | 查询外呼主叫号码列表 | 查询外呼主叫号码列表。 |
| CreateInstanceBindNumber | 实例绑定号码 | 业务实例绑定号码。 |
| DescribeTenantBindNumber | 租户下的号码绑定业务的情况 | 租户下的号码绑定实例的情况列表。 |
| ListAllTenantBindNumberBinding | 租户绑定的号码列表 | 租户绑定号码列表。 |
其他
|
API |
标题 |
API概述 |
| GenerateUploadUrl | 上传热词表文件 | 上传热词表文件。 |
| GetConcurrentConversationQuota | 获取调用者账号下剩余的并发数 | 获取调用者账号下剩余的并发数。 |
| ListChatbotInstances | 查询云小蜜公有云版本机器人列表 | 查询云小蜜机器人公有云版本实例列表。 |
| GetRealtimeConcurrencyReport | 查询当前并发列表 | 查询当前并发列表。 |
| GetVersion | 获取应用版本信息 | 获取应用版本信息。 |
| GetCurrentConcurrency | 获取实例当前的并发 | 获取实例当前的并发。 |
已作废
|
API |
标题 |
API概述 |
| InflightTaskTimeout | 任务超时 | InflightTaskTimeout |
| PublishScriptForDebug | 发布话术到调试环境 | 发布话术（调试的版本）。 |
| ListAgentProfiles | 获取智能体配置列表（已作废） | 获取该大模型场景下智能体配置的历史发布列表。 |
| GetAgentProfileTemplate | 获取智能体配置模版（已作废） | 获取智能体配置模版。 |
| DeleteAgentProfiles | 删除智能体配置（已作废） | 删除大模型机器人。 |
| PublishScript | 【已废弃】发布话术 | 发布场景。 |
| ModifyOutboundCallNumber | 修改外呼号码-已废弃 | 修改外呼号码，已废弃。 |
| ModifyTTSConfig | 修改旧画布场景的tts配置（旧画布专用，废弃） | 修改旧画布场景的tts配置。 |
| SubmitRecording | 向外呼提交通话录音-已废弃 | 向外呼提交通话录音，已废弃。 |
| GetAsrServerInfo | 【已废弃】获取asr模型列表、热词列表等信息 | 获取asr模型列表、热词列表等信息，已废弃。 |
| DescribeJobGroupExportTaskProgress | 【已废弃】获取任务组导出任务进度 | 获取任务组导出任务进度，已废弃，可使用ListDownloadTasks替换。 |
| ChangeResourceGroup | 【已废弃】更改资源组 | 更改资源组。 |
| ListTagResources | 【已废弃】查询资源标签关系 | 查询资源标签关系。 |
| RecordFailure | ivr记录通话失败-已废弃 | CC提交通话失败原因到外呼业务系统，已废弃。 |
| CreateBatchJobs | 批量创建外呼作业-已废弃 | 批量创建外呼作业，已废弃。 |
| GetNumberDistrictInfoTemplateDownloadUrl | 【已废弃】获取号码归属地模板下载链接 | 获取号码库模板下载链接，已废弃。 |
| SaveEffectiveDays | 保存基础策略有效期-已废弃 | 保存基础策略有效期，已废弃。 |
| DeleteAllNumberDistrictInfo | 【已废弃】删除所有号码归属地信息 | 清空归属地号码库，已废弃。 |
| UploadScriptRecording | 【废弃】上传话术录音 | 上传录音文件。 |
| GetEmptyNumberNoMoreCallsInfo | 【废弃】查询全局维度空号不再外呼功能开关 | 查询全局维度的空号不再外呼功能开关。 |
| ModifyEmptyNumberNoMoreCallsInfo | 【废弃】保存全局维度空号不再外呼功能开关 | 保存全局维度空号不再外呼功能开关。 |
| ModifyBatchJobs | 修改作业组（包括作业）-已废弃 | 修改作业做（包括作业），已废弃。 |
| DeleteOutboundCallNumber | 删除外呼号码-已废弃 | 删除外呼号码，已废弃。 |
| QueryScriptWaveforms | 【废弃】查询旧画布场景声音录音文件列表 | 旧画布接口，查询话术文本的录音列表。 |
| DescribeTTSConfig | 【废弃】查询tts配置信息 | 查询tts配置信息。 |
| DeleteScriptWaveform | 【已废弃】删除话术录音 | 删除话术录音。 |
| SubmitBatchJobs | 将草稿状态的作业组提交执行-已废弃 | 将草稿状态的作业组提交执行，已废弃。 |
| CreateScriptWaveform | 【废弃】旧画布创建场景声音的录音 | 创建播报话术的录音。 |
该文章对您有帮助吗？