转录结果查询接口

参数规范

请求URL: https://asr.ilivedata.com/api/v1/speech/recognize/result

HTTP请求Header:

Header 描述
Content-Type application/json;charset=UTF-8 请求体类型
Accept application/json;charset=UTF-8 接受的返回类型
X-AppId 项目或应用的唯一标识符
X-TimeStamp 请求的UTC时间戳。需要把时间戳按W3C标准格式化,例如: 2010-01-31T23:59:59Z. (http://www.w3.org/TR/xmlschema-2/#dateTime)。
Authorization 签名值

请求方法:POST

请求体:

参数 必需 描述
taskId 必需 任务ID

请求体示例

{
  "taskId": "us_a0cf4d0c-4804-484d-96e1-9ebf1e42d37d_1614329510676"
}

请求签名:

当用户请求Speech Recognition API时,可以使用appId和secretKey对请求做签名,当API收到带签名信息的请求之后,将使用相同的算法验证签名,如果发现签名不一致,API将会返回401给用户。

如果API验证签名一致,且appId对应的用户有权限操作请求的资源,则请求成功,否则API返回401。

通过 HTTP 请求 Header 发送签名

方法: 在请求中加入名为 Authorization 的 Header,值为签名值。如下:

Authorization: Njl86M/jY6zZaZoGhZdGO+GI/8+yGFECusGH1yQHUFE=

签名计算方法

1.构造规范化的请求字符串(Canonicalized Query String)

将请求体JSON字符串以UTF-8字符编码做sha256编码后转换为16进制字符串(注意不是Base64)

CanonicalizedQueryString = hex(sha256(jsonBody))

2.构造被签名字符串 StringToSign ("\n” 代表ASCII里的换行符)

StringToSign = HTTPMethod + "\n" + 
               HostHeaderInLowercase + "\n" + 
               HTTPRequestURI + "\n" + 
               CanonicalizedQueryString <从上一步得到> + "\n" +
               "X-AppId:" + SAME_APPID_IN_HEADER + "\n" + 
               "X-TimeStamp:" + SAME_TIMESTAMP_IN_HEADER

HTTPRequestURI是请求URI的绝对路径,不包含请求串。如果HTTPRequestURI为空,也要保留一个正斜杠 ( / ) 使用 HMAC-SHA256 协议创建基于哈希的消息身份验证代码 (HMAC),然后计算签名。

3.StringToSign作为签名字符串,secretKey作为秘钥,SHA256作为哈希算法

有关 HMAC 的更多信息,请参阅 https://tools.ietf.org/html/rfc2104

4.将上一步的结果转换为BASE64串

5.将BASE64串放入HTTP请求Header的Authorization

签名示例

下面是appId & secretKey的示例

appId=1000
secrectKey=d9e23d93053f49ade2f8fce185acedd4

下面是示例请求体

{"taskId": "us_a0cf4d0c-4804-484d-96e1-9ebf1e42d37d_1614329510676"}

生成CanonicalizedQueryString

a18830926600e82dbb6c464ce60f2c6c62d53ed3f3f24123fc09fbdc4e17b5ff

生成StringToSign

POST
asr.ilivedata.com
/api/v1/speech/recognize/result
a18830926600e82dbb6c464ce60f2c6c62d53ed3f3f24123fc09fbdc4e17b5ff
X-AppId:1000
X-TimeStamp:2021-02-26T09:11:42Z

HMAC计算得到的签名

cv3tQcZpKJhvrivA/pb0vd+FAd0ifrqZ36Fp/Hc05vY=

HTTP响应

Content-Type: application/json;charset=UTF-8 结果为JSON格式,请参考以下示例。

HTTP响应返回json字段说明:

字段名 子字段名 描述
errorCode 错误代码
errorMessage 错误消息
taskId 任务ID
status 任务状态
transcripts 转录文本数组
startTime 起始时间偏移
endTime 结束时间偏移
text 从音频中识别出的文本
speaker 在开启区分讲话人选项时,返回讲话人序号

响应示例

{
    "errorCode": 0,
    "taskId": "us_a0cf4d0c-4804-484d-96e1-9ebf1e42d37d_1614329510676",
    "status": 0,
    "transcripts": [
        {
            "startTime": 0.0,
            "endTime": 4.97,
            "text": "杭州822路公交车经过站点。",
            "speaker": 1
        },
        ...
    ]  
}

错误码:

Http状态码 错误码 错误消息
200 0 此字段省略
429 1104 Out of Rate Limit
429 1105 Out of Quotas
405 1004 Method Not Allowed
411 1007 Not Content Length
400 1002 API Not Found
400 1003 Bad Request
400 2000 Missing Parameter
400 2001 Invalid Parameter
400 2002 Invalid Request
400 2102 Input Too Long
400 2109 Speech Recognition Failed
400 2110 File is invalid
400 2111 Failed to download file
400 2112 TaskId is invalid
401 1102 Unauthorized Client
401 1106 Missing Access Token
401 1107 Invalid Token
401 1108 Expired Token
401 1110 Invalid Client