| 内容 | 说明 |
|---|---|
| 请求协议 | http[s] (为提高安全性,强烈推荐https) |
| 请求地址 | 哼唱识别:https://cn-east-1.api.xf-yun.com/v1/private/s9884ba49 音乐识别:https://cn-east-1.api.xf-yun.com/v1/private/s29ebee0d 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
| 请求方式 | POST |
| 接口鉴权 | 签名机制,详情请参照下方鉴权说明 |
| 字符编码 | UTF-8 |
| 响应格式 | 统一采用JSON格式 |
| 开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
| 适用范围 | 任意操作系统,但因不支持跨域不适用于浏览器 |
| 音频属性 | 采样率8/16k、位长8/16bit、单/双声道 |
| 音频格式 | mp3、speex |
| 音频大小 | 文件base64编码后不超过10M |
https://cn-east-1.api.xf-yun.com/v1/private/s9884ba49?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iMkdUVmN2Y0NQdDcyMWxnUUxseHhCNzVZS1lzb3RaMHM3TWh3WHJaTUNQdz0i&host=cn-east-1.api.xf-yun.com&date=Thu%2C+31+Mar+2022+02%3A42%3A08+GMT| 参数 | 类型 | 必须 | 说明 | 示例 |
|---|---|---|---|---|
| host | string | 是 | 请求主机 | cn-east-1.api.xf-yun.com |
| date | string | 是 | 当前时间戳,RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z") | Thu, 31 Mar 2022 02:42:08 GMT |
| authorization | string | 是 | 使用base64编码的签名相关信息(签名基于hamc-sha256计算) | 参考下方详细生成规则 |
api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"host: $host\ndate: $date\n$request-line请求url = https://cn-east-1.api.xf-yun.com/v1/private/s9884ba49
date = "Thu, 31 Mar 2022 02:42:08 GMT"host: cn-east-1.api.xf-yun.com
date: Thu, 31 Mar 2022 02:42:08 GMT
POST /v1/private/s9884ba49 HTTP/1.1signature_sha=hmac-sha256(signature_origin,$apiSecret)signature=base64(signature_sha)APISecret = "apisecretXXXXXXXXXXXXXXXXXXXXXXX"
date = "Thu, 31 Mar 2022 02:42:08 GMT"signature="2GTVcvcCPt721lgQLlxxB75YKYsotZ0s7MhwXrZMCPw="api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="2GTVcvcCPt721lgQLlxxB75YKYsotZ0s7MhwXrZMCPw="authorization = base64(authorization_origin)
示例结果为:
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iMkdUVmN2Y0NQdDcyMWxnUUxseHhCNzVZS1lzb3RaMHM3TWh3WHJaTUNQdz0i| HTTP Code | 说明 | 错误描述信息 | 解决方法 |
|---|---|---|---|
| 401 | 缺少authorization参数 | {"message":"Unauthorized"} | 检查是否有authorization参数,详情见authorization参数详细生成规则 |
| 401 | 签名参数解析失败 | {“message”:”HMAC signature cannot be verified”} | 检查签名的各个参数是否有缺失是否正确,特别确认下复制的api_key是否正确 |
| 401 | 签名校验失败 | {“message”:”HMAC signature does not match”} | 签名验证失败,可能原因有很多。 1. 检查api_key,api_secret 是否正确 。 2.检查计算签名的参数host,date,request-line是否按照协议要求拼接 。 3. 检查signature签名的base64长度是否正常(正常44个字节) 。 |
| 403 | 时钟偏移校验失败 | {“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”} | 检查服务器时间是否标准,相差5分钟以上会报此错误 |
HTTP/1.1 403 Forbidden
Date: Mon, 30 Nov 2020 02:34:33 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
"message": "HMAC signature does not match, a valid date or x-date header is required for HMAC Authentication"
}答:音乐识别:通过听筒收集音乐播放信息,系统自动识别并检索出所播放的歌曲。 哼唱识别:用户对着话筒哼唱小段歌曲,系统自动识别并检索出所哼唱的歌曲。
答:目前支持采样率8/16k、位长8/16bit、单/双声道的mp3或speex格式的音频。
答:目前支持WebAPI应用平台。