查询会议室的日程
请求方法
GET
请求地址
/room-schedules
请求参数
| 请求参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
| queryStartTime |
Query |
Long |
是 |
查询开始时间,时间不能小于0 |
| queryEndTime |
Query |
Long |
是 |
查询结束时间，时间不能小于0，和查询开始时间间隔为最大为2天 |
| roomIds |
Query |
String[] |
是 |
roomId 列表 ，支持最大200个roomId （roomId为32） |
HTTP状态码
| 返回值 |
描述 |
| 200 |
操作成功，详见响应参数 |
| 400 |
客户端传参异常 |
| 401 |
鉴权失败 |
| 500 |
服务端异常 |
响应参数
| 参数 |
数据类型 |
描述 |
| partyId |
String |
企业id |
| queryStartTime |
Long |
查询范围的开始时间 |
| queryEndTime |
Long |
查询范围的结束时间 |
| queryRecordCount |
Long |
查询会议记录数量 |
| serverTime |
Long |
服务器当前时间 |
| roomPlans |
Map<String, List<MeetingPlan>> |
key为roomId的日程列表 |
MeetingPlan对象定义
| 参数 |
参数类型 |
描述 |
| id |
String |
会议Id |
| sequence |
Long |
会议序列号 |
| subject |
String |
会议主题 |
| organizerId |
String |
组织者subject_id |
| organizerName |
String |
组织者 |
| timeZoneConfig |
TimeZoneConfig |
时区配置信息 |
| aheadTime |
Long |
提前入会时间 |
| startDateTime |
Long |
会议开始时间 |
| endDateTime |
Long |
会议结束时间 |
| meetingNumber |
String |
会议号 |
| meetingPassword |
String |
会议密码 |
| isRTMP |
Boolean |
是否为RTMP直播型会议 |
TimeZoneConfig对象定义
| 参数 |
参数类型 |
描述 |
| zoneId |
String |
时区Id |
| utcOffset |
Integer |
时区偏移量 |
请求消息示例
GET /open/api/v2/conference/scheduled?queryStartTime=1609459200000&queryEndTime=1609545599000&roomIds=25fad36424c545bab26ea0a0e3f3f35e,xxxxxx HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"partyId": "f3f389f7d23f4bf183662b8152a582a7",
"queryStartTime": 1698768000000,
"queryEndTime": 1701359999999,
"queryRecordCount": 0,
"serverTime": 1700203053868,
"roomPlans": {
"25fad36424c545bab26ea0a0e3f3f35e": [
{
"id": "61ea2b3037cf44a587aed573522e93a5",
"sequence": 1,
"subject": "大帅-dev企业的会议",
"organizerId": "afd7982cc0074d07b9a7a8f0682c6e0e",
"organizerName": "大帅-dev企业",
"timeZoneConfig": {
"zoneId": "China_Standard_Time",
"utcOffset": 28800
},
"aheadTime": 1800000,
"startDateTime": 1583894700000,
"endDateTime": 1583901900000,
"meetingNumber": "242309*40002",
"meetingPassword": "247910",
"isRTMP": false
}
]
}
}
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-scheduled?queryStartTime=1609459200000&queryEndTime=1609545599000&roomIds=25fad36424c545bab26ea0a0e3f3f35e,xxxxxx'