根据企业id获取企业下所有的预约会议信息。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/conference/reminder/query/page/enterprise?enterpriseId=XXX&endTime=XXX&pageIndex=XXX&pageSize=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | 传v1即可 | |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参考 | |
endTime | long | Query | 否 | 无 | 筛选条件:结束时间(Unix毫秒级时间戳,结束时间在该时间点之后的会议都会被查到) | |
pageIndex | int | Query | 否 | 0 | 分页参数,当前页 | |
pageSize | int | Query | 否 | 20 | 分页参数,页面大小 |
返回结果示例:
{
"page": 1,
"pageTotal": 144,
"rowsTotal": 1435,
"rows": 10,
"list": [
{
"title": "xxxxxx",
"startTime": 1602925200000,
"endTime": 1602932400000,
"participants": [
{
"type": "deviceNumber",
"value": "xxxxxx"
}
],
"meetingHost": [],
"address": "",
"details": "",
"autoInvite": 0,
"password": "000000",
"controlPassword": "",
"callLimit": false,
"meetingRoomNumber": "xxxxxx",
"autoRecord": 0,
"mainImage": "",
"recordViewLayout": null,
"enableOffLineRecord": 0,
"offlineTranscodePriority": null,
"lineRateMin": null,
"lineRateMax": null,
"meetingSponsor": {
"type": "account",
"value": "xxxxxx"
},
"reminderId": "xxxxxx",
"week": 7,
"owner": 101758305,
"createTime": 1602923425573,
"updateTime": 1602923425573
}
]
}
返回参数说明
Key | 说明 |
reminderId | 预约会议id |
startTime | 会议开始时间,Unix时间戳(毫秒数) |
endTime | 会议结束时间,Unix时间戳(毫秒数) |
title | 会议标题 |
address | 会议地址 |
details | 会议描述 |
owner | 会议创建人,企业管理员用户id |
autoInvite | 开会时,是否自动呼叫小鱼终端入会。默认为0,不自动;为1,自动。 |
meeingRoomNumber | 虚拟云会议号 |
createTime | 会议创建时间,Unix时间戳(毫秒数) |
updateTime | 会议修改时间,Unix时间戳(毫秒数),默认等于会议创建时间 |
password | 会议密码 |
participants | 参加会议的终端号集合,可选参数 |
└type | 参会者类型 |
└value | 参会者类型对应的值 |
week | 每周的第几天(周日 -> 周一 ->周二 -> 周三 -> 周四 -> 周五 -> 周六) |
meetingRoomType | 会议类型,1 随机自动生成,2 指定云会议室号 |
autoRecord | 自动录制,0 不自动录制,1 自动录制 |
mainImage | 主画面 可选参数 |
└mainLayout | 会议主录制布局 |
└extrasLayout | 会议多路录制布局 |
└└screen | 横竖屏类型 |
└└maxCells | 最大窗口数 |
└└specified | 指定的画面终端列表 |
└└view | 布局类型 |
└└mode | 布局模式 |
└└prefer | 指示是否content(第一分屏)幕显示 |
└└nameplate>enabled | 是否叠加终端名称 |
meetingHost | 会议主持人(预约会议的时候设置) |
└type | 主持人类型 |
└value | 主持人类型对应的值 |
enableOffLineRecord | 是否启用离线录制 |
offlineTranscodePriority | 离线转码优先级(high,normal) |
meetingLock | 会议是否锁定 |
lineRateMin | 云会议室会议速率选项,最低带宽 |
lineRateMax | 云会议室会议速率选项,最高带宽 |
meetingSponsor | 会议预约人 |
└type | 预约人类型 |
└value | 预约人类型对应的值 |