查询会议室列表
更新时间:2025-04-18 07:27:03

查询会议室列表

请求方法

GET

请求地址

/rooms

请求参数

请求参数 参数类型 数据类型 是否必需 描述
limit Query Long 获取的最大记录数,默认为10,最大100
offset Query Long 跳过的记录数,默认为0
groupId Query String 指定查询的起始分组,未指定则默认从根分组开始查询
type Query Integer 会议室类型, 0:普通会议室 ,1:视频会议室
searchKey Query String 搜索关键字,搜索名字,长度小于128
enableScheduled Query Boolean 预约状态:true:启用、false: 禁用

HTTP状态码

返回值 描述
200 操作成功,详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 数据类型 描述
offset Long 偏移量
limit Long 返回最大数量
total Long 总数据量
data Room[] room信息数组

Room对象定义

参数 数据类型 描述
id String 会议室Id
partyId String 企业id
name String 名称
type Integer 会议室类型 0:普通会议室 1: 视频会议室
capacity Integer 会议室容量
description String 会议室描述
enableScheduled Boolean 是否启用会议室
locations List 位置信息,从大到小排列

请求消息示例

GET /open/api/v2/rooms?limit=3&offset=0 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
    "offset": 0, 
    "limit": 3, 
    "total": 7, 
    "data": [
			{
				"id": "e7d6c2875cd942a39364e816345c8d9d",
				"partyId": "f3f389f7d23f4bf183662b8152a582a7",
				"name": "9楼3903",
				"type": 1,
				"capacity": 12,
				"description": "测试9楼3903",
				"enableScheduled": true,
				"locations": [
					"10.121.1.116新",
					"3号楼"
				]
			}
    ]
}

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?limit=3&offset=0'
本页目录