在会议中实时开启/停止文字转写。
当调用停止转写接口,或会议结束引发的转写结束,都会触发TranscriptionFinished事件回调。
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/v1/transcription/meeting/online?enterpriseId=XXX&meetingRoomNumber=XXX&meetingId=XXX&action=&&signature=XXX
请求参数说明:
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 5.2-20250926 公有云不存在 |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参考 | 5.2-20250926 公有云不存在 |
meetingRoomNumber | String | Query | 是 | 无 | 会议室号码 | 5.2-20250926 公有云不存在 |
meetingId | String | Query | 否 | meetingRoomNumber当前会议的 id | 会议id | 5.2-20250926 公有云不存在 |
action | String | Query | 是 | 无 | start:开启 stop:关闭 | 5.2-20250926 公有云不存在 |
请求成功返回http状态码200
action=start:
{
"taskId": "example-task-id",
"aiMode": "EXCLUSIVE",
"occupyId": "window-id"
}action=stop:
{}重复启动判定为可复用时返回同一 taskId;任务结束后再启动不保证沿用历史 ID。成功表示启动调用成功或复用了任务,不代表转写已完成。aiMode 表示该任务的实际模式,不能用当前授权配置替代;不返回 occupyId。
action=stop 成功返回 JSON 空对象 {},
响应参数说明
以下字段仅在 action=start 成功时返回;
参数 | 参数类型 | 说明 | 初始平台 |
taskId | String | 任务标识 | 公有云不存在 分区云5.2-20261225 |
aiMode | String | SHARED / EXCLUSIVE;该任务实际采用的授权模式 | 公有云不存在 分区云5.2-20261225 |
occupyId | String | 授权占用id | 公有云不存在 分区云5.2-20261225 |
请求失败结果示例:
{
"developerMessage": "ErrorStatus: INVALID_CLOUD_MEETING_NUMBER enterpriseId is INVALID",
"userMessage": "invalid cloud meeting number",
"errorCode": 4117,
"moreInfo": "http://www.com.ainemo.com/errors/4117"
}以下仅列出该接口业务逻辑错误码,其他错误码见小鱼RESTAPI错误码
错误码 | 描述 |
4117 | 云会议室号不正确 |