开发者文档

获取云会议列表-某个会议室的列表

获取云会议列表-某个会议室的列表

1. 接口描述

接口名称：

/confopenapi/room/conference/listByRoomId

发送方式：

POST

参数格式：

accept: application/json;content-type: application/json

2. 输入参数

参数名 必选 类型 说明
startTime 是 string 开始时间, 毫秒
endTime 是 string 结束时间, 毫秒
roomId 是 int 会议室id
gnetType 否 int 查询会议类型，0:非云会议（纯会议室），1：查询云会议，默认1
limit 否 int 分页参数，每页返回多少条记录，默认值10
filterAsc 否 bool 分页参数，按开始时间拉取方向，true:正向拉取，默认false:反向拉取
eventIdFilter 否 int 分页参数，最后一条会议的eventId，正向拉取时最大的，反向拉取时取最小的

3. 示例

传参示例

{
    "startTime":1671098400,
    "endTime":1648897421,
    "roomId": 11836
}

返回示例

{
    "status": 0,
    "result": [
        {
            "conferenceId": "239797900",
            "pcode1": "201501000037627171",
            "pcode2": "201501000037627172",
            "billingcode": "95477392",
            "eventId": 616604,
            "attendeeJoinUrl": "https://ntest.qsh1.cn/k/mL0jtKo0RqD",
            "hostJoinUrl": "https://ntest.qsh1.cn/k/mL0jt0KUagq",
            "wcallurl": "https://stest.qsh1.cn/a/IRLqUQbMHpy0Y2CC34A",
            "hostId": 88610840,
            "hostName": "pei",
            "hostMobile": "",
            "startTime": 1671107400,
            "endTime": 1671109200,
            "length": 30,
            "status": 4,
            "title": "pxyces10002",
            "confMode": 0,
            "calType": "E",
            "roomId": "",
            "attendList": [
                {
                    "cityCode": "",
                    "companyName": "",
                    "contactId": "",
                    "countryCode": "",
                    "displayName": "",
                    "mobileNumber": "",
                    "officePhone": "",
                    "orgName": "",
                    "phoneEmail": "",
                    "phoneName": "",
                    "productStatus": 1,
                    "roleId": 1,
                    "status": "W",
                    "user": "88610840",
                    "userProfile": null,
                    "userType": 1
                }
            ],
            "livePullUrl": "",
            "livePullPwd": "",
            "CreateTime": 1671084641,
            "modifyTime": 1671084640,
            "timezone": "Asia/Shanghai",
            "joinLogin": 0,
            "joinConfSelTag": 0,
            "joinConfTags": "",
            "webRTCUrl": "https://ntest.qsh1.cn/k/mL0jtKo0RqD?priority=web",
            "calExtraInfo": {
                "allowH323": 0,
                "reserveFrom": 1000
            },
            "confNodeType": 1,
            "houseList": [
                11836
            ],
            "equipList": [
                59928
            ],
            "detailHouseList": [
                {
                    "ApplyUserId": 88610840,
                    "ApprovalStatus": 2,
                    "City": "北京",
                    "DeviceId": 11836,
                    "DeviceName": "阳澄湖-公共",
                    "DeviceType": 2,
                    "Floor": 13,
                    "IsMainRoom": 0,
                    "Location": "科技大厦",
                    "RoomCapacity": 10,
                    "RoomType": 0,
                    "Signin": 0,
                    "SubDevices": [
                        {
                            "DeviceId": 59928,
                            "DeviceName": "",
                            "DeviceType": 3
                        }
                    ]
                }
            ],
            "isGnet": 1,
            "h323Ip": null
        },
        {
            "conferenceId": "239797899",
            "pcode1": "201501000037627169",
            "pcode2": "201501000037627170",
            "billingcode": "95477391",
            "eventId": 616603,
            "attendeeJoinUrl": "https://ntest.qsh1.cn/k/mL0jSje2q0N",
            "hostJoinUrl": "https://ntest.qsh1.cn/k/mL0jSKnYAkT",
            "wcallurl": "https://stest.qsh1.cn/a/IRZfVVDTHpy0YC125C1",
            "hostId": 88610840,
            "hostName": "pei",
            "hostMobile": "",
            "startTime": 1671103800,
            "endTime": 1671105600,
            "length": 30,
            "status": 4,
            "title": "pxyces10002",
            "confMode": 0,
            "calType": "E",
            "roomId": "",
            "attendList": [
                {
                    "cityCode": "",
                    "companyName": "",
                    "contactId": "",
                    "countryCode": "",
                    "displayName": "",
                    "mobileNumber": "",
                    "officePhone": "",
                    "orgName": "",
                    "phoneEmail": "",
                    "phoneName": "",
                    "productStatus": 1,
                    "roleId": 1,
                    "status": "W",
                    "user": "88610840",
                    "userProfile": null,
                    "userType": 1
                }
            ],
            "livePullUrl": "",
            "livePullPwd": "",
            "CreateTime": 1671084634,
            "modifyTime": 1671084634,
            "timezone": "Asia/Shanghai",
            "joinLogin": 0,
            "joinConfSelTag": 0,
            "joinConfTags": "",
            "webRTCUrl": "https://ntest.qsh1.cn/k/mL0jSje2q0N?priority=web",
            "calExtraInfo": {
                "allowH323": 0,
                "reserveFrom": 1000
            },
            "confNodeType": 1,
            "houseList": [
                11836
            ],
            "equipList": [
                59928
            ],
            "detailHouseList": [
                {
                    "ApplyUserId": 88610840,
                    "ApprovalStatus": 2,
                    "City": "北京",
                    "DeviceId": 11836,
                    "DeviceName": "阳澄湖-公共",
                    "DeviceType": 2,
                    "Floor": 13,
                    "IsMainRoom": 0,
                    "Location": "科技大厦",
                    "RoomCapacity": 10,
                    "RoomType": 0,
                    "Signin": 0,
                    "SubDevices": [
                        {
                            "DeviceId": 59928,
                            "DeviceName": "",
                            "DeviceType": 3
                        }
                    ]
                }
            ],
            "isGnet": 1,
            "h323Ip": null
        }
    ],
    "request_id": "uniformserver-2886351308-1671443579.391921665.954",
    "reqid": "confopenapiserver-192.168.12.12-1671443570.238988100.81",
    "timestamp": 1671443570245,
    "request_duration": "9.5466324s"
}

4. 返回参数

参数名 类型 说明
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：周期会议
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"
    }]
}]

备注

  • 更多返回错误代码请看首页的错误代码描述

产品

支持

关于全时

下载

关注我们


全时微信公众号
24小时热线
400-810-1919