如果您在提交语音异步检测任务后想中止检测,您可以调用/green/voice/cancelscan接口取消检测任务。

接口说明

业务接口:/green/voice/cancelscan,表示取消语音检测任务。

您可以调用该接口取消语音检测任务。已完成的语音检测任务,无法被取消。您只可以取消在队列中或者正在检测的语音检测任务。关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK概览

计费信息:该API接口为免费接口。取消语音检测任务时,已完成检测的时长部分仍将计费。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个JSON数组,字段说明如下:
名称 类型 是否必选 示例值 描述
body JSONArray ["taskId1","taskId2"] 要取消的taskId列表,最多支持取消100个任务。

返回数据

返回结果说明,请参见返回结果

返回body中的Data字段是JSON数组,每一个元素包含如下字段:
名称 类型 示例值 描述
code Integer 200 错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

msg String OK 返回消息的响应消息。
dataId String dataId1 对应的请求中的dataId
taskId String taskId1 该检测任务的ID。

示例

请求示例
[
    "taskId1",
    "taskId2"
]
返回示例
{
    "code":200,
    "msg":"OK",
    "requestId":"AD87F1D1-A675-4F82-8D67-ED43B6FFA876",
    "data":[
        {
            "code":200,
            "msg":"ok",
            "dataId":"dataId1",
            "taskId":"taskId1"
        },
        {
            "code":200,
            "msg":"ok",
            "dataId":"dataId2",
            "taskId":"taskId2"
        }
    ]
}