根据预约会议的id查询某个现有的预约会议的详细信息。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/meetingreminders/{meetingId}?enterpriseId=XXX&reminderId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | 传v1即可 | 3.9 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 3.9 |
signature | String | Query | 签名鉴权1.0(旧):是 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | 3.9 |
meetingId | String | Path | 是 | 无 | 预约会议id | 3.9 |
返回结果示例:
{
"title": "xxxxxx",
"startTime": xxxxxx,
"endTime": xxxxxx,
"participants": ["xxxxxx", "xxxxxx"],
"meetingHost": ["xxxxxx", "xxxxxx"],
"address": "xxxxxx",
"details": "xxxxxx",
"autoInvite": 1,
"password": "xxxxxx",
"controlPassword": "xxxxxx",
"callLimit": true,
"meetingRoomNumber": "xxxxxx",
"autoRecord": 0,
"mainImage": xxxxxx,
"enableOffLineRecord": 0,
"offlineTranscodePriority": xxxxxx,
"lineRateMin": xxxxxx,
"lineRateMax": xxxxxx,
"week": xxxxxx,
"owner": xxxxxx,
"recordViewLayout":{
"mainLayout": "{\"layout\":{\"screen\":\"landscape\",\"people\":{\"maxCells\":1,\"view\":\"symTiling\",\"mode\":\"auto\",\"specified\":[\"13113567788\"]},\"content\":{\"view\":\"symTiling\",\"mode\":\"auto\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}",
"extrasLayout": [
"{\"layout\":{\"screen\":\"landscape\",\"people\":{\"mode\":\"auto\",\"view\":\"symTiling\",\"specified\":[\"17610356832\"]},\"content\":{\"mode\":\"auto\",\"view\":\"symTiling\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}",
"{\"layout\":{\"screen\":\"landscape\",\"people\":{\"mode\":\"auto\",\"view\":\"symTiling\",\"specified\":[\"17610356832\"]},\"content\":{\"mode\":\"auto\",\"view\":\"symTiling\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}"
]
},
"createTime": xxxxxx
}
返回参数说明
Key | 说明 |
meetingId | 会议id |
startTime | 会议开始时间,Unix毫秒时间戳 |
endTime | 会议结束时间,Unix毫秒时间戳 |
title | 会议标题 |
address | 会议地址 |
details | 会议描述 |
owner | 会议创建人,企业管理员用户id |
autoInvite | 开会时,是否自动呼叫小鱼终端入会。默认为0,不自动;为1,自动。 |
meetingRoomNumber | 虚拟云会议号 |
createTime | 会议创建时间,Unix时间戳(毫秒数) |
password | 会议密码 |
participants | 参加会议的终端号集合,可选参数 |
week | 每周的第几天(周日 -> 周一 ->周二 -> 周三 -> 周四 -> 周五 -> 周六) |
meetingRoomType | 会议类型,1 随机自动生成,2 指定云会议室号 |
autoRecord | 自动录制,0 不自动录制,1 自动录制 |
mainImage | 主画面 可选参数 |
└mainLayout | 会议主录制布局 |
└extrasLayout | 会议多路录制布局 |
└└screen | 横竖屏类型 |
└└maxCells | 最大窗口数 |
└└specified | 指定的画面终端列表 |
└└view | 布局类型 |
└└mode | 布局模式 |
└└prefer | 指示是否content(第一分屏)幕显示 |
└└nameplate>enabled | 是否叠加终端名称 |
meetingHost | 会议主持人(预约会议的时候设置的主持人, 需保证调用该接口的version参数为v2) |
enableOffLineRecord | 是否启用离线录制 |
offlineTranscodePriority | 离线转码优先级(high,normal) |
lineRateMin | 云会议室会议速率选项,最低带宽 |
lineRateMax | 云会议室会议速率选项,最高带宽 |
成功时返回结果数据,失败时返回小鱼RESTAPI错误码