功能说明
本接口用于将音频文件转写为文本。业务后台通过 HTTPS + JSON 方式调用,服务端基于现有 ASR 能力完成识别后,将结果以 JSON 返回。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/im_open_speech_http_svc/speech_to_text?sdkappid=$SDKAppID&identifier=$identifier&usersig=$usersig&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com新加坡: adminapisgp.im.qcloud.com首尔: adminapikr.im.qcloud.com东京: adminapijpn.im.qcloud.com法兰克福: adminapiger.im.qcloud.com硅谷: adminapiusa.im.qcloud.com雅加达: adminapiidn.im.qcloud.com利雅得: adminapiksa.im.qcloud.com |
v4/im_open_speech_http_svc/speech_to_text | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
100次/秒。
请求包示例
{"EngServiceType": "16k_zh","VoiceFormat": "mp3","Url": "https://example-1250000000.cos.ap-guangzhou.myqcloud.com/audio/hello.mp3"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
EngServiceType | String | 必填 | 引擎类型,决定识别语种/场景。常用取值:16k_zh(中文)、16k_zh_en(中英混)、16k_en(英文)、16k_yue(粤语)等。 |
VoiceFormat | String | 选填 | 音频容器格式,支持 mp3、wav、m4a、opus、flac、ogg 等。 |
Url | String | 必填 | 音频文件可访问 URL。若命中 IM COS 域名(qcloud.com / imcloud.com),服务端会自动重新预签名;为空时返回参数非法错误。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "success","Result": "今天天气怎么样","RequestId": "1234567890abcdef"}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果:OK 表示处理成功,FAIL 表示失败。 |
ErrorCode | Integer | 错误码:0 表示成功,非 0 表示失败。 |
ErrorInfo | String | 错误信息,成功时固定为 success。 |
Result | String | 识别出的文本结果;失败时为空字符串 ""。 |
RequestId | String | 请求追踪 ID,由内部 ASR 引擎下发;前置校验/限频/未开通导致的失败可能为空。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 含义说明 |
140003 | 请求参数非法。常见原因:EngServiceType 为空、Url 为空、请求体 JSON 解析失败。 |
140004 | 请求被限频。单 SdkAppID 或全局请求速率超出限制。 |
140005 | 服务内部错误。请稍后重试;持续出现请联系技术支持。 |
140008 | SdkAppID 未开通语音转文本服务。请在控制台开通后再调用。 |