查询会议室信息
请求方法
GET
请求地址
/rooms/{roomId}
请求参数
请求参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
roomId |
Path |
String |
是 |
会议室id |
HTTP状态码
返回值 |
描述 |
200 |
操作成功,详见响应参数 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
500 |
服务端异常 |
响应参数
参数 |
参数类型 |
描述 |
id |
String |
会议室id |
name |
String |
会议室名称 |
type |
Long |
会议室类型,0:普通会议室,1:视频会议室 |
capacity |
Integer |
会议室容量 |
description |
String |
会议室描述 |
number |
String |
会议室账号 |
phoneExtension |
String |
分机号 |
followPassword |
Boolean |
分机密码是否跟随账号密码 |
phoneExtensionPassword |
String |
分机密码(followPassword开启时,返回为空默认其跟随密码) |
maxVideoConcurrentAmount |
Integer |
最大视频并发数 |
enableAudioPermission |
Boolean |
是否启用音频权限 |
roomConfig |
Object |
会议室配置 |
roomConfig:
参数 |
参数类型 |
描述 |
roomManagePassword |
String |
会议室管理密码 |
enableScheduled |
Boolean |
是否启用预约会议 |
scheduledMode |
Integer |
预约模式,0:自由预约,1:仅临时占用 |
maxStartDateDays |
Integer |
支持最远预约的天数 |
enableScheduledDurationLimit |
Boolean |
是否限制单次预约时长 |
maxScheduledDurationMinutes |
Integer |
单次可预约时长分钟数 |
enableScheduledRecurrenceConf |
Boolean |
是否允许预约周期会议 |
enableCheckOut |
Boolean |
是否启用会议门牌签退功能 |
enableCanceledConf |
Boolean |
是否启用取消会议功能 |
enableAutoReleaseConf |
Boolean |
是否启用自动释放未到场的会议功能 |
enableCheckIn |
Boolean |
是否启用会议门牌签到功能 |
maxCheckInMinsBeforeStartTime |
Integer |
签到期设置会议开始前分钟数 |
maxCheckInMinsAfterStartTime |
Integer |
签到期设置会议开始后分钟数 |
请求消息示例
GET /open/api/v2/rooms/25fad36424c545bab26ea0a0e3f3f35e HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"id": "uuid", // 会议室id
"name": "会议室1", // 会议室名称
"type": 0, // 会议室类型,0:普通会议室,1:视频会议室,实体会议室才有值
"capacity": 100, // 会议室容量
"description": "会议室描述", // 会议室描述
"number": "8213383124551156128468", // 会议室账号
"phoneExtension": "124551156128468", // 分机号
"followPassword": false, // 分机密码是否跟随账号密码
"phoneExtensionPassword": "a123456789", // 分机密码
"deviceId": "aa4440a5977643e18b674879687d5898", // 设备id
"enableScheduled": true, // 是否启用预约会议
"maxVideoConcurrentAmount": 50,// 最大视频并发数
"enableAudioPermission": true, // 会议室配置
// 会议室配置
"roomConfig": {
"roomManagePassword": "666666", // 会议室管理密码
"enableScheduled": true, // 是否启用预约会议
"scheduledMode": 0, // 预约模式,0:自由预约,1:仅临时占用
"maxStartDateDays": 90, // 支持最远预约的天数
"enableScheduledDurationLimit": false, // 是否限制单次预约时长
"maxScheduledDurationMinutes": 120, // 单次可预约时长分钟数
"enableScheduledRecurrenceConf": true, // 是否允许预约周期会议
"enableCheckOut": true, // 是否启用会议门牌签退功能
"enableCanceledConf": true, // 是否启用取消会议功能
"enableAutoReleaseConf": false, // 是否启用自动释放未到场的会议功能
"enableCheckIn": false, // 是否启用会议门牌签到功能
"maxCheckInMinsBeforeStartTime": 10, // 签到期设置会议开始前分钟数
"maxCheckInMinsAfterStartTime": 10 //签到期设置会议开始后分钟数
}
},
"statusCode": 200,
"bizCode": 900200,
"error": null
}
CURL命令示例
curl -XGET -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' 'https://api.yealink.com/open/api/v2/rooms/25fad36424c545bab26ea0a0e3f3f35e'