创建实时语音转文字或翻译_视频直播(LIVE)-阿里云帮助中心

使用说明

本接口用于创建一个新的实时字幕任务，用于实时转录音频流为文本。

QPS限制

本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateRtcAsrTask	系统规定参数。取值：CreateRtcAsrTask。
Mode	String	是	live	流模式，live或者rtc。live为正常直播流如rtmp。
SDKAppID	String	否	appId	ARTC应用ID。说明当参数Mode取值为rtc时，此参数必填，否则不生效。
ChannelID	String	否	channelId	房间号。说明参数Mode取值为rtc时，此参数必填，否则不生效。
RtcUserId	String	否	user1	推流用户ID。说明参数Mode取值为rtc时，此参数必填，且只能填写一个，否则不生效。
StreamURL	String	否	rtmp://xxx	直播流地址。说明参数Mode取值为live时，此参数必填，否则不生效。
Language	String	是	cn	原音频语言，取值：日语：ja。粤语：yue。中英文自由说：fspk。英文：en。中文：cn。
CallbackURL	String	是	http://xxx.com	回调地址。
AuthKey	String	否	abcd	校验AuthKey，用于生成回调信息的MD5签名。说明回调时会在请求头中加两个鉴权字段，"SIG-TIME"表示当前时间戳，"ASR-SIG"表示md5鉴权字段，"ASR-SIG"字段的生成规则为md5(`${SIG-TIME}/${callbackurl}/${authKey}`)
TranslateEnabled	Boolean	否	true	开启翻译。
TargetLanguages	String	否	en	目标翻译语种，取值：中文：cn。英文：en。日文：ja。
AutoTerminateEnabled	Boolean	否	true	断流最大延迟，超过则自动关闭任务。默认值：false。
AutoTerminateDelay	Long	否	5	自动断流延时，单位秒，取值：1~10秒。
ReportInterval	Long	否	5	回调上报间隔，单位毫秒，取值范围：-1~500毫秒。 -1：不接受中间结果，只接受整句回调。 0或不设置：实时上报回调结果。 <=500毫秒：周期性间隔上报回调结果。

回调示例

通过用户传入的CallbackUrl，回调用户的内容，详细内容可参考：交互流程与实现，示例如下所示：

{
    "task_id": "asr-cf8c70d7-3b8d-496c-98f8-478508cd2d84",
    "sdk_app_id": "",
    "channel_id": "",
    "rtc_user_id": "",
    "callback_time_stamp": 1723433155645,
    "language": "cn",
    "content": "{\"header\":{\"nls_task_id\":\"af95c5cc332549f689f3153bc9a9e1c4\",\"task_key\":\"tl_2977564_1723433152\",\"namespace\":\"SpeechTranscriber\",\"name\":\"TranscriptionResultChanged\",\"task_id\":\"413937911b874146b5796b06709f670c\",\"message_id\":\"abfc9e9994e748a38499e19110040ec5\",\"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}}"
  }

返回数据

名称	类型	示例值	描述
Description	String	success	结果描述，为success时成功，有错误信息则返回。
RequestId	String	7FF5417D-06E9-5A2C-9A70-581F6149E6C1	网关请求ID。
RetCode	Long	2000	状态码。返回2000表示成功，返回其他表示异常。
TaskId	String	asr-a6ac15e0-9118-4b4c-9e64-306163a0****	生成的任务ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=CreateRtcAsrTask
&Mode=live
&SDKAppID=appId
&ChannelID=channelId
&RtcUserId=user1
&StreamURL=rtmp://xxx
&Language=cn
&CallbackURL=http://xxx.com
&AuthKey=abcd
&TranslateEnabled=true
&TargetLanguages=en
&AutoTerminateEnabled=true
&AutoTerminateDelay=5
&ReportInterval=5
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateRtcAsrTaskResponse>
    <Description>success</Description>
    <RequestId>7FF5417D-06E9-5A2C-9A70-581F6149E6C1</RequestId>
    <RetCode>2000</RetCode>
    <TaskId>asr-a6ac15e0-9118-4b4c-9e64-306163a0****</TaskId>
</CreateRtcAsrTaskResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Description" : "success",
  "RequestId" : "7FF5417D-06E9-5A2C-9A70-581F6149E6C1",
  "RetCode" : 2000,
  "TaskId" : "asr-a6ac15e0-9118-4b4c-9e64-306163a0****"
}

错误码

访问错误中心查看更多错误码。