文档

API概览

更新时间:
本产品(智能外呼/2019-12-26)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例管理

API标题API概述
CreateInstance创建业务实例创建一个智能外呼业务实例。
DescribeInstance查询业务实例信息查询智能外呼业务实例信息。
ListInstances查询业务实例列表查询智能外呼业务实例列表。
ModifyInstance修改业务实例修改智能外呼业务实例。
DeleteInstance删除业务实例删除一个智能外呼业务实例。

话术管理

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配置信息。
DescribeTTSDemoTTS 试听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回调外呼的机器人对话接口。(已废弃)。
RecordFailureivr记录通话失败CC提交通话失败原因到外呼业务系统。

意图

API标题API概述
DeleteIntent删除意图删除意图。
ModifyIntent修改意图修改意图。
DescribeIntent获取一个意图返回一个意图。
ListIntents查询意图列表查询意图列表。

其他

API标题API概述
CreateBatchRepeatJob创建作业分组以及批处理作业
CreateJobDataParsingTask创建任务数据解析任务
CreateJobGroupExportTask创建外呼作业组导出任务
DeleteContactBlockList删除禁止外呼名单
DeleteContactWhiteList删除外呼白名单
DescribeDialogueNodeStatistics查询对话节点数据统计
DescribeDsReports获取作业组命中标签统计
DescribeGroupExecutingInfo返回任务执行情况
DescribeIntentStatistics查询意图统计信息
DescribeJobDataParsingTaskProgress返回一个作业的进度信息获取上传的作业文件解析进度。
DescribeJobGroupExportTaskProgress获取任务组导出任务进度
GetAsrServerInfo获取asr模型列表、热词列表等信息
GetAfterAnswerDelayPlayback查询接听后延迟播报时间
GetEffectiveDays查询基础策略有效期
QueryJobsWithResult根据任务结果查询任务
SaveAfterAnswerDelayPlayback保存接听后延迟播报时间
SaveBaseStrategyPeriod编辑基础策略有效时间窗口编辑基础策略有效时间窗口。
SaveContactBlockList保存禁止外呼名单添加该实例下“禁呼名单”。
SaveContactWhiteList保存外呼白名单保存外呼白名单。
SaveEffectiveDays保存基础策略有效期
SaveMaxAttemptsPerDay保存被叫号码每日拨打上限
SuspendCall根据列表数据止呼
SuspendCallWithFile根据文件数据止呼
ChangeResourceGroup更改资源组
GetTaskByUuid【废弃】根据UUID获取任务
ListResourceTags查询资源标签关系查询资源标签。
ListTagResources查询资源标签关系查询资源标签关系。
TagResources给资源打标签给资源打标签。
UntagResources删除资源标签删除资源标签。
GetConcurrentConversationQuota获取调用者账号下剩余的并发数
GetCurrentConcurrency获取实例瞬时的并发
TerminateCall终止外呼
ListDownloadTasks任务下载列表
CreateDownloadUrl创建下载文件url
SearchTask搜索任务
CreateNumberDistrictInfoParsingTask创建号码归属地信息解析任务
CreateNumberDistrictInfoDownloadUrl号码归属地信息下载地址
GetNumberDistrictInfoTemplateDownloadUrl获取号码归属地模板下载链接
ApplyNumberDistrictInfoParsingResult完成号码归属地解析
DismissNumberDistrictInfoParsingResult清除号码库解析任务
DeleteAllNumberDistrictInfo删除所有号码归属地信息
DescribeNumberDistrictInfoStatus号码库解析进度状态
ListChatbotInstances查询外呼实例列表
CreateInstanceBindNumber实例绑定号码业务实例绑定号码。
CreateTaskExportTask外呼历史导出创建外呼历史导出异步任务。
DescribeTenantBindNumber租户下的实例绑定号码情况号码绑定实例列表。
ListAllTenantBindNumberBinding租户绑定的号码列表
GenerateUploadUrlGenerateUploadUrl
UploadScriptRecording【废弃】上传话术录音上传录音文件。
DownloadScriptRecording下载录音(获取录音地址)下载录音(获取录音地址)。
ListScriptRecording查询录音文件列表查询录音文件列表。
DeleteScriptRecording【废弃】删除录音删除录音。
ListSchedulerInstances列出计划任务实例

已作废

API标题API概述
QueryScriptWaveforms查询话术录音文件列表(已作废)查询话术文本的录音列表。
ImportScript导入话术(已废弃)导入话术。
DeleteScriptWaveform删除话术录音(已作废)删除话术录音。
CreateScriptWaveform创建播报话术的录音(已作废)创建播报话术的录音。