本产品（
智能对话分析/2019-01-15）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
数据上传
| API | 标题 | API概述 |
|---|---|---|
| UploadAudioData | 上传音频质检 | 上传离线语音质检数据（录音会话文件）：适用于热线坐席场景。场景1：天然集成阿里云呼叫中心（CCC），无需开发，可以一键开启推送通话数据到SCA；场景2：与自有呼叫中心系统对接，呼叫中心每产生一条录音，就将录音推送至SCA进行分析。 |
| UploadDataV4 | 上传文本质检V4 | 上传离线文本质检数据（纯文本会话）：适用于在线坐席场景。 推荐使用UploadDataV4接口。 UploadDataV4与UploadData的差异：1、V4仅支持POST请求。2、V4支持更长的JsonStr。 |
| UploadData | 上传文本质检 | 上传离线文本质检数据（纯文本会话）：适用于在线坐席场景。 推荐使用UploadDataV4接口。 UploadDataV4与UploadData的差异：1、V4仅支持POST请求。2、V4支持更长的JsonStr。 |
| UpdateQualityCheckData | 更新随录数据 | 更新会话随录数据（三方业务字段），便于更多业务维度统计和查询。 |
质检规则&方案
| API | 标题 | API概述 |
|---|---|---|
| 质检规则管理 | 质检规则管理 | |
| AddRuleV4 | 新增规则（新版质检） | 对应前端功能位置：质检规则配置-新建。专有云URL：ip:port/api/client/UpdateRuleById.json。 |
| UpdateRuleV4 | 更新规则（新版质检） | 对应前端功能位置：质检规则配置-更新。专有云URL：ip:port/api/client/UpdateRuleById.json。 |
| ListRulesV4 | 获取规则列表（新版质检） | 对应前端功能位置：质检规则配置-列表。专有云URL：ip:port/api/rule/GetRulesCountList.json。 |
| GetRuleV4 | 获取规则详情（新版质检） | 对应前端功能位置：质检规则配置-查询。专有云URL：ip:port/api/client/GetRuleById.json。 |
| DeleteRuleV4 | 删除规则（新版质检） | 对应前端功能位置：质检规则配置-删除。专有云URL：ip:port/api/client/DeleteRule.json。 |
| TestRuleV4 | 测试规则（新版质检） | 对应前端功能位置：质检规则配置-测试。专有云URL：ip:port/api/client/TestRule.json。 |
| 质检方案管理 | 质检方案管理 | |
| CreateQualityCheckScheme | 新建质检方案 | 对应前端功能位置：质检方案管理-新建质检任务。专有云URL：ip:port/api/qcs/CreateQualityCheckScheme.json。 |
| UpdateQualityCheckScheme | 更新质检方案 | 更新质检方案。 |
| GetQualityCheckScheme | 获取质检方案详情 | 对应前端功能位置：质检方案管理-查询。专有云URL：ip:port/api/qcs/GetQualityCheckScheme.json。 |
| ListQualityCheckScheme | 获取质检方案列表 | 获取质检方案列表。 |
| DeleteQualityCheckScheme | 删除质检方案 | 对应前端功能位置：质检方案管理-任一数据右侧删除。专有云URL：ip:port/api/qcs/DeleteQualityCheckScheme.json。 |
| UpdateRuleToScheme | 更新质检方案中的规则 | 对应前端功能位置：质检方案管理-新建质检任务或编辑-关联质检规则。专有云URL：ip:port/api/qcs/UpdateRuleToScheme.json。 |
| CreateCheckTypeToScheme | 新增质检维度 | 对应前端功能位置：质检方案管理-新增质检维度或编辑-新增质检维度。专有云URL：ip:port/api/qcs/CreateCheckTypeToScheme.json。 |
| UpdateCheckTypeToScheme | 更新质检维度 | 对应前端功能位置：质检方案管理-新建质检任务或编辑-质检维度名称旁编辑图标。专有云URL：ip:port/api/qcs/UpdateCheckTypeToScheme.json。 |
| 质检规则-分类 | 质检规则-分类 | |
| AddRuleCategory | 新增规则类型 | 新增规则类型。 |
| GetRuleCategory | 获取规则类型列表 | 获取规则类型列表。 |
| DelRuleCategory | 删除规则类型 | 删除规则类型。 |
| 质检规则-适用业务 | 质检规则-适用业务 | |
| AddBusinessCategory | 新增业务类型 | 新增业务类型。 |
| DeleteBusinessCategory | 删除适用业务 | 删除适用业务。 |
| GetBusinessCategoryList | 获取适用业务列表 | 获取适用业务列表。 |
呼叫中心-质检任务管理
| API | 标题 | API概述 |
|---|---|---|
| CreateSchemeTaskConfig | 新建质检任务 | 对应前端功能位置：质检方案管理-新建质检任务。专有云URL：ip:port/api/task/CreateSchemeTaskConfig.json。 |
| UpdateSchemeTaskConfig | 更新质检任务 | 对应前端功能位置：任务管理-任一数据右侧编辑。专有云URL：ip:port/api/task/UpdateSchemeTaskConfig.json。 |
| ListSchemeTaskConfig | 批量获取质检任务 | 对应前端功能位置：任务管理。专有云URL：ip:port/api/task/ListSchemeTaskInfo.json。 |
数据集
| API | 标题 | API概述 |
|---|---|---|
| SubmitQualityCheckTask | 新建数据集质检任务 | 新建数据集质检任务。 |
| SaveConfigDataSet | 保存数据集话者角色配置 | 来保存数据集话者角色配置。 |
| ListDataSet | 批量获取数据集 | 对应前端功能位置：数据集管理。专有云URL：ip:port/api/dataset/ListDataSet.json。 |
| DeleteDataSet | 删除数据集 | 删除数据集。 |
质检结果
| API | 标题 | API概述 |
|---|---|---|
| 质检结果 | 质检结果 | |
| GetResult | 获取质检结果 | 查询质检结果：部分结果需要入参requiredFields明确指定方可返回。服务地址（Region）请选择为杭州（cn-hangzhou）。 |
| GetResultToReview | 获取质检结果详情用于复核 | 获取指定文件的质检结果详情数据，用于文件复核。详情数据包括：转写文本、录音地址、命中检测项信息，有了这些信息，就可以听录音、查看转写文本、查看检测项的命中位置，进行文件复核了。 |
| 会话组质检 | 会话组质检 | |
| ListSessionGroup | 获取会话组列表 | 对应前端功能位置：任务管理-查看结果-任务结果-（会话组结果）上方标签页。专有云URL：ip:port/api/session/group/ListSessionGroup.json。根据会话组ID字段将多通会话聚合，进行统一管理。需要传入sessionGroupId字段，详情参考UploadData和UploadAudioData接口说明。 |
| AssignReviewerBySessionGroup | 会话组分配 | 对应前端功能位置：质检方案管理-任务结果-会话组-批量分配。专有云URL：ip:port/api/job/AssignReviewerBySessionGroup.json。 |
| RevertAssignedSessionGroup | 批量回收（会话组维度） | 对应前端功能位置：质检方案管理-任务结果-会话组-批量回收。专有云URL：ip:port/api/job/RevertAssignedSessionGroup.json。 |
| 申诉&复核&分配 | 申诉&复核&分配 | |
| AssignReviewer | 分配质检员 | 进行手动分配质检员。 |
| SubmitReviewInfo | 保存复核结果（仅支持旧版智能对话分析） | 保存复核结果，仅支持旧版智能对话分析。 |
| BatchSubmitReviewInfo | 批量复核 | 对应前端功能位置：任务管理-任务结果-批量复核 对应私有云URL：ip:port/api/qcsBatchSubmitReviewInfo.json 对筛选范围内的所有数据进行批量复核操作。 注意！此操作涉及大量更新操作，可能生效有一定延迟。 |
| SubmitComplaint | 提交申诉 | 来提交申诉。 |
| HandleComplaint | 处理申诉 | 处理申诉。 |
| RevertAssignedSession | 批量回收（单通会话维度） | 对应前端功能位置：任务管理-任务结果-批量回收。专有云URL：ip:port/api/job/RevertAssignedSession.json。 |
语音模型训练
| API | 标题 | API概述 |
|---|---|---|
| 热词模型 | 热词模型 | |
| CreateAsrVocab | 新建热词组 | 将一组语音热词上传到服务端，并获取返回的热词ID。 |
| UpdateAsrVocab | 更新热词组 | 更新热词词表。 |
| GetAsrVocab | 获取指定热词组的详情信息 | 获取指定热词组的详情信息。 |
| ListAsrVocab | 获取热词组列表 | 获取热词组列表，不包括具体内容。 |
| DeleteAsrVocab | 删除热词组 | 删除热词组。 |
| 语言模型 | 语言模型 | |
| GetCustomizationConfigList | 获取语言模型列表 | 获取语言模型列表。 |
| DeleteCustomizationConfig | 删除语言模型 | 删除语言模型。 |
| 模型效果评测 | 模型效果评测 | |
| SubmitPrecisionTask | 新建语音识别检测任务 | 新建语音识别检测任务。服务地址（Region）请选择为杭州（cn-hangzhou）。 |
| GetPrecisionTask | 获取语音识别检测任务详情 | 获取语音识别检测任务详情。 |
| ListPrecisionTask | 获取语音识别检测任务列表 | 获取语音识别检测任务列表。服务地址（Region）请选择为杭州（cn-hangzhou）。 |
| DeletePrecisionTask | 删除语音识别检测任务 | 删除语音识别检测任务。 |
| 人工评测 | 人工评测 | |
| GetNextResultToVerify | 获取下一条文件详情用于人工校验 | 获取下一条文件详情用于人工校验。 |
| VerifyFile | 保存单个文件的校验结果 | 保存单个文件的校验结果。 |
| VerifySentence | 保存单个句子的校验结果 | 保存单个句子的校验结果。 |
| ListBusinessSpaces | 获取适用业务列表 | 查询业务空间实例列表。 |
系统管理
| API | 标题 | API概述 |
|---|---|---|
| 复核管理 | 复核管理 | |
| CreateTaskAssignRule | 新建复核任务自动分配规则 | 新建复核任务自动分配规则。 |
| UpdateTaskAssignRule | 更新复核任务自动分配规则 | 更新复核任务自动分配规则。 |
| ListTaskAssignRules | 获取复核任务自动分配规则列表 | 获取复核任务自动分配规则列表。 |
| DeleteTaskAssignRule | 删除复核任务自动分配规则 | 删除复核任务自动分配规则。 |
| 预警管理 | 预警管理 | |
| CreateWarningConfig | 新建预警配置 | 来新建预警配置。 |
| UpdateWarningConfig | 更新预警配置 | 更新预警配置。 |
| ListWarningConfig | 获取预警配置列表 | 获取预警配置列表。 |
| DeleteWarningConfig | 删除预警配置 | 删除预警配置。 |
| 安全管理 | 安全管理 | |
| UpdateUserConfig | 修改隐私号码设置 | 修改隐私号码设置。 |
| 技能组管理 | 技能组管理 | |
| CreateSkillGroupConfig | 新建配置 | 新建配置。 |
| UpdateSkillGroupConfig | 更新配置 | 调用UpdateSkillGroupConfig更新配置。 |
| GetSkillGroupConfig | 根据ID获取技能组规则配置详情 | 根据ID获取指定的配置。 |
| ListSkillGroupConfig | 获取配置列表 | 调用ListSkillGroupConfig获取配置列表。 |
| DeleteSkillGroupConfig | 删除配置 | 删除配置。 |
| 同义词 | 同义词 | |
| AddThesaurusForApi | 新建同义词 | 新建同义词。 |
| EditThesaurusForApi | 更新同义词 | 更新同义词。 |
| GetThesaurusBySynonymForApi | 获取同义词 | 获取同义词。 |
| DelThesaurusForApi | 删除同义词 | 删除同义词。 |
不推荐或白名单开放
| API | 标题 | API概述 |
|---|---|---|
| 实时质检 | 实时质检 | |
| GetSyncResult | 获取实时质检结果 | 获取热线实时质检结果。 |
| SyncQualityCheck | 进行实时质检 | 进行热线实时质检。 |
| UpdateSyncQualityCheckData | 维护录音信息 | 来维护实时质检完成后的录音信息，用来复核时播放录音，并且维护录音信息后，任务状态将变为已完成。 |
| 其他 | 其他 | |
| RestartAsrTask | 对质检失败的文件进行重试 | 对质检失败的文件进行重试。 |
| DeleteSchemeTaskConfig | 删除质检任务 | 对应前端功能位置：暂无。专有云URL：ip:port/api/task/DeleteSchemeTaskConfig.json。 |
新版本（V4）弃用
| API | 标题 | API概述 |
|---|---|---|
| 规则管理 | 规则管理 | |
| DeleteRule | 删除质检规则 | 对应前端功能位置：质检规则配置-删除。专有云URL：ip:port/api/client/DeleteRule.json。 |
| GetRuleById | 根据ID获取规则详情 | 对应前端功能位置：质检规则配置-编辑 对应私有云URL：ip:port/api/client/GetRuleById.json。 |
| GetRulesCountList | 批量获取质检规则列表 | 对应前端功能位置：质检规则配置-列表。专有云URL：ip:port/api/rule/GetRulesCountList.json。 |
| UpdateRuleById | 新建或更新质检规则 | 对应前端功能位置：质检规则配置-新建&更新。专有云URL：ip:port/api/client/UpdateRuleById.json。 |
| UpdateRule | 更新规则 | 更新规则信息。 |
| UploadRule | 创建规则 | 创建规则。一般用于客户需要自己提供规则编辑界面的场景。 |
| GetRuleDetail | 获取规则的明细信息 | 获取规则的明细信息。 |
| GetRule | 获取规则的基本信息 | 获取规则的基本信息。 |
| ListRules | 获取规则列表 | 获取规则列表。 |
| InvalidRule | 删除规则 | 删除规则。 |
| 评分管理 | 评分管理 | |
| UpdateSubScoreForApi | 编辑评分子项 | 编辑评分子项。 |
| UpdateScoreForApi | 编辑评分大项 | 编辑评分大项。 |
| InsertSubScoreForApi | 创建评分小项 | 创建评分小项。 |
| InsertScoreForApi | 创建评分大项 | 创建评分大项。 |
| GetScoreInfo | 获取全部评分项信息 | 获取全部评分项信息。 |
| DeleteSubScoreForApi | 删除评分小项 | 删除评分小项。 |
| DeleteScoreForApi | 删除评分大项 | 删除评分大项。 |
| 其他 | 其他 | |
| UploadDataSync | 文本实时质检 | 文本实时质检。 |
| GetHitResult | 获取质检结果命中规则的集合 | 查询指定范围内的质检文件所命中的规则的集合，可参考页面中呼叫中心质检-结果展示-高级搜索框中的命中规则。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| GetRuleV4Str | 获取规则详情（新版质检） | GetRuleV4兼容SDK1.0的版本，返回类型为String，如果您使用是SDK2.0,请使用GetRuleV4接口． |
| CreateUser | 创建用户 | 添加用户。 |
| DeleteUser | 删除用户 | 该接口已废弃，请勿接入。 |
| ListRoles | 获取角色列表 | 获取角色列表。 |
| ListUsers | 获取用户列表 | 获取用户列表。服务地址（Region）请选择为杭州（cn-hangzhou）。 |
| UpdateUser | 编辑用户 | 编辑用户，可以批量修改用户的角色。 |