创建一个新的实时字幕任务,用于实时转录音频流为文本。
接口说明
本接口用于创建一个新的实时字幕任务,用于实时转录音频流为文本。
QPS 限制
本接口的单用户 QPS 限制为 20 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:CreateRtcAsrTask |
create |
*Domain
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
Mode |
string |
是 |
流模式,live 或者 rtc。live 为正常直播流如 rtmp。 |
live |
SDKAppID |
string |
否 |
ARTC 应用 ID。 说明
当参数 Mode 取值为 rtc 时,此参数必填,否则不生效。 |
appId |
ChannelID |
string |
否 |
房间号。 说明
参数 Mode 取值为 rtc 时,此参数必填,否则不生效。 |
channelId |
RtcUserId |
string |
否 |
推流用户 ID。 说明
参数 Mode 取值为 rtc 时,此参数必填,且只能填写一个,否则不生效。 |
user1 |
StreamURL |
string |
否 |
直播流地址。 说明
参数 Mode 取值为 live 时,此参数必填,否则不生效。 |
rtmp://xxx |
Language |
string |
是 |
原音频语言,取值:
|
cn |
CallbackURL |
string |
是 |
回调地址。 |
http://xxx.com |
AuthKey |
string |
否 |
校验 AuthKey,用于生成回调信息的 MD5 签名。 说明
回调时会在请求头中加两个鉴权字段,"SIG-TIME"表示当前时间戳,"ASR-SIG"表示 md5 鉴权字段,"ASR-SIG"字段的生成规则为 md5( |
abcd |
TranslateEnabled |
boolean |
否 |
开启翻译。 |
true |
TargetLanguages |
string |
否 |
目标翻译语种,取值:
|
en |
AutoTerminateEnabled |
boolean |
否 |
断流最大延迟,超过则自动关闭任务。默认值:false。 |
true |
AutoTerminateDelay |
integer |
否 |
自动断流延时,单位秒,取值:1~10 秒。 |
5 |
ReportInterval |
integer |
否 |
回调上报间隔,单位毫秒,取值范围:-1~500 毫秒。
|
5 |
回调示例
通过用户提供的 CallbackUrl,以 HTTP POST 请求的形式将 JSON 格式的数据放在请求体(Request Body)中回调至指定地址。回调参数 Content 详细说明及回调流程请参见:交互流程与实现,示例如下所示:
{
"task_id": "asr-cf8c70d7-3b8d-496c-98f8-4785******",
"sdk_app_id": "",
"channel_id": "",
"rtc_user_id": "",
"callback_time_stamp": 1723433155645,
"language": "cn",
"content": "{\"header\":{\"nls_task_id\":\"af95c5cc332549f689f3153bc9******\",\"task_key\":\"tl_2977564_17234*****\",\"namespace\":\"SpeechTranscriber\",\"name\":\"TranscriptionResultChanged\",\"task_id\":\"413937911b874146b5796******\",\"message_id\":\"abfc9e9994e748a38499e1******\",\"status_text\":\"Success.\",\"status\":20000000},\"payload\":{\"result\":\"在这里与各位相聚\",\"confidence\":0.0,\"words\":[{\"startTime\":0,\"text\":\"在这\",\"endTime\":510},{\"startTime\":510,\"text\":\"里与\",\"endTime\":1020},{\"startTime\":1020,\"text\":\"各位\",\"endTime\":1530},{\"startTime\":1530,\"text\":\"相聚\",\"endTime\":2040}],\"index\":0,\"time\":2040,\"fixed_result\":\"\",\"unfixed_result\":\"\",\"status\":0}}"
}
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
Description |
string |
结果描述,为 success 时成功,有错误信息则返回。 |
success |
RequestId |
string |
网关请求 ID。 |
7FF5417D-06E9-5A2C-9A70-581F6149E6C1 |
RetCode |
integer |
状态码。返回 2000 表示成功,返回其他表示异常。 |
2000 |
TaskId |
string |
生成的任务 ID。 |
asr-a6ac15e0-9118-4b4c-9e64-306163a0**** |
示例
正常返回示例
JSON
格式
{
"Description": "success",
"RequestId": "7FF5417D-06E9-5A2C-9A70-581F6149E6C1",
"RetCode": 2000,
"TaskId": "asr-a6ac15e0-9118-4b4c-9e64-306163a0****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。