永久会议室有数量限制,默认限制100个,请合理使用。
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/create_meeting/byType?enterpriseId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9 5.2-20221121 公有云 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 3.9 5.2-20221121 公有云 |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | 3.9 5.2-20221121 公有云 |
meetingName | String | Body | 是 | sdk meeting room | 云会议室的名称 | 3.9 5.2-20221121 公有云 |
requirePassword | boolean | Body | 否 | 无 | 是否需要密码,如果为true,则会默认生成一个6位数字密码;如为false,则该会议没有密码 | 3.9 5.2-20221121 公有云 |
password | String | Body | 否 | 无 | 指定密码,如果用户指定了密码,那么该云会议室默认有密码。如果用户没有指定密码,但是require_password为true,小鱼会自动生成密码 | 3.9 5.2-20221121 公有云 |
controlPassword | String | Body | 否 | 无 | 主持会议密码 | 3.9 5.2-20221121 公有云 |
autoMute | String | Body | 否 | 0 | 0: 智能静音(默认第6个人以后自动静音);1: 全部静音 ;2: 不静音 | 3.9 5.2-20221121 公有云 |
configs | Map | Body | 否 | 无 | 云会议室扩展配置Object | 3.9 5.2-20221121 公有云 |
└ autoRecord | boolean | Body | 否 | false | 是否自动录制 | 3.9 5.2-20221121 公有云 |
└ smartMutePerson | String | Body | 否 | 6 | 智能静音人数:从第几个人开始启动智能静音 | 3.9 5.2-20221121 公有云 |
└ onlyRecordMainImage | boolean | Body | 否 | false | 只录制主画面 | 3.9 5.2-20221121 公有云 |
└ recordAddDeviceName | boolean | Body | 否 | false | 是否在录制视频中叠加终端名称 | 3.9 5.2-20221121 公有云 |
└ pushAudioStream | boolean | Body | 否 | 无 | 服务端推流开关: true:打开 false:关闭 | 3.9 5.2-20221121 公有云 |
└ enableWaitingRoom | boolean | Body | 否 | 无 | 是否打开等候室: true:打开 false:关闭 | 5.2-20241018 公有云 |
└transcriptionMode | Integer | Body | 否 | 无 | 文字转写使用模式 0 不开启文字转写 1 开启录制时,同时开启文字转写 2 会议开启后,自动开启文字转写 注:文字转写,需要企业购买转写License,并为会议室配置授权 | 5.2-20250627 公有云 |
└intelligentMeetingMinutes | boolean | Body | 否 | false | 是否开启智能纪要能力。开启后,可以根据转写内容生成会议总结纪要。 true 开启 false 关闭 注意: 1)智能纪要,需要企业购买智能纪要License,并为会议室配置授权。 2)智能纪要,无法单独使用,只能根据会议的文字转写内容调用大模型能力生成 | 5.2-20250627 |
请求消息体示例(Json)
{
"meetingName": "小毛的会议室",
"requirePassword": true,
"password": "123456",
"controlPassword": "123456",
"autoMute": 0,
"configs":{
"autoRecord":false
···
}
}返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"meetingNumber": "900111222",
"controlPassword": "123456",
"password": "123456"
}返回参数说明
参数名称 | 说明 |
meetingNumber | 会议号 |
controlPassword | 会控密码 |
password | 密码 |