本产品（
智能外呼/2019-12-26）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
实例管理
| API | 标题 | API概述 |
|---|---|---|
| CreateInstance | 创建业务实例 | 创建一个智能外呼业务实例。 |
| DescribeInstance | 查询业务实例信息 | 查询智能外呼业务实例信息。 |
| ListInstances | 查询业务实例列表 | 查询智能外呼业务实例列表。 |
| ModifyInstance | 修改业务实例 | 修改智能外呼业务实例。 |
| DeleteInstance | 删除业务实例 | 删除一个智能外呼业务实例。 |
大模型场景管理
| API | 标题 | API概述 |
|---|---|---|
| DeleteAgentProfiles | 删除智能体配置 | 删除大模型机器人。 |
| GetAgentProfile | 获取智能体配置 | 获取智能体配置。 |
| ListAgentProfiles | 获取智能体配置列表 | 获取该大模型场景下智能体配置的历史发布列表。 |
| CreateAgentProfile | 创建智能体配置 | 创建智能配置。 |
| ModifyAgentProfile | 修改智能体配置 | 修改智能体配置。 |
| GetAgentProfileTemplate | 获取智能体配置模版 | 获取智能体配置模版。 |
话术管理
| API | 标题 | API概述 |
|---|---|---|
| CreateGlobalQuestion | 创建全局引用话术 | 创建全局引用话术。 |
| CreateIntent | 创建触发话术节点的意图 | 创建触发话术节点的意图。 |
| CreateScript | 创建话术 | 创建话术。 |
| DeleteGlobalQuestion | 删除全局引用话术 | 删除全局引用话术。 |
| DeleteScript | 删除一个话术 | 删除一个话术。 |
| ModifyGlobalQuestion | 修改全局引用话术 | 修改全局引用话术。 |
| ModifyScript | 修改话术信息 | 修改话术信息。 |
| ModifyScriptVoiceConfig | 修改话术配置 | 修改话术配置。 |
| ModifyTTSConfig | 修改话术的tts配置 | 修改话术的tts配置。 |
| DescribeGlobalQuestion | 返回一个全局的话术的数据 | 返回一个全局的话术的数据。 |
| DescribeScript | 返回一个话术的信息 | 返回一个话术的信息。 |
| DescribeScriptVoiceConfig | 返回一个话术片段的声音配置 | 返回一个话术片段的声音配置。 |
| ListScripts | 查询话术列表 | 查询话术列表。 |
| ListScriptVoiceConfigs | 查询话术录音配置列表 | 查询话术录音列表。 |
| ListTags | 查询话术下的标签 | 查询话术下的标签。 |
| QueryScriptsByStatus | 根据话术状态查询话术 | 根据话术状态查询话术。 |
| ListDialogueFlows | 查询一个话术下的对话流程列表 | 查询一个话术下的对话流程列表。 |
| PublishScript | 发布话术 | 发布场景。 |
| PublishScriptForDebug | 发布话术到调试环境 | 发布话术（调试的版本）。 |
| RollbackScript | 回滚发布的话术 | 回滚发布的话术。 |
| SubmitScriptReview | 提交话术审核 | 提交话术审核。 |
| WithdrawScriptReview | 撤销话术审核 | 撤销话术审核。 |
| ExportScript | 导出一个话术 | 导出一个话术。 |
| InflightTaskTimeout | 任务超时 | |
| TaskPreparing | 准备执行任务 | 准备执行任务。 |
| DuplicateScript | 复制话术 | 从原有的话术复制一个新的话术。 |
话术声音配置
| API | 标题 | API概述 |
|---|---|---|
| DescribeTTSConfig | 【废弃】查询tts配置信息 | 查询tts配置信息。 |
| DescribeTTSDemo | TTS 试听 | TTS试听。 |
任务组管理
| API | 标题 | API概述 |
|---|---|---|
| CreateJobGroup | 创建外呼任务 | 创建作业组。 |
| DescribeJobGroup | 查询任务数据 | 查询智能外呼任务数据。 |
| ModifyJobGroup | 修改任务数据 | 修改智能外呼任务。 |
| ListJobGroups | 查询任务列表 | 查询外呼任务列表。 |
| ListJobGroupsAsync | 异步查询任务列表 | 异步获取外呼任务列表。当在调用ListJobGroup接口时指定了Async时，使用此接口获取异步ListJobGroup的结果。 |
| DeleteJobGroup | 删除一个任务 | 删除一个任务。 |
任务管理
| API | 标题 | API概述 |
|---|---|---|
| CreateBatchJobs | 批量创建外呼作业 | 批量创建外呼作业。 |
| StartJob | 创建一个作业 | 不经过外呼调度系统直接发起呼叫。该接口只针对白名单用户开放。 |
| ModifyBatchJobs | 修改作业组（包括作业） | 修改作业做（包括作业）。 |
| DescribeJob | 返回一个作业的对话数据 | 返回一个作业的对话数据。 |
| ListJobs | 查询多个作业 | 查询多个作业。 |
| QueryJobs | 查询作业列表 | 查询作业列表。 |
| ListJobsByGroup | 根据作业组查询作业 | 根据作业组查询作业。 |
| CancelJobs | 取消即将执行或执行中的作业 | 取消创建后即将执行的作业或者执行中的作业（已经在通话中的作业取消无效）。 |
| ResumeJobs | 重启暂停的作业 | 重启暂停的作业。 |
| SubmitBatchJobs | 将草稿状态的作业组提交执行 | 将草稿状态的作业组提交执行。 |
| SuspendJobs | 暂停作业 | 暂停作业。 |
通话录音
| API | 标题 | API概述 |
|---|---|---|
| DownloadRecording | 下载通话录音 | 下载通话录音。 |
资源标签
| API | 标题 | API概述 |
|---|---|---|
| CreateTag | 创建标签 | 创建标签。 |
| ModifyTagGroups | 修改标签组 | 修改标签组。 |
| DescribeTagHitsSummary | 查询标签统计数据 | 查询标签统计数据。 |
标注
| API | 标题 | API概述 |
|---|---|---|
| CreateAnnotationMission | 创建标注任务 | |
| SaveAnnotationMissionTagInfoList | 保存标注标签映射关系 | 批量保存实例标签信息。 |
| SaveAnnotationMissionSessionList | 保存标注chat实例列表 | 保存标注chat实例列表。 |
| GetAnnotationMissionTagInfoList | 获取标注标签列表 | |
| ModifyAnnotationMission | 修改标注任务 | 修改标注任务状态与名称。 |
| ListAnnotationMissionSession | 获取标注任务chat实例列表 | |
| ListAnnotationMission | 获取标注任务列表 | 获取标注任务列表。 |
| GetAnnotationMissionSummary | 获取标注任务 |
对话外呼
| API | 标题 | API概述 |
|---|---|---|
| CreateDialogueFlow | 创建对话流程 | 创建对话流程。 |
| CreateOutboundCallNumber | 创建外呼号码 | 创建外呼号码。 |
| DeleteOutboundCallNumber | 删除外呼号码 | 删除外呼号码。 |
| DeleteDialogueFlow | 删除对话流程 | 删除对话流程。 |
| ModifyOutboundCallNumber | 修改外呼号码 | 修改外呼号码。 |
| ModifyDialogueFlow | 修改对话流程 | 修改对话流程。 |
| ListOutboundCallNumbers | 查询外呼主叫号码列表 | 查询外呼主叫号码列表。 |
| ListScriptPublishHistories | 查询外呼发布历史列表 | 查询外呼发布历史列表。 |
| ListGlobalQuestions | 查询关键问题列表 | 查询关键问题列表。 |
| AssignJobs | 批量创建外呼任务 | 批量创建外呼任务。 |
| SubmitRecording | 向外呼提交通话录音 | 向外呼提交通话录音。 |
| Dialogue | 和机器人对话 | CC回调外呼的机器人对话接口。（已废弃）。 |
| RecordFailure | ivr记录通话失败 | CC提交通话失败原因到外呼业务系统。 |
意图
| API | 标题 | API概述 |
|---|---|---|
| DeleteIntent | 删除意图 | 删除意图。 |
| ModifyIntent | 修改意图 | 修改意图。 |
| DescribeIntent | 获取一个意图 | 返回一个意图。 |
| ListIntents | 查询意图列表 | 查询意图列表。 |
其他
已作废
| API | 标题 | API概述 |
|---|---|---|
| GenerateUploadUrl | GenerateUploadUrl | |
| QueryScriptWaveforms | 查询话术录音文件列表（已作废） | 查询话术文本的录音列表。 |
| ImportScript | 导入话术（已废弃） | 导入话术。 |
| DeleteScriptWaveform | 删除话术录音（已作废） | 删除话术录音。 |
| CreateScriptWaveform | 创建播报话术的录音（已作废） | 创建播报话术的录音。 |