文档

GetSyncResult - 获取实时质检结果

更新时间:
目前该API接口已标记为弃用,推荐使用替代API:Qualitycheck(2019-01-15) - GetResult

获取热线实时质检结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
JsonStrstring

完整 JSON 字符串信息,具体内容参见以下详细信息。

{"pageNumber":1,"pageSize":10,"requiredFields":"asrResult,agent,status,errorMessage,reviewStatus,reviewResult,score,taskId,reviewer,resolver,recording.name,recording.duration,recording.url,hitResult,business","startTime":"2020-12-25 00:00:00","endTime":"2020-12-31 23:59:59"}
BaseMeAgentIdlong

业务空间 Id

请求参数 JSON 字符串信息

属性值类型是否必须说明
isSchemeDataInteger是否查询新版智能对话分析中的数据,取值:0 否;1 是,默认值为 0。
taskIdString使用上传质检数据后返回的任务 ID来查询,一般来说,要么根据 taskId 或者 tid 查询,要么根据时间范围进行查询,所以 taskId、tid、startTime/endTime、二者必选其一。
tidString对话唯一标识,比如一个录音的唯一标识,一般来说,要么根据 tid 查询,要么根据时间范围进行查询,所以 taskId 与 tid 与 startTime/endTime 三者必选其一
startTimeString按任务上传时间(API 调用时间)区间查询,区间的开始时间,格式'yyyy-MM-dd HH:mm:ss'。
endTimeString按任务上传时间(API 调用时间)区间查询,区间的结束时间,格式'yyyy-MM-dd HH:mm:ss'。
pageSizeInteger每页返回的数据数,要求大于 0,小于 100,默认 10。
pageNumberInteger要求返回的第几页的数据,默认 1。
countTotalBoolean是否返回分页数据中的总条数,默认 true,数据量较大时,不返回总条数会提升接口返回结果的速度。
requiredFieldsString返回结果需要包括哪些字段,多个字段用逗号分隔,请按需选择;可选字段:taskId(任务 ID),score(得分),status(状态),recording(文件信息),recording.dataSet(数据集名称),asrResult(转写结果),hitResult(质检结果),comments(复核意见),agent(坐席信息);默认值:score,status,taskId,hitResult,reviewHistory
excludeFieldsString返回结果中不需要包括哪些字段,通常是子字段,多个字段用逗号分隔,取值举例:hitResult.hits。
ruleIdsList命中的规则 ID 列表,筛选出命中指定规则的数据。
customerServiceNameString客服姓名。
customerServiceIdString客服 ID。
callerString主叫号码。
calleeString被叫号码。
callIdString通话 ID。
skillGroupNameString技能组名称。
hitStatusInteger命中状态,取值:0(无规则命中);1(有规则命中)。
reviewStatusInteger复核状态,取值:0(未复核);1(已复核)。
assignStatusInteger文件分配状态,0:未分配;1:已分配
scoreTypeInteger根据质检得分筛选时的筛选类型,**必须与 totalScore 一起使用,**取值:1(返回质检得分等于 totalScore 的数据);2(返回质检得分小于 totalScore 的数据);3(返回质检得分大于 totalScore 的数据)。
reviewerLong质检员 id,只返回分配给该质检员的文件。
totalScoreInteger质检得分分值,根据质检得分筛选,必须与 scoreType 一起使用
durationTypeInteger根据录音时长筛选时的筛选类型,**必须与 duration 一起使用,**取值:1(返回录音时长等于 duration 的数据);2(返回录音时长小于 duration 的数据);3(返回录音时长大于 duration 的数据)。
durationInteger录音时长,根据录音时长筛选,必须与 durationType 一起使用,单位:秒。
fileNameString文件名称,需要提供完整的文件名称,不支持模糊搜索。
remark1String自定义数据 1,调用SyncQualityCheck.json接口上传质检数据时所提供。
remark2String自定义数据 2,调用SyncQualityCheck.json接口上传质检数据时所提供。
remark3String自定义数据 3,调用SyncQualityCheck.json接口上传质检数据时所提供。
sortFieldString按指定参数进行排序,目前仅质检得分和自定义数据 1/2/3 支持排序,所以可输入的值为:score/remark1/remark2/remark3。
sortTypeString排序规则,取值:desc(降序);asc(升序)。

返回参数

名称类型描述示例值
object
RequestIdstring

请求 id

76DB5D8C-5BD9-42A7-B527-5AF3A5F****
Successboolean

请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null 表示失败

true
ResultCountIdstring

内部字段,请忽略。

xxx
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

出错时表示出错详情,成功时为 successful。

successful
PageNumberinteger

页码

1
PageSizeinteger

每页条数。

10
Countinteger

总条数。

1
Dataobject []

查询结果。

Statusinteger

任务当前状态,可能值:0(未完成);1(已完成),调用方可根据此字段判断任务是否完成;非 0、1 表示出错,错误详情可查看 errorMessage 字段。

1
ErrorMessagestring

当 status 是非 0、1 时表示错误详情。

xxxx
Reviewerstring

分配的质检员的用户名。

张三
CreateTimestring

任务创建时间。

2019-07-24T19:31Z
ReviewStatusinteger

复核状态;可能值:0(未复核);1(已复核)。

1
TaskNamestring

内部字段,请忽略。

xxx
Commentsstring

复核意见。

xxx
ReviewResultinteger

复核准确性,可能值:0(错误);1(正确);2(部分正确);3(待复核)。

3
Scoreinteger

质检得分,满分 100。

100
TaskIdstring

任务 ID。

20201231de3d34ec-40fa-4a55-8d27-76ea*****
Resolverstring

实际复核的质检员。

张三
AsrResultobject []

转写结果(对话文本)

Wordsstring

对话内容。

您好,很高兴为您服务
Beginlong

本句话的开始时间,是相对起始点的开始时间偏移,单位 ms。

340
EmotionValueinteger

情绪能量值 1-10,值越高情绪越强烈。

6
Endlong

本句话的结束时间,是相对起始点的结束时间偏移,单位 ms。

3000
SpeechRateinteger

本句平均语速,单位:字/分钟。

221
Rolestring

对话内容角色,可能值:客服、客户。

客服
SilenceDurationinteger

内部字段,请忽略。

11
HitResultobject []

规则命中结果

Typestring

命中规则所关联的规则类型。

2
ReviewResultinteger

复核准确性;可能值:0(错误);1(正确)。

1
Namestring

命中的规则名称。

测试规则
Ridstring

命中的规则 ID。

1211
Hitsobject []

具体命中位置信息,以句子维度,返回命中句子中具体命中了规则中哪个条件,是哪几个字命中的

KeyWordsobject []

返回当前句中是哪几个字命中了规则,也就是需要高亮展示的关键字

Frominteger

需要高亮展示的关键字从第几个字符开始,取值范围从 0 开始,最大值为当句话字符总数减 1。高亮的字包含 from。

2
Tointeger

需要高亮展示的关键字到第几个字符结束,最大值为当句话字符总数减 1。高亮的字不包含 to,例如一句话为“不可能给你退货的”,from=0,to=3,那么需要高亮的关键字就是“不可能”三个字。

5
Valstring

具体的关键字内容。

投诉
Cidstring

命中的条件 ID。

66666
Cidarray

命中的条件 ID 列表。

string

命中的条件 ID 列表。

["1","3"]
Phraseobject

当前命中规则的句子详情

Wordsstring

这个角色说的一句话。

我要投诉
Beginlong

本句话的开始时间,是相对起始点的开始时间偏移,单位 ms。

440
EmotionValueinteger

情绪能量值 1-10,值越高情绪越强烈。

6
Endinteger

本句话的结束时间,是相对起始点的结束时间偏移,单位 ms。

4000
SpeechRateinteger

当句话的语速

234
Rolestring

对话内容角色,可能值:客服、客户、系统。

客服
SilenceDurationinteger

内部字段,请忽略。

1
Recordingobject

录音文件信息

Calleestring

被叫号码。

1888888***
Remark3string

自定义数据 3。

xxx
Businessstring

业务线名称。

客服部
Urlstring

录音文件地址,用于录音播放。

http://aliyun.com/xxx.wav
PrimaryIdstring

内部字段,请忽略

xxxx
Remark1string

自定义数据 1。

xxx
Remark2string

自定义数据 2。

xxx
CallTypeinteger

呼叫类型:

  • 1:呼出
  • 3:呼入
1
Callerstring

主叫号码

0108888****
CallIdstring

通话 ID。

xxx
DataSetNamestring

内部字段,请忽略。

xxx
Durationlong

对话总字数

232
DurationAudiolong

通话时长。

120
Namestring

录音文件名称。

123123.wav
Idstring

文件 ID,即请求参数中的 callId,若未指定则会随机生成一个。

xxxx
CallTimestring

录音生成时间戳,精确到毫秒。

1563967699000
Agentobject

客服信息

Namestring

客服姓名

李四
SkillGroupstring

技能组名称

客服组
Idstring

客服 ID。

12221

示例

正常返回示例

JSON格式

{
  "RequestId": "76DB5D8C-5BD9-42A7-B527-5AF3A5F****",
  "Success": true,
  "ResultCountId": "xxx",
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "Count": 1,
  "Data": [
    {
      "Status": 1,
      "ErrorMessage": "xxxx",
      "Reviewer": "张三",
      "CreateTime": "2019-07-24T19:31Z\t",
      "ReviewStatus": 1,
      "TaskName": "xxx",
      "Comments": "xxx",
      "ReviewResult": 3,
      "Score": 100,
      "TaskId": "20201231de3d34ec-40fa-4a55-8d27-76ea*****",
      "Resolver": "张三",
      "AsrResult": [
        {
          "Words": "您好,很高兴为您服务",
          "Begin": 340,
          "EmotionValue": 6,
          "End": 3000,
          "SpeechRate": 221,
          "Role": "客服",
          "SilenceDuration": 11
        }
      ],
      "HitResult": [
        {
          "Type": "2",
          "ReviewResult": 1,
          "Name": "测试规则",
          "Rid": "1211",
          "Hits": [
            {
              "KeyWords": [
                {
                  "From": 2,
                  "To": 5,
                  "Val": "投诉",
                  "Cid": "66666"
                }
              ],
              "Cid": [
                "[\"1\",\"3\"]"
              ],
              "Phrase": {
                "Words": "我要投诉",
                "Begin": 440,
                "EmotionValue": 6,
                "End": 4000,
                "SpeechRate": 234,
                "Role": "客服",
                "SilenceDuration": 1
              }
            }
          ]
        }
      ],
      "Recording": {
        "Callee": "1888888***",
        "Remark3": "xxx",
        "Business": "客服部",
        "Url": "http://aliyun.com/xxx.wav\t",
        "PrimaryId": "xxxx",
        "Remark1": "xxx",
        "Remark2": "xxx",
        "CallType": 1,
        "Caller": "0108888****\t",
        "CallId": "xxx",
        "DataSetName": "xxx",
        "Duration": 232,
        "DurationAudio": 120,
        "Name": "123123.wav",
        "Id": "xxxx",
        "CallTime": "1563967699000"
      },
      "Agent": {
        "Name": "李四",
        "SkillGroup": "客服组",
        "Id": "12221"
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-19OpenAPI 变更为 deprecated,即将下线看变更集
变更项变更内容
API 弃用说明(deprecated)OpenAPI 变更为 deprecated,即将下线
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)
文档反馈