语音文件异步接口

请求地址:http://api.open.tuputech.com/v3/recognition/speech/recording/async/'your_secretId'
'your_secretId'需替换为您的 secretId,请联系我们为您开通 secretId。

http 请求方法:POST

http Content-type: application/json

并发限制:测试期允许最多同时处理 3 个文件,正式使用请与我们沟通协商

请求示例:

{
  "recording": {
    "url": "http://www.tupu.com/test.mp3",
    "callbackUrl": "http://your_cb.com",
    "roomId": "your_room_id",
    "userId": "your_user_id",
    "forumId": "your_forum_id"
  },
  "timestamp": 1541499770,
  "nonce": 0.8469537531104208,
  "signature": "your_signature"
}

请求参数说明

参数名 类型 是否必填 说明
recording Object 录音文件信息,详见下面说明
timestamp Number 当前的服务器的 Unix 时间戳
nonce Number 随机数
signature String 我们采用的数字证书签名算法是:"RSA-SHA256",签名输出类型是:"base64",具体步骤如下:
1、所有参与签名的参数为:secretId,timestamp,nonce,用英文半角逗号“,”相连,得到sign_string;
2、利用您的私钥,使用算法"RSA-SHA256"签名,输出为 "base64" 格式,得到参数signature的值。
点击管理公钥证书查看如何生成私钥,及如何上传您的公钥用于数字签名的认证;
tasks Array 指定运行的任务 ID 列表

文件限制

大小限制:100M 以内;
允许识别的格式:amr, mp3, wmv, wav, flv;

recording 参数说明:

参数名 类型 是否必填 说明
url String 音频文件地址;大小限制:100M 以内;允许识别的格式:amr, mp3, wmv, wav, flv
callbackUrl String 检测结果的回调地址(支持http, https)。失败重试 2 次,需自行保证回调地址正常
callbackRule String 不传值表示按默认规则回调;all 表示回调全部结果
roomId String 房间 ID
userId String 用户 ID
forumId String 板块 ID ,数据 ID

curl 请求示例

不指定任务

curl -X POST --header 'Content-Type: application/json' \
-d '{
    "recording": [
        {
            "url": "rtmp://pili-Room-4daedc9c7a5db36c325f6609000c0201",
            "callbackUrl": "http://www.tupu.com/callback",
            "roomId": "111111",
            "userId": "23231",
            "forumId": "321313"
        }
    ],
    "timestamp": 1541499770,
    "nonce": 0.8469537531104208,
    "signature": "CsIMcHuWqn/QFEnHWcFEhrB7ydcg5xTKawpRpNqA9Nw2WlCVIDR5jDcyUF85"
}' \
'http://api.open.tuputech.com/v3/recognition/speech/recording/async/your_secretId'

指定任务

curl -X POST --header 'Content-Type: application/json' \
-d '{
    "recording": [
        {
            "url": "rtmp://pili-Room-4daedc9c7a5db36c325f6609000c0201",
            "callbackUrl": "http://www.tupu.com/callback",
            "roomId": "111111",
            "userId": "23231",
            "forumId": "321313",
            "tasks": ["5c8213b9bc807806aab0a574"]
        }
    ],
    "timestamp": 1541499770,
    "nonce": 0.8469537531104208,
    "signature": "CsIMcHuWqn/QFEnHWcFEhrB7ydcg5xTKawpRpNqA9Nw2WlCVIDR5jDcyUF85"
}' \
'http://api.open.tuputech.com/v3/recognition/speech/recording/async/your_secretId'

返回参数说明

服务返回信息的公共结构

参数名 类型 是否必有 说明
signature String 我们采用的数字证书签名算法是:"RSA-SHA256",签名输出类型是:"base64",首先下载图普科技的公钥证书,然后按如下步骤认证:
1、收到的JSON数据经过JSON.parse(),得到JSON对象,记为data;
2、data含两个字段:signature、json;signature是数字签名,json是真正的有效数据的字符串格式;
3、用signature对json进行签名认证,算法:RSA-SHA256,输出类型:base64,得到认证结果;
4、认证通过后,对json进行JSON.parse(),得到JSON数据,详见"json"字段说明。
json String json 字段经过JSON.parse(json)后,得到具体的结果,含:
message:与code相关的文本信息
timestamp:当前的服务器的Unix时间戳。
nonce:随机数。
json内容解析后的结构
参数名 类型 是否必有 说明
code Number 请求的状态码,参考服务公共状态码解析
message String 请求的状态信息
timestamp Number 当前的服务器的Unix时间戳
nonce Number 随机数
[taskId] Object 识别任务的结果,不同识别任务会有特定的taskId和[taskId]信息结构
... ... 其它识别及请求响应结果信息
示例
{
    "signature": "signature_from_tupu_service", 
    "json": "{\"code\":0,\"message\":\"success\",\"nonce\":\"0.5442530125172196\",\"timestamp\":1595318082309}"
}

任务结果信息

注意:同步请求及异步回调结果都是此结构,不同的是 json 里的信息

请求的同步响应

json 字段数据示例:

{
  "result": {
    "requestId": "tupu_request_id",
    "url": "http://www.tupu.com/test.mp3",
    "callbackUrl": "http://your_cb.com",
    "roomId": "your_room_id",
    "userId": "your_user_id",
    "forumId": "your_forum_id"
  },
  "code": 0,
  "message": "success",
  "nonce": "0.01627771095362096",
  "timestamp": 1552391372490
}

结果的数据结构

参数名 类型 是否必有 说明
result Array 详见以下 result 数据结构

result 数据结构

参数名 类型 是否必有 说明
requestId String 客户提交的音频的唯一请求 id,后续可以通过该 id 查到音频的相关信息
url String 音频文件地址
callbackUrl String 检测结果的回调地址
roomId String 房间 ID
userId String 用户 ID
forumId String 板块 ID ,数据 ID

回调结果

回调请求

http 请求地址:request callbackUrl 参数值里的地址

http 请求方法:POST

http Content-type: application/json

发送端判断回调是否成功

http 状态为 200 则表示回调成功,所以客户端成功收到回调后,需尽快响应并携带 200 状态码,防止回调重复发送

回调结果 json 里的公共结构

结果的数据结构

参数名 类型 是否必有 说明
requestId String 客户提交的音频的唯一请求 id
speechInfo Object 语音文件信息
roomId String 房间 ID
userId String 用户 ID
forumId String 板块 ID ,数据 ID
任务 id Object 审核任务的 id,结构详见以下描述
speechInfo
参数名 类型 是否必有 说明
duration Number 语音文件时长,单位:秒

results matching ""

    No results matching ""