获取会议列表
获取会议列表(支持会议室)
1. 接口描述
接口名称:
/confopenapi/room/conference/list
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
Http Header
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
token | 是 | 接口调用鉴权参数 | 也可以放在http body中 |
Http Body
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
startTime | 是 | string | 开始时间 |
endTime | 是 | string | 结束时间 |
userId | 是 | int | 主持人用户ID |
inCycle | 否 | int | 是否包含周期会议, 0 不包含(默认),1 包含 |
请求示例
传参示例
{
"startTime":1641020400,
"endTime":1641538800,
"userId":87679779
}
3. 返回参数
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json字符串 | 会议返回的结果 |
result参数说明
参数名 | 类型 | 说明 |
---|---|---|
conferenceId | string | 云会议ID |
eventId | string | 预约会议对应的日程ID |
pcode1 | string | 云会议主持人密码 |
pcode2 | string | 云会议参会人密码 |
hostId | uint64 | 主持人userId |
title | string | 会议标题 |
billingCode | string | 会议billingCode |
startTime | string | 会议开始时间 |
endTime | string | 会议结束时间 |
length | int64 | 会议时长 |
hostName | string | 主持人姓名 |
hostJoinUrl | string | 主持人入会连接 |
attendeeJoinUrl | string | 参会人入会链接 |
hostMobile | string | 主持人手机 |
confMode | int64 | 会议类型, 0:视频会议(默认) 1:数据会议 |
calType | string | 会议类型,E:单场会议,M:周期会议 |
isGnet | int | 是否使用云会议,0:不使用(现场会),1:使用 |
status | int | 会议状态,0:已取消,1:已创建,4:已结束 |
roomId | string | 会议室id |
attendList | ——-ajson | 参会人信息 |
attendList->user | string | 参会人id |
attendList->userType | int | 参会人类型,1:内部参会人,2:外部参会人,3:电话参会人 |
attendList->phoneName | string | 电话参会人名称 |
attendList->phoneEmail | string | 电话参会人邮箱 |
attendList->status | string | 参会人状态,W:已确认,A:已接受,R:拒绝 |
attendList->countryCode | string | 国家码 |
attendList->companyName | string | 所属公司名称 |
attendList->orgName | string | 所属组织名称 |
attendList->mobileNumber | string | 手机号 |
attendList->officePhone | string | 办公电话 |
attendList->cityCode | string | 城市码 |
attendList->displayName | string | 显示名称 |
houseList | array | 会议室列表 |
equipList | array | 设备列表 |
livePullUrl | string | 直播链接 |
livePullPwd | string | 入直播密码 |
wcallurl | string | 云会议电话会议链接 |
confNodeType | int | 会议节点类型 0:保密会议(默认)1:标准会议 |
joinLogin | int | 0:参会入会不需要先登录(默认) 1:参会人入会必须先登录 |
joinConfSelTag | int | 是否入会选择标签配置(0:否,1:是) |
joinConfTags | string | 入会标签字符串,标签之间逗号分隔 |
webRTCUrl | string | webRTC 入会链接 |
calExtraInfo | object | 会议设置参数 |
calExtraInfo结构
参数名 | 类型 | 说明 |
---|---|---|
allowH323 | int | 用来控制是否显示h323。0:关闭 1:开启 默认关闭 |
openWatchword | int | 是否开启入会口令开关,0:否,1:是,默认0 |
eventWatchword | string | 入会口令,默认空 |
labels | string | 活动标签字符串数组json字符串 |
houseList和equipList结构
参数名 | 类型 | 说明 |
---|---|---|
DeviceId | int | 设备id |
DeviceType | int | 设备类型,2:会议室;3:会议室关联的设备 |
DeviceName | string | 设备名称 |
City | string | 会议室所在城市 |
Location | string | 会议室所在地址 |
Floor | int | 会议室所在楼层 |
IsMainRoom | int | 会议室类型,0:默认值(用于兼容openapi一场会预约多个会议室的需求);1:主会场;2:分会场 |
ParentDeviceId | int | 父设备id |
ParentDeviceType | int | 父设备类型,2:会议室;3:会议室关联的设备 |
ApplyUserId | int | 申请人id |
ApprovalStatus | int | 申请状态,0:待审核;1:未批准;2:已批准 ,3:会议室被取消 |
houseList和equipList参数示例
[{"DeviceId":6518,
"DeviceType":2,
"DeviceName":"杏花村",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ParentDeviceId":0,
"ParentDeviceType":0,
"ApplyUserId":22563698,
"ApprovalStatus":1
},
{"DeviceId":6516,
"DeviceType":2,
"DeviceName":"杏花村2",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ParentDeviceId":0,
"ParentDeviceType":0,
"ApplyUserId":22563698,
"ApprovalStatus":1
}]
detailHouseList结构
参数名 | 类型 | 说明 |
---|---|---|
ApplyUserId | int | 会议室申请人用户id |
ApplyStatus | int | 会议室审批状态,0:待审核;1:未批准;2:已批准 ,3:会议室被取消 |
DeviceId | int | 会议室id |
DeviceName | string | 会议室名称 |
City | string | 会议室所在城市 |
Location | int | 会议室所在地址 |
Floor | string | 会议室所在楼层 |
DeviceType | int | 设备类型,2:会议室;3:会议室关联的设备 |
IsMainRoom | int | 会议室类型,0:默认值(用于兼容openapi一场会预约多个会议室的需求);1:主会场;2:分会场 |
SubDevices | json | 会议室设备 |
DeviceId | int | 会议室设备id |
DeviceName | string | 会议室设备名称 |
DeviceType | int | 会议室设备类型 |
detailHouseList参数示例
[{
"DeviceId":6516,
"DeviceType":2,
"DeviceName":"杏花村2",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ApplyUserId":22563698,
"ApprovalStatus":1,
SubDevices:[{
"DeviceId":6546,
"DeviceType":3,
"DeviceName":"盒子"
},
{
"DeviceId":6547,
"DeviceType":3,
"DeviceName":"盒子2"
}]
}]
返回示例
{
"status": 0,
"result": [
{
"CreateTime": 1641362281,
"ExtraMeetingRoom": null,
"ManagerCustomerCode": "",
"accessNumberInfo": null,
"accessNumbers": {
"ChooseBySelf": [
{
"area": "北京",
"chooseBySelf": 0,
"number": "+86(10)5932-1988"
},
{
"area": "上海",
"chooseBySelf": 0,
"number": "+86(21)3599-4558"
}
],
"En-us": [
{
"area": "ALL",
"chooseBySelf": 0,
"number": "400-810-8822"
},
{
"area": "Beijing",
"chooseBySelf": 0,
"number": "+86(10)5851-2020"
}
],
"Zh-cn": [
{
"area": "全国",
"chooseBySelf": 0,
"number": "400-139-8500"
}
]
},
"addAttendList": null,
"addDeviceList": [],
"addMediaList": null,
"advanceHours": "1",
"allowBox": 0,
"allowExternal": 1,
"allowHardVideo": 1,
"allowLync": 1,
"appSource": "meeting",
"approvalName": "",
"approvalStatus": 0,
"approvalUserId": 0,
"attendList": [
{
"cityCode": "",
"companyName": "",
"contactId": "",
"countryCode": "",
"displayName": "",
"mobileNumber": "",
"officePhone": "",
"orgName": "",
"phoneEmail": "",
"phoneName": "",
"productStatus": 1,
"status": "W",
"user": "87679779",
"userProfile": null,
"userType": 1
}
],
"attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkmvKqT2D22",
"audienceJoinUrl": "https://mtest.qsh1.cn/k/mkmvKqT2D22",
"audienceUnionUrl": "https://ltest.qsh1.cn/activity/gdn3mw9",
"audioConferenceType": 0,
"authority": null,
"billingCode": "95374287",
"calExtraInfo": {
"allowH323": 0,
"showAccessNumbers": 0,
"showWebRTCUrl": 0
},
"calType": "E",
"callbackURL": "",
"callbackUd": "",
"capacity": 0,
"clientOs": "",
"clientType": 0,
"confHostId": 0,
"confMaster": 0,
"confMode": 0,
"confNodeType": 1,
"conferenceId": "239608260",
"creatorName": "",
"creatorUserId": 0,
"customerCode": "153603",
"delAttendList": null,
"delDeviceList": [],
"delMediaList": null,
"detailHouseList": null,
"enableCloudMCU": 1,
"endTime": 1641366000,
"equipList": [],
"eventForm": 7,
"eventId": 545480,
"eventLive": 0,
"eventManualService": 0,
"eventSource": 0,
"exchangeExternalId": "",
"exchangeSyncDate": 0,
"externalFlag": "",
"extrasInfo": "",
"groupId": 80571542,
"guestJoinUrl": "http://stest.qsh1.cn/a/NVV5IX439282",
"guestJoinVerifyUrl": "https://ltest.qsh1.cn/activity/gdn3mw9?role=3",
"hostId": 87679779,
"hostJoinUrl": "https://mtest.qsh1.cn/k/mkmvK0qTqN0",
"hostName": "分流测试1",
"hostsLayout": "",
"houseList": [],
"importance": 0,
"isGnet": 1,
"isPlugin": false,
"isSharedMedia": 0,
"joinConfSelTag": 0,
"joinConfTags": "",
"joinLogin": 0,
"joinUrlType": 1,
"jointHostUrl": "http://stest.qsh1.cn/a/OVV5IX96186A",
"jointHostVerifyUrl": "https://ltest.qsh1.cn/activity/gdn3mw9?role=2",
"largeGroup": 0,
"ledgerTag": "[]",
"length": 60,
"liveChannelID": 20956,
"liveCover": "",
"liveOpenFlag": 1,
"livePlaybackFlag": 3,
"livePlaybackTime": 0,
"livePullPwd": "222222",
"livePullUrl": "https://ltest.qsh1.cn/activity/gdn3mB8",
"liveScreen": 0,
"liveViewFlag": 1,
"location": "",
"mailLang": 0,
"meetingLanguage": "",
"meetingRoom": 0,
"modifyTime": 1641362280,
"nochangeAttendList": null,
"nochangeDeviceList": [],
"oldConfHostId": 0,
"oriStart": 0,
"parJoinConfLogined": 0,
"parentId": 0,
"passwordFlag": 0,
"pcode1": "201501000037379677",
"pcode2": "201501000037379678",
"recurrenceInfo": null,
"rejectReason": "",
"restLength": 0,
"roomId": "",
"sharedMedia": null,
"sharedMediaInfo": null,
"siteId": 173406,
"sourceDomain": "testcloudb.quanshi.com",
"startTime": 1641362400,
"status": 4,
"summary": "",
"sv": 0,
"telAccess": 0,
"timezone": "Asia/Shanghai",
"timezoneForEmail": "Asia/Shanghai",
"title": "%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%BA%A6%E4%BC%9A",
"uniformEnv": "",
"updAttendList": null,
"updateFlag": 0,
"useWaitingRoom": 0,
"usedConfTickets": 0,
"videoConferenceMode": 0,
"watchMcuVideoMode": 0,
"wcallMonitorUrl": "",
"wcallUrl": "https://dwz.cn/Q8ogM8hE",
"webRTCUrl": "https://mtest.qsh1.cn/k/mkmvKqT2D22?priority=web",
"wholeType": 0
}
],
"request_id": "uniformserver-172.10.87.168-1641967098.227651071.21",
"reqid": "confopenapiserver-10.1.89.7-1641967094.904103600.887",
"timestamp": 1641967094904,
"content_type": "application/json",
"product_type": "",
"device_type": "",
"iscycle": "",
"isgnet": "",
"mem_count": "",
"verify": "",
"video_conference_mode": "",
"live_flag": "",
"conferenceid": "",
"record": 0,
"share_media": 0,
"hardware_video": 0,
"accessNumber": "",
"client_ip": "",
"request_duration": "4.7352709s"
}
备注
- 更多返回错误代码请看首页的错误代码描述