语音流任务关闭接口
1. 接口介绍
在语音流结束或业务流程需结束审核时,关闭语音流任务。
2. 请求
2.1 请求地址
- v3.1(推荐)
- v3
区域 | 请求地址 |
---|---|
国内 | https://api.speech.tuputech.com/v3.1/recognition/speech/stream/close/<secretId> |
区域 | 请求地址 |
---|---|
国内 | https://api.speech.tuputech.com/v3/recognition/speech/stream/close/<secretId> |
提示
<secretId>
需替换为您的应用 SID
,请联系客户经理为您开通及配置。关于 SID
详见 常见问题(FAQ)。
2.2 请求方法
POST
2.3 请求头
Content-Type: application/json
2.4 超时时间及异常处理
建议配置超时时间 1
秒,在 HTTP 响应状态码非 200
或业务状态码不为 0
时进行重试。
2.5 请求参数说明
- v3.1(推荐)
- v3
参数名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|
requestId | String | 是 | 任务 ID |
timestamp | Number | 是 | 当前服务器的 Unix 时间戳 |
nonce | Number | 是 | 随机数 |
signature | String | 是 |
|
参数名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|
speechStream | Array<CloseSpeechStream> | 是 | 任务信息,详见 CloseSpeechStream 参数说明。由于兼容原因,数组长度需为 1 |
timestamp | Number | 是 | 当前服务器的 Unix 时间戳 |
nonce | Number | 是 | 随机数 |
signature | String | 是 |
|
CloseSpeechStream 参数说明
参数名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|
requestId | String | 是 | 任务 ID |
2.6 请求示例
- v3.1(推荐)
- v3
{
"requestId": "<requestId>",
"timestamp": 1685000000,
"nonce": 1685000000,
"signature": "<signature>"
}
{
"speechStream": [
{
"requestId": "<requestId>"
}
],
"timestamp": 1685000000,
"nonce": 1685000000,
"signature": "<signature>"
}
3. 同步响应
3.1 响应参数说明
参数名称 | 类型 | 说明 |
---|---|---|
signature | String | 同步响应或回调请求签名,由图普使用私钥签名,在需要时,您可以通过 图普公钥 进行验签以确保此响应内容来自图普(与您调用接口时使用的公私钥不同)。验签步骤:
|
json | String | 同步响应或回调请求经过 JSON 转义后的字符串,需进一步解析得到业务数据。
|
json 参数说明
- v3.1(推荐)
- v3
参数名称 | 类型 | 是否必有 | 说明 |
---|---|---|---|
code | Int | 是 | 状态码,详见 业务状态码 |
result | Result | 是 | 返回结果,详见 Result 数据结构 |
message | String | 是 | 返回信息 |
nonce | String | 是 | 随机数 |
timestamp | String | 是 | 当前服务器的 Unix 时间戳 |
Result 数据结构
参数名称 | 类型 | 是否必有 | 说明 |
---|---|---|---|
requestId | string | 是 | 任务 ID |
status | string | 是 | 关闭状态,closed :已关闭,其他值表明流不存在或重复关闭 |
参数名称 | 类型 | 是否必需 | 说明 |
---|---|---|---|
code | Int | 是 | 状态码,详见 业务状态码 |
result | Result | 是 | 返回结果,详见 Result 数据结构 |
message | String | 是 | 返回信息 |
nonce | String | 是 | 随机数 |
timestamp | String | 是 | 当前服务器的 Unix 时间戳 |
Result 数据结构
参数名称 | 类型 | 是否必有 | 说明 |
---|---|---|---|
requestId | string | 是 | 任务 ID |
status | string | 是 | 关闭状态,closed :已关闭,其他值表明流不存在或重复关闭 |
3.2 响应示例
- v3.1(推荐)
- v3
{
"result": {
"requestId": "<requestId>",
"status": "closed"
},
"code": 0,
"message": "success",
"nonce": 1685000000,
"timestamp": 1685000000
}
{
"result": {
"requestId": "<requestId>",
"status": "closed"
},
"code": 0,
"message": "success",
"nonce": 1685000000,
"timestamp": 1685000000
}