查询会议详情
请求方法
GET
请求地址
/users/{userId}/meetings/{meetingId}
请求参数
请求参数 |
参数类型 |
数据类型 |
是否必需 |
参数说明 |
userId |
Path |
String |
是 |
用户id,长度32 |
meetingId |
Path |
String |
是 |
会议id,长度32 |
sequence |
Query |
Long |
是 |
会议顺序号,取值范围为[1, 100] |
HTTP状态码
返回值 |
描述 |
200 |
操作成功,详见响应参数 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
500 |
服务端异常 |
响应参数
参数 |
数据类型 |
描述 |
id |
String |
会议id |
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 |
会议号码 |
meetingPassword |
String |
会议密码,格式为:6位数字 |
rtmpWatchUrl |
String |
rtmp直播观看链接 |
rtmpWatchPwd |
String |
rtmp直播观看密码 |
remark |
String |
备注,长度小于300 |
participants |
Participant[] |
参会成员列表。 |
enableRandomMeetingNumber |
Boolean |
是否使用随机会议号 |
invitation |
String |
入会链接 |
enableWaitingRoom |
Boolean |
是否开启等候室 |
waitingRoomMode |
Integer |
等候室模式。取值范围为:0:企业内所有人,2:仅主持人,3:企业内所有人及受邀参会者,4:仅受邀参会者 |
enableJoinForwardModerator |
Boolean |
是否开启允许在主持人之前入会 |
enableJoinAutoMute |
Boolean |
是否开启入会自动静音 |
speakMode |
Boolean |
发言模式。取值范围为:0:自由发言,1:举手发言 |
enableWatermark |
Boolean |
是否启用会议水印 |
watermarkTransparency |
Integer |
水印透明度,0:浅;1:中;2:深 |
watermarkFontSize |
Integer |
水印文字大小,0:小;1:中;2:大 |
enableScreenShareWatermark |
Boolean |
是否启用屏幕共享水印(已废弃,建议使用enableWatermark 参数) |
enableOnlyLoginUserJoin |
String |
是否开启仅登录用户才能入会 |
rtmpRichTextRemark |
String |
直播介绍 |
Participant对象定义
参数 |
参数类型 |
描述 |
id |
String |
参会者id |
role |
Integer |
参会者类型,0:组织者;1:主持人;2:参会者;3:观众。 |
type |
Integer |
参会者类型,0:内部参会者;1:外部参会者。 |
name |
String |
参会者名称 |
请求消息示例
GET /v2/users/64bb26c0065b4a54b0dd659e365e93b9/meetings/67bb2b0330584abaa2a1241afba15a4b?sequence=1 HTTP/1.1
Host: api.ylyun.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id": "67bb2b0330584abaa2a1241afba15a4b",
"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": "824230978285",
"meetingPassword": "127536",
"rtmpWatchUrl": null,
"rtmpWatchPwd": null,
"remark": "",
"participants": [ ],
"enableRandomMeetingNumber": true,
"invitation": "https://meetings.ylyun.com/webapp/welcome?t=6RKIJUxw4snrWojMwbcHOpjb3ROwoLOU",
"enableWaitingRoom": true,
"waitingRoomMode": 0,
"enableJoinForwardModerator": true,
"enableJoinAutoMute": true,
"speakMode": 0,
"enableWatermark": true,
"watermarkTransparency": 1,
"watermarkFontSize": 1,
"enableScreenShareWatermark": true,
"enableOnlyLoginUserJoin": true,
"rtmpRichTextRemark": "直播介绍"
}
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.ylyun.com/v2/users/64bb26c0065b4a54b0dd659e365e93b9/meetings/67bb2b0330584abaa2a1241afba15a4b?sequence=1'