查询会议详情
请求方法
GET
请求地址
/users/{userId}/meetings/{meetingPlanId}
请求参数
| 请求参数 |
参数类型 |
数据类型 |
是否必需 |
参数说明 |
| userId |
Path |
String |
是 |
用户id,长度32 |
| meetingPlanId |
Path |
String |
是 |
会议id,长度32 |
| sequence |
Query |
Long |
是 |
会议顺序号,取值范围为[1, 100] |
HTTP状态码
| 返回值 |
描述 |
| 200 |
操作成功,详见响应参数 |
| 400 |
客户端传参异常 |
| 401 |
鉴权失败 |
| 500 |
服务端异常 |
响应参数
| 参数 |
数据类型 |
描述 |
| id |
String |
会议id |
| profile |
Integer |
会议模式,取值范围为: 0 = 视频会议模式;2 = 研讨会模式;3 = 语音会议模式 |
| sequence |
Long |
会议序号 |
| isRecurrence |
Boolean |
是否为周期会议 |
| isRTMP |
Boolean |
是否为RTMP直播 |
| subject |
String |
会议主题 |
| organizer |
Participant |
组织者信息 |
| aheadTime |
Long |
提前入会时间 |
| startDateTime |
Long |
会议开始时间 |
| endDateTime |
Long |
会议结束时间 |
| durationHour |
Integer |
会议持续时长(小时部分) |
| durationMinute |
Integer |
会议持续时长(分钟部分) |
| zoneId |
String |
时区id |
| recurrenceType |
Integer |
周期会议循环类型,取值范围为:0:按天循环,1:按周循环,2:按月的第X天循环。此项没有值表示单次会议。 |
| recurrenceInterval |
Integer |
循环间隔 |
| dayOfWeek |
String |
每周的周几。取值范围为:1:星期日,2:星期一,3:星期二,4:星期三,5:星期四,6:星期五,7:星期六。多个值以逗号分隔,如:1,3,5。 |
| dayOfMonth |
Integer |
每月的第几天,可取值[1-31] |
| rangeStartDate |
Long |
循环开始日期 |
| rangeEndDate |
Long |
循环结束日期 |
| meetingNumber |
String |
会议号码,格式为:6位数字.5位数字(如:"908971*11028") |
| meetingPassword |
String |
会议密码,格式为:6位数字 |
| rtmpWatchUrl |
String |
rtmp直播观看链接 |
| rtmpWatchPwd |
String |
rtmp直播观看密码 |
| remark |
String |
备注,长度小于300 |
| participants |
Participant[] |
参会成员列表。 |
| meetingRooms |
MeetingRoom[] |
会议室信息 |
| speakMode |
Integer |
发言模式, 取值范围: 0:自由发言,1:举手发言 |
| enableWaitingRoom |
Boolean |
是否启用会议等候室 |
| ~~waitingRoomMode~~ |
Integer |
已废弃,支持旧版本兼容,请使用waitingRoomModeList这个字段。会议等候室设置,可选值:0=企业内所有人;1=仅主持人;2=企业内所有人及受邀参会者;3=仅受邀参会者 |
| joinUrl |
String |
外网入会链接 |
| intranetJoinUrl |
string |
内网入会链接 |
| enableJoinAutoMute |
Boolean |
是否入会自动静音 |
| enableJoinForwardModerator |
Boolean |
是否允许主持人之前加入 |
| ~~enableScreenShareWatermark~~ |
Boolean |
已废弃,支持旧版本兼容,请使用enableWatermark字段。是否启用屏幕共享水印 |
| enableWatermark |
Boolean |
是否启用水印 |
| watermarkTransparency |
Integer |
水印透明度,0:浅;1:中;2:深 |
| watermarkFontSize |
Integer |
水印文字大小,0:小;1:中;2:大 |
| enableOnlyLoginUserJoin |
Boolean |
是否启用仅登录用户入会 |
| waitingRoomModeList |
Integer[] |
会议等候室设置(新),可选值:0=开启企业内所有人;1=开启受邀参会者;2=开启第三方入会IP白名单 |
| isVideo |
Boolean |
是否视频会议 |
| isOwnLive |
Boolean |
是否开启自有直播 |
| ownLiveWatchUrl |
String |
自有直播链接 |
| rtmpWatchLimitType |
Integer |
直播观看限制类型,0:所有人,1:需要密码. 不传递,默认为0 |
Participant对象定义
| 参数 |
参数类型 |
描述 |
| id |
String |
参会者id |
| role |
Integer |
参会者角色,0:组织者;1:主持人;2:参会者。 |
| type |
Integer |
参会者类型,0:内部参会者;1:外部参会者。 |
| name |
String |
参会者名称 |
MeetingRoom对象定义
| 参数 |
参数类型 |
描述 |
| roomId |
String |
会议室Id |
| roomName |
String |
会议室名称 |
| participationStatus |
Integer |
参与状态 0: 第三方拒绝;1: 接受; 2: 管理员删除 |
请求消息示例
GET /open/api/v2/users/64bb26c0065b4a54b0dd659e365e93b9/meetings/67bb2b0330584abaa2a1241afba15a4b?sequence=1 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id": "67bb2b0330584abaa2a1241afba15a4b",
"profile": 0,
"sequence": 1,
"isRecurrence": true,
"isRTMP": false,
"subject": "大帅-dev企业的会议",
"organizer": {
"id": "64bb26c0065b4a54b0dd659e365e93b9",
"role": 0,
"type": 0,
"name": "大帅-dev企业"
},
"aheadTime": 1800000,
"startDateTime": 1583897100000,
"endDateTime": 1583904300000,
"durationHour": 2,
"durationMinute": 0,
"zoneId": "China_Standard_Time",
"recurrenceType": 0,
"recurrenceInterval": 1,
"dayOfWeek": null,
"dayOfMonth": null,
"rangeStartDate": 1583856000000,
"rangeEndDate": 1584115200000,
"meetingNumber": "242309*78285",
"meetingPassword": "127536",
"rtmpWatchUrl": null,
"rtmpWatchPwd": null,
"isOwnLive": false,
"ownLiveWatchUrl": "https://10.121.1.39/own-live-player?meeting=obhPpdyxook%3D&number=",
"rtmpWatchLimitType": 1,
"remark": "",
"participants": [ ],
"meetingRooms": [
{
"roomId": "7699be5ed8ad408a9043253117bada58",
"participationStatus": 0,
"roomName": "exchange08"
}
],
"speakMode": 1,
"enableWaitingRoom": false,
"waitingRoomMode": 3,
"enableJoinAutoMute": false,
"enableJoinForwardModerator": false,
"enableScreenShareWatermark": false,
"enableWatermark": true,
"watermarkTransparency": 1,
"watermarkFontSize": 1,
"enableOnlyLoginUserJoin": false,
"waitingRoomModeList": [
0,
1,
2
],
"joinUrl": "http://www.yealink.com/webapp/home/welcome?t=vgYEWI388Kc%2BNYFGHhwpg62FS83T08iK",
"intranetJoinUrl": "http://10.200.112.155/webapp/home/welcome?t=vgYEWI388Kc%2BNYFGHhwpg62FS83T08iK",
"isVideo": 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/users/64bb26c0065b4a54b0dd659e365e93b9/meetings/67bb2b0330584abaa2a1241afba15a4b?sequence=1'