StartRealtimeASRTask

2026-09-18

POST

https://cloud-realtime-asr-api.zegotech.cn/

开启云端实时语音识别任务，并把语音识别实例加入 RTC 对话中。

Request

Query Parameters

Action string必填

可选值: [StartRealtimeASRTask]

接口原型参数

https://cloud-realtime-asr-api.zegotech.cn?Action=StartRealtimeASRTask

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

RoomId string必填

RTC 房间 Id

RecognitionRange integer

可选值: [0, 1]

识别范围。0：房间内所有流，1：指定 StreamList。

ASR object

ASR 参数

Vendor string

可选值: [Tencent, AliyunParaformer, AliyunFunASR, AliyunQwenAudioASR, VolcSeedASR, Microsoft]

默认值: Tencent

ASR 厂商。可参考配置 ASR 参数说明。若需要阿里、微软识别厂商，请联系 ZEGO 商务开通。

Params object

厂商参数，具体使用方式参考配置 ASR 中的 Params 参数说明。

VADSilenceSegmentation number

可选值: >= 200 and <= 2000

默认值: 500

用于设置用户说话停顿多少秒后，不再将两句话视为一句。单位为 ms，范围 [200，2000]，默认为 500。详细说明请参考配置 ASR - 断句识别。

HotWord string已废弃

该参数已废弃。请通过 Params 厂商参数设置。

StreamList object[]

需要识别的流列表，RecognitionRange 参数为 1 时生效。

Array[

StreamId string必填

需要识别的流 ID。

ASR object

ASR 参数

Vendor string

可选值: [Tencent, AliyunParaformer, AliyunFunASR, AliyunQwenAudioASR, VolcSeedASR, Microsoft]

默认值: Tencent

ASR 厂商。可参考配置 ASR 参数说明。若需要阿里、微软识别厂商，请联系 ZEGO 商务开通。

Params object

厂商参数，具体使用方式参考配置 ASR 中的 Params 参数说明。

VADSilenceSegmentation number

可选值: >= 200 and <= 2000

默认值: 500

用于设置用户说话停顿多少秒后，不再将两句话视为一句。单位为 ms，范围 [200，2000]，默认为 500。详细说明请参考配置 ASR - 断句识别。

HotWord string已废弃

该参数已废弃。请通过 Params 厂商参数设置。

EnableTranslation boolean

是否开启翻译。

Translation object

翻译 LLM 配置项

Vendor string必填

可选值: [DoubaoSeedTranslation, QwenMT]

调用 LLM 供应商。

SourceLanguage string必填

源语言

TargetLanguage string必填

目标语言

LLM objectrequired

用于翻译的 LLM 参数。

Url string必填

调用 LLM 接口地址。不同 Vendor 不同：

Vendor 为 DoubaoSeedTranslation 时：https://ark.cn-beijing.volces.com/api/v3/responses
Vendor 为 QwenMT 时：https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions

ApiKey string必填

LLM 服务提供商用于认证的参数。

Model string必填

所调用的 LLM 模型名称，必填。不同供应商支持的模型不同。

Params object

LLM 或应用平台的请求参数，选填。

对于 OpenAI 协议，可配置如 max_tokens, temperature, stream 等参数。
对于其他应用平台，可填写平台支持的参数。

]

AdvancedConfig object

高级配置参数。

MaxIdleTime integer

可选值: >= 30 and <= 1800

默认值: 120

RTC 房间内超过 MaxIdleTime 没有人推流，后台自动停止识别任务，单位为秒。

EnableTranslation boolean

是否开启翻译。默认不开启。

Translation object

翻译 LLM 配置项

Vendor string必填

可选值: [DoubaoSeedTranslation, QwenMT]

调用 LLM 供应商。

SourceLanguage string必填

源语言

TargetLanguage string必填

目标语言

LLM objectrequired

用于翻译的 LLM 参数。

Url string必填

调用 LLM 接口地址。不同 Vendor 不同：

Vendor 为 DoubaoSeedTranslation 时：https://ark.cn-beijing.volces.com/api/v3/responses
Vendor 为 QwenMT 时：https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions

ApiKey string必填

LLM 服务提供商用于认证的参数。

Model string必填

所调用的 LLM 模型名称，必填。不同供应商支持的模型不同。

Params object

LLM 或应用平台的请求参数，选填。

对于 OpenAI 协议，可配置如 max_tokens, temperature, stream 等参数。
对于其他应用平台，可填写平台支持的参数。

SubtitleType integer

字幕下发类型，默认值为 0。
0: 不下发；
1: 仅下发识别结果（如用户说中文"你好"，则下发"你好"）；
2: 仅下发翻译结果（如用户说中文"你好"，则下发翻译后的"Hello"）；
3: 同时下发识别结果和翻译结果（如用户说中文"你好"，则同时下发"你好"和"Hello"）。
若需要客户端展示UI，则推荐配置 1、2 或 3。详情见展示字幕。

CallbackConfig object

回调配置。

HostTag string

可以设置最多两个回调地址用于监听任务过程中所发生的事件。通过该参数指定该任务的回调发送到哪个地址。具体 tag 值需联系 ZEGO 技术支持预先配置好，当前支持 Custom1、Custom2。

Responses

开始任务成功

application/json

数据结构
按数据结构生成的示例

Schema

Code integer

返回码，0 表示成功，其他值表示失败。详情请参考返回码说明。

Message string

请求结果说明

RequestId string

请求 ID

Data object

TaskId string

任务的唯一标识。

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "3151527792559699732",
  "Data": {
    "TaskId": "1920370518175780864"
  }
}

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "3151527792559699732",
  "Data": {
    "TaskId": "1920370518175780864"
  }
}

StartRealtimeASRTask

https://cloud-realtime-asr-api.zegotech.cn/

Request

Query Parameters

Body

Responses​

Responses