文档

CreateMeetingTrans - 创建实时会议

更新时间:
一键部署

创建实时会议。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

PUT /openapi/meeting-trans

请求参数

名称类型必填描述示例值
bodyobject

请求 body。

AppKeystring

管控台创建的项目 AppKey。

JV1sRTisRMi****
MeetingKeystring

用户设置的会议标识,在会中查询或会后结束回调时会原样返回。

meeting_123
AudioFormatstring

音频编码格式,PCM(无压缩的 PCM 文件或 WAV 文件)或 OPUS(压缩的 OPUS 文件)。

pcm
AudioPackagestring

音频打包方式,基于听悟约定的 Protobuf 格式封装多路音频流时设置为 multi。

multi
AudioSampleRateinteger

音频采样率,当前支持:16000、8000(仅支持单路中文)。

16000
AudioBitRateinteger

会议上传音频采样位数,当前支持:16。

16
AudioLanguagestring

音频转写使用的语言模型。 cn:中文。 en:英文。 yue:粤语。 fspk:中英文自由说。

cn
RealtimeResultEnabledboolean

是否开启会中实时结果返回,默认是 true。

true
RealtimeResultLevelinteger

开启会中实时结果返回时,设置识别结果返回等级,默认是 1。 0:不返回识别结果。 1:识别出完整句子时返回识别结果。 2:识别出中间结果及完整句子时返回识别结果。

2
RealtimeActiveResultLevelinteger

开启会中实时结果返回且音频打包方式为 multi 时,设置发言人识别结果返回等级,默认是 1。 0:不返回识别结果。 1:识别出完整句子时返回识别结果。 2:识别出中间结果及完整句子时返回识别结果。

2
AudioOutputEnabledboolean

是否开启 mp3 格式音频同步转码,默认是 false。

false
AudioOutputOssBucketstring

开启音频同步转码时,转码音频写入到的 OSS Bucket,需要与管控台项目配置的 OSS Bucket 一致。

bucket
AudioOutputOssPathstring

开启音频同步转码时,转码音频写入到的 OSS 文件路径,需要以"tingwu/"为前缀。

tingwu/dir/filename
MeetingResultEnabledboolean

是否开启会后智能提取,默认是 false。

false
MeetingResultOssBucketstring

开启会后智能提取时,提取结果写入到的 OSS Bucket,需要与管控台项目配置的 OSS Bucket 一致。

bucket
MeetingResultOssPathstring

开启会后智能提取时,提取结果写入到的 OSS 文件路径,需要以"tingwu/"为前缀。

tingwu/dir/filename
DocResultEnabledboolean

开启会后智能提取时,是否会中识别结果写入,默认是 false。

false
AudioSegmentsEnabledboolean

开启会后智能提取时,是否开启有效音频片断检测结果写入,默认是 false。

false
TranslateResultEnabledboolean

是否开启会中翻译,默认是 false。

false
TranslateLanguagesstring

翻译目标语言集合,多个语言间用英文逗号","分隔,当前支持 cn、en。

cn,en
TranslateResultLevelinteger

单通道识别或多通道 mix 流识别结果翻译等级。0:不返回翻译结果。1:识别出完整句子时返回翻译结果。2:识别出中间结果及完整句子时返回翻译结果。默认是 1。

2
TranslateActiveResultLevelinteger

多通道 Active 流识别结果翻译等级。0:不返回翻译结果。 1:识别出完整句子时返回翻译结果。 2:识别出中间结果及完整句子时返回翻译结果。默认是 1。

2
RealtimeResultWordsEnabledboolean

会中识别消息是否包含 words 信息,默认是 true。

true
RealtimeResultMeetingInfoEnabledboolean

会中识别消息结果 header 中是否包含 MeetingKey、MeetingId,默认是 false。

true
Tagsobject

系统扩展:标签

AsrParamsobject

ASR 转写的额外参数,如热词 vocabulary_id

{ "vocabulary_id": "e2a9a9be3128417fb4d181ebfbe8****" }
LabParamsobject

系统扩展:实验转写参数

AbilityParamsobject

能力扩展

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID,仅用于联调。

35124E1C-AE99-5D6C-A52E-BD689D8D****
Codestring

状态码。

0
Messagestring

状态说明。

Success.
Dataobject

返回对象。

MeetingIdstring

会议 ID。

f7de74778d94422283534102dfc0****
MeetingJoinUrlstring

会议语音推流地址。

wss://tingwu-realtime-cn-beijing.aliyuncs.com/api/ws/v1?mc=****
MeetingKeystring

用户创建会议时设置的会议标识。

meeting_123

示例

正常返回示例

JSON格式

{
  "RequestId": "35124E1C-AE99-5D6C-A52E-BD689D8D****",
  "Code": "0",
  "Message": "Success.",
  "Data": {
    "MeetingId": "f7de74778d94422283534102dfc0****",
    "MeetingJoinUrl": "wss://tingwu-realtime-cn-beijing.aliyuncs.com/api/ws/v1?mc=****",
    "MeetingKey": "meeting_123"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-16API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)