StartRealtimeASRTask

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, AliyunGummy, Microsoft]

默认值: Tencent

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

Params object

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

VADSilenceSegmentation number

可选值: >= 200 and <= 2000

默认值: 500

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

PauseInterval number

可选值: >= 200 and <= 2000

用于设置用户说话停顿多少秒内，将两句话视为一句，即 ASR 多句拼接。单位为 ms，范围 [200，2000]。仅当此值大于 VADSilenceSegmentation 时，才会启用 ASR 多句拼接。详细说明请参考配置 ASR - 断句识别。

HotWord string已废弃

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

StreamList object[]

需要识别的流列表，RecognitionRange 参数为 1 时生效。当 RecognitionRange 参数为 1 该参数不能为空。

Array[

StreamId string必填

需要识别的流 ID。

]

AdvancedConfig object

高级配置参数。

MaxIdleTime integer

可选值: >= 30 and <= 1800

默认值: 120

RTC 房间内超过 MaxIdleTime 没有真实用户，后台自动停止识别任务，单位为秒。

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"
  }
}