创建实时会议。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求语法
PUT /openapi/meeting-trans
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 请求 body。 | |
AppKey | string | 是 | 管控台创建的项目 AppKey。 | JV1sRTisRMi**** |
MeetingKey | string | 否 | 用户设置的会议标识,在会中查询或会后结束回调时会原样返回。 | meeting_123 |
AudioFormat | string | 是 | 音频编码格式,PCM(无压缩的 PCM 文件或 WAV 文件)或 OPUS(压缩的 OPUS 文件)。 | pcm |
AudioPackage | string | 否 | 音频打包方式,基于听悟约定的 Protobuf 格式封装多路音频流时设置为 multi。 | multi |
AudioSampleRate | integer | 是 | 音频采样率,当前支持:16000、8000(仅支持单路中文)。 | 16000 |
AudioBitRate | integer | 是 | 会议上传音频采样位数,当前支持:16。 | 16 |
AudioLanguage | string | 是 | 音频转写使用的语言模型。 cn:中文。 en:英文。 yue:粤语。 fspk:中英文自由说。 | cn |
RealtimeResultEnabled | boolean | 否 | 是否开启会中实时结果返回,默认是 true。 | true |
RealtimeResultLevel | integer | 否 | 开启会中实时结果返回时,设置识别结果返回等级,默认是 1。 0:不返回识别结果。 1:识别出完整句子时返回识别结果。 2:识别出中间结果及完整句子时返回识别结果。 | 2 |
RealtimeActiveResultLevel | integer | 否 | 开启会中实时结果返回且音频打包方式为 multi 时,设置发言人识别结果返回等级,默认是 1。 0:不返回识别结果。 1:识别出完整句子时返回识别结果。 2:识别出中间结果及完整句子时返回识别结果。 | 2 |
AudioOutputEnabled | boolean | 否 | 是否开启 mp3 格式音频同步转码,默认是 false。 | false |
AudioOutputOssBucket | string | 否 | 开启音频同步转码时,转码音频写入到的 OSS Bucket,需要与管控台项目配置的 OSS Bucket 一致。 | bucket |
AudioOutputOssPath | string | 否 | 开启音频同步转码时,转码音频写入到的 OSS 文件路径,需要以"tingwu/"为前缀。 | tingwu/dir/filename |
MeetingResultEnabled | boolean | 否 | 是否开启会后智能提取,默认是 false。 | false |
MeetingResultOssBucket | string | 否 | 开启会后智能提取时,提取结果写入到的 OSS Bucket,需要与管控台项目配置的 OSS Bucket 一致。 | bucket |
MeetingResultOssPath | string | 否 | 开启会后智能提取时,提取结果写入到的 OSS 文件路径,需要以"tingwu/"为前缀。 | tingwu/dir/filename |
DocResultEnabled | boolean | 否 | 开启会后智能提取时,是否会中识别结果写入,默认是 false。 | false |
AudioSegmentsEnabled | boolean | 否 | 开启会后智能提取时,是否开启有效音频片断检测结果写入,默认是 false。 | false |
TranslateResultEnabled | boolean | 否 | 是否开启会中翻译,默认是 false。 | false |
TranslateLanguages | string | 否 | 翻译目标语言集合,多个语言间用英文逗号","分隔,当前支持 cn、en。 | cn,en |
TranslateResultLevel | integer | 否 | 单通道识别或多通道 mix 流识别结果翻译等级。0:不返回翻译结果。1:识别出完整句子时返回翻译结果。2:识别出中间结果及完整句子时返回翻译结果。默认是 1。 | 2 |
TranslateActiveResultLevel | integer | 否 | 多通道 Active 流识别结果翻译等级。0:不返回翻译结果。 1:识别出完整句子时返回翻译结果。 2:识别出中间结果及完整句子时返回翻译结果。默认是 1。 | 2 |
RealtimeResultWordsEnabled | boolean | 否 | 会中识别消息是否包含 words 信息,默认是 true。 | true |
RealtimeResultMeetingInfoEnabled | boolean | 否 | 会中识别消息结果 header 中是否包含 MeetingKey、MeetingId,默认是 false。 | true |
Tags | object | 否 | 系统扩展:标签 | |
AsrParams | object | 否 | ASR 转写的额外参数,如热词 vocabulary_id | { "vocabulary_id": "e2a9a9be3128417fb4d181ebfbe8****" } |
LabParams | object | 否 | 系统扩展:实验转写参数 | |
AbilityParams | object | 否 | 能力扩展 |
返回参数
示例
正常返回示例
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-16 | API 内部配置变更,不影响调用 | 看变更集 | ||
|