同步审核接口

请求规范

• 请求 URL:

https://asafe.ilivedata.com/api/v1/audio/check

• 接口描述:

音频审核同步接口，信息提交后，会对音频进行检测，检测结果会在返回结果中展示。

• 支持格式:

1.音频文件格式支持：wav、mp3、aac、amr、3gp、m4a、wma、ogg、ape 等市场主流格式

2.音频时长需小于1分钟

• HTTP 请求Header:

• 请求方法:POST

• 请求体JSON对象：

• 请求体示例:

  JSON Response
  
      {
      "type":1,
      "lang":"zh-CN",
      "audio":"http://xxx.xxx.com/xxxx",
      "userId": "testUser"
      }  
  

• 请求签名:

当用户请求Audio Submit 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 & audio的示例

appId=1000
secrectKey=d9e23d93053f49ade2f8fce185acedd4
audio_url="http://xxx.xxx.com/xxxx"

下面是示例请求体

{
 "type": 1,
 "audio":"http://xxx.xxx.com/xxxx",
 "userId": "12345678"
}

生成CanonicalizedQueryString

b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118

生成StringToSign

 POST
 asafe.ilivedata.com
 /api/v1/audio/check/submit
 b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118
 X-AppId:1000
 X-TimeStamp:2020-07-31T07:59:03Z

HMAC计算得到的签名

H0ZXsKUaiRotpxSiXW6+RgKRwnxHXy3qwlVzavs9iHo=

HTTP响应

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

HTTP响应返回json字段说明：

audioSpams：

tags：

subTags:

• 响应示例：

  JSON response

    {
        "errorCode": 0,
        "code": 0,
        "result": 审核结果,
        "taskId": 每条请求唯一标识,
        "audioSpams": [
        {
            "startTime": 违规片段开始时间,
            "endTime": 违规片段结束时间,
            "text": 音频文本命中对应的识别结果,
            "tags": [{
                "tag": 违规一级分类代码,
                "tagName": 违规一级分类名称,
                "tagNameEn": 违规一级分类英文名称,
                "level": 分类级别,
                "subTags": [{
                    "subTag": 违规二级类别代码,
                    "subTagName": 违规二级类别名称,
                    "subTagNameEn": 违规二级类别英文名称,
                    "wordList": [
                        违规词
                    ]
                }]
            }]
        },
        {
            "startTime": 违规片段开始时间,
            "endTime": 违规片段结束时间,
            "vpr": 声纹命中,
            "tags": [{
                "tag": 违规一级分类代码,
                "tagName": 违规一级分类名称,
                "tagNameEn": 违规一级分类英文名称,
                "level": 分类级别,
                "subTags": [{
                    "subTag": 违规二级类别代码,
                    "subTagName": 违规二级类别名称,
                    "subTagNameEn": 违规二级类别英文名称,
                }]
            }]
        }
        ],
        "audioText": 整段识别文本,
        "language": 音频语种,
        "businessResult": {
        	"isNoise": "1"
        }
    }
  

错误码