实时会议列表

分页查询实时会议列表

1. 接口描述

接口名称:

/confopenapi/conference/listbystatus

发送方式:

POST

参数格式:

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

2. 输入参数

Http Header

参数名 必选 类型 说明
token string 鉴权 token;可与 HttpBody 中的 token 二选一或同时传递,逻辑与「获得会中分组」等接口一致

HttpBody

参数名 必选 类型 说明
filterOneAttendee boolean 是否过滤仅 1 人的会议;true 表示不返回仅 1 人的会议;false 表示返回;不传由下游默认处理
adminUserId long 管理员userId, 不传默认取超级管理员的用户ID
page int 页码,从 1 开始;默认 1
count int 每页条数;默认 20

3. 请求示例

传参示例(指定子管理员、分页)

{
  "adminUserId": 123456789,
  "page": 1,
  "count": 10,
  "filterOneAttendee": false
}

4. 返回参数

参数名 类型 说明
status int 业务状态码;0 一般为成功;;非 0 表示失败或业务异常
result json 业务数据,见下表
msg string 提示信息
request_id string 请求 ID;若 RTSAS 返回 request_id 则会回写
timestamp long 时间戳(毫秒)
request_duration string 服务端处理耗时

result 参数说明

参数名 类型 说明
totalCount int 符合条件的会议总条数(与 RTSAS total_count 一致)
confList array 会议列表,元素结构见「confList 单项说明」

confList 单项说明

参数名 类型 说明
eventId long 会议预约 ID
conferenceId string 会议 ID
title string 会议主题
billingCode string 计费码
customerCode string 客户编码
pcode2 string 参会人密码
hostId long 主持人用户 ID
hostName string 主持人姓名
hostEmail string 主持人邮箱
hostMobile string 主持人手机
hostAccountType int 主持人类型(数值含义以业务为准)
hostAccountTypeStr string 主持人类型文案
hostOrgId long 主持人所属组织 ID
hostOrgName string 主持人所属组织名称
hostIp string 主持人 IP
hostLocation string 主持人归属地
startTime long 开始时间,Unix 秒
startTimeStr string 开始时间展示字符串
stopTime long 结束时间,Unix 秒
stopTimeStr string 结束时间展示字符串
confDuration int 会议时长(秒)
confDurationMinute int 会议时长(分钟)
isSecureConf boolean 是否安全会议(可能为 null)
isRecord boolean 是否录制(可能为 null)
dataCenter string 数据中心
status int 会议状态
attendeeCnt int 参会人数
voipCnt int VoIP 终端数
pstnCnt int PSTN 数
videoCnt int 视频终端数
desktopCnt int 桌面客户端数
mcuCnt int MCU 数
boxCnt int 盒子数
rawAttendeeCnt int 原始参会人数
rawPstnCnt int 原始 PSTN 数

返回示例

{
  "status": 0,
  "result": {
    "totalCount": 2,
    "confList": [
      {
        "eventId": 1165158,
        "conferenceId": "22188557",
        "confName": "周例会",
        "billingCode": "",
        "customerCode": "990001",
        "guestPcode": "5d41c4ac806c6440eb6aa8e071115f2b",
        "hostId": 10001,
        "hostName": "张三",
        "hostEmail": "zhangsan@example.com",
        "hostMobile": "",
        "hostAccountType": 1,
        "hostAccountTypeStr": "付费",
        "hostOrgId": 72927934,
        "hostOrgName": "研发部",
        "hostIp": "10.0.0.1",
        "hostLocation": "",
        "startTime": 1715600000,
        "startTimeStr": "2024-05-14 10:00:00",
        "stopTime": 0,
        "stopTimeStr": "",
        "confDuration": 3600,
        "confDurationMinute": 60,
        "isSecureConf": false,
        "isRecord": true,
        "dataCenter": "",
        "status": 2,
        "attendeeCnt": 5,
        "voipCnt": 0,
        "pstnCnt": 0,
        "videoCnt": 2,
        "desktopCnt": 3,
        "mcuCnt": 0,
        "boxCnt": 0,
        "rawAttendeeCnt": 4,
        "rawPstnCnt": 0
      }
    ]
  },
  "msg": "success",
  "request_id": "confopenapiserver-172371014-1774514768.581757447.258",
  "timestamp": 1774514768581,
  "request_duration": "38.849885ms"
}