仅支持企业永久会议室、SDK云会议室。
默认接口请求频率限制:20次/秒
REST URL
PUT https://sdk.xylink.com/api/rest/external/{version}/meetingInfo/{meetingRoomNumber}?enterpriseId=XXX&signature=XXXmm
请求参数说明
参数 | 参数类型 | 参数位置 | 是否必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | 传v1即可 | |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参考 | |
meetingRoomNumber | String | Path | 是 | 无 | 云会议室号 | 3.9 |
meettingRoomName | String | Body | 否 | 无 | 云会议室名称 | 3.9 |
autoMute | int | Body | 否 | 0 | 0: 智能静音;1: 全部静音; 2: 不静音 | 3.9 |
smartMutePerson | int | Body | 否 | 6 | 智能静音人数: 如果手动指定autoMute=0,则必须传smartMutePerson | 3.9 |
autoRecord | boolean | Body | 否 | 无 | 自动录制(true/false) | 3.9 |
expireTime | long | Body | 否 | 无 | 过期时间 | 3.9 |
password | String | Body | 否 | 无 | 指定密码,如果用户指定了密码,那么该云会议室默认有密码。如果用户没有指定密码,但是require_password为true,小鱼会自动生成密码 | 3.9 |
meetingControlPwd | String | Body | 否 | 无 | 主持会议密码 | 3.9 |
onlyRecordMainImage | boolean | Body | 否 | false | 只录制主会场或发言者画面(true/false) | 3.9 |
recordAddDeviceName | boolean | Body | 否 | false | 录制视频中叠加终端名称(true/false) | 3.9 |
hrRecord | boolean | Body | 否 | false | 是否开启高清录制(true/false) | 6.0 |
onlyScheduledCall | int | Body | 否 | 无 | 0: 不限制预约呼叫 1: 仅限制预约呼叫 | 6.0 |
internetCallLimit | Integer | Body | 否 | 无 | 互联网端呼叫限制 0 不限制 1 限制 | 公有云 |
mediaEncrypt | String | Body | 否 | 无 | 会议室加密能力:AUTO、AES256、SM4 | 3.9 |
watermark | int | Body | 否 | 无 | 是否开启会议水印:0 不开启,1 开启会议水印 | 6.0 |
maxSharedSession | int | Body | 否 | 无 | 会议最大共享方数,(会议室最大参会人数,支持会议中修改) | 6.0 |
inoutReminder | boolean | Body | 否 | 无 | 是否开启客户端出入会消息通知:false 不开启,true 开启 | 6.0 |
pushAudioStream | boolean | Body | 否 | 无 | 是否开启服务端推流:false 不开启,true 开启(打开服务端推流需要打开相应权限) | 6.0 |
enableWaitingRoom | boolean | Body | 否 | 无 | 是否开启等候室:false 不开启,true 开启 | 公有云及分区云20241018 |
subtitle | boolean | Body | 否 | 无 | 是否开启同传字幕 true 开启 false 关闭 注:开启同传字幕需要申请企业权限 | 公有云 |
transcriptionMode | Integer | Body | 否 | 无 | 会议纪要模式 0 关闭会议纪要 1 开启录制会议纪要模式 2 开始入会会议纪要模式 注:开启会议纪要模式需要申请企业权限 | 公有云 |
generateExtraAudio | boolean | Body | 否 | 无 | 额外生成音频文件 | 公有云 |
recordingBitrate | Integer | Body | 否 | 无 | 码率(取值范围 200-10000,单位为Kbps) 4K--4000~10000、1080P--1000~4000、720P--500~2000、480P--200~1000 | 公有云 |
recordingResolution | String | Body | 否 | 无 | 分辨率(字符串) 4K、1080P、720P、480P | 公有云 |
cascadeBetweenMeeting | boolean | Body | 否 | false | 开启会间级联使能开关 true:使能 false:不使能 注:需要配置平台级级联可见性 | 公有云及分区云20240802 |
forbidInvitedCascade | boolean | Body | 否 | false | 会间级联禁止被邀请 true:禁止 false:不禁止 | 公有云及分区云20240802 |
enableInvitedAutoCascade | boolean | Body | 否 | false | 收到邀请自动级联 true/false | 公有云及分区云20240802 |
crossCloudCallScope | String | Body | 否 | 0 | 跨云呼叫范围 0:跨云通讯录用户可呼叫1:所有跨云用户禁止呼叫 2:所有跨云用户均可呼叫 | 公有云及分区云20240802 |
请求消息体示例(Json)
{
"meettingRoomName": "唐僧的会议室",
"autoMute":"0/1/2",
"smartMutePerson": 5,
"autoRecord": false,
"expireTime":1516873505000,
"password":"903456",
"meetingControlPwd":"123478",
"onlyRecordMainImage":false,
"recordAddDeviceName":false,
"onlyScheduledCall":1,
"mediaEncrypt":"SM4",
"watermark":1,
"inoutReminder":true,
"pushAudioStream":false,
"enableRecordCrypt": false,
"recordFileFormat": "mp4",
"storageId": "2",
"generateExtraAudio":false
}
返回结果示例:
成功时返回状态码200,失败时返回小鱼RESTAPI错误码