开启云端实时语音识别

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

ASR object

ASR 参数

HotWord string

热词表，用于提升识别准确率。单个热词限制："热词|权重"，单个热词不超过30个字符（最多10个汉字）。多个热词用英文逗号分割，最多支持128个热词。

Params object

额外参数

engine_model_type string

可选值: [16k_zh, 16k_en, 16k_ar]

默认值: 16k_zh

引擎模型类型。 16k_zh：中文通用； 16k_en：英文通用； 16k_ar：阿拉伯语；

VADSilenceSegmentation Int

可选值: >= 200 and <= 2000

默认值: 500

用于设置用户说话停顿多少秒后，不再将两句话视为一句。单位为 ms。

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

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。