查询某个云会议室的基本信息。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/meetingInfo/{meetingRoomNumber}?enterpriseId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | 传v1即可 | |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权2.0不需要:否 | 无 | ||
meetingRoomNumber | String | Path | 是 | 无 | 云会议室号 | 3.9 |
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"meettingRoomName": "唐僧的会议室",
"meetingRoomState": "neverUsed/incall/idle/expired",
"autoMute":"0/1/2",
"smartMutePerson": 5,
"autoRecord": false,
"expireTime":1516873505000,
"password":"903456",
"meetingControlPwd":"123478",
"onlyRecordMainImage":false,
"recordAddDeviceName":false,
"depCode":"",
"mediaEncrypt": "SM4",
"watermark": 0,
"onlyScheduledCall": 1,
"internetCallLimit": 1,
"inoutReminder": true,
"ownerUserId":"1013131",
"pushAudioStream": false,
"meetingRoomNumber": "910125823382",
"generateExtraAudio": false,
"enableRecordCrypt": false,
"recordFileFormat": "m3u8",
"enableWaitingRoom": false,
"subtitle":false,
"transcriptionMode": 1,
"recordingBitrate": 1000,
"recordingResolution": "1080P",
"cascadeBetweenMeeting":true,
"forbidInvitedCascade":true,
"enableInvitedAutoCascade":true,
"crossCloudCallScope":"0"
}
返回参数说明
参数名称 | 说明 | 初始平台 |
meettingRoomName | 会议室名字 | all |
meetingRoomState | 会议室状态 neverUsed:从未使用过;incall:呼叫中;idle:空闲;expired:已过期 | all |
autoMute | 0: 智能静音(默认第5个人以后自动静音);1: 全部静音 ;2: 不静音 | all |
smartMutePerson | 智能静音人数 | all |
autoRecord | 自动录制(true/false) | all |
expireTime | 云会议室过期时间 | all |
password | 云会议室密码 | all |
meetingControlPwd | 云会议室会控密码 | all |
onlyRecordMainImage | 只录制主会场或发言者画面(true/false) | all |
recordAddDeviceName | 录制视频中叠加终端名称(true/false) | all |
depCode | 云会议室所属部门code | all |
ownerUserId | 个人云会议室所属用户id | all |
hrRecord | 云会议室是否开启高清录制 | all |
mediaEncrypt | 云会议室加密能力 | all |
onlyScheduledCall | 云会议室是否为仅限制预约呼叫 | all |
internetCallLimit | 互联网端呼叫限制 | all |
inoutReminder | 是否开启客户端出入会消息通知 | all |
watermark | 是否开启会议水印 | all |
pushAudioStream | 是否开启服务端推流 | all |
meetingRoomNumber | 云会议室号 | all |
generateExtraAudio | 生成额外音频 | all |
enableRecordCrypt | 是否开启记录加密 | all |
recordFileFormat | 文件格式 | all |
enableWaitingRoom | 是否开启等候室 | 公有云及分区云20241018 |
subtitle | 是否开启同传字幕 | all |
transcriptionMode | 会议纪要模式 | all |
recordingBitrate | 码率 | all |
recordingResolution | 分辨率 | all |
cascadeBetweenMeeting | 会间级联使能开关 | 公有云及分区云20240802 |
forbidInvitedCascade | 会间级联禁止被邀请 | 公有云及分区云20240802 |
enableInvitedAutoCascade | 收到邀请自动级联 | 公有云及分区云20240802 |
crossCloudCallScope | 跨云呼叫范围 | 公有云及分区云20240802 |