开发者中心
网易会议
知识库工单
中文
了解产品资源下载集成开发客户端 API服务端 API常见问题
输入关键词搜索
输入关键词搜索
在线咨询微信咨询电话咨询
API 概览
更新日志
调用方式
请求结构
返回结果
数据结构
会议账号管理
创建会议账号
更新会议账号
批量查询会议账号
封禁会议账号
解禁会议账号
注销会议账号
重置用户令牌
会议管理
创建会议
查询会议信息
修改会议信息
设置会议销毁时间
取消会议
结束会议
设置参会人数上限
巡检者角色管理
增加巡检者
解绑巡检者角色
会议直播管理
开始直播
自定义直播布局
修改直播
查询直播信息
结束直播
会议录播管理
获取转写文件
获取纪要文件
消息抄送
开通消息抄送
会议抄送事件
NERoom 抄送事件
错误码
附录
时区列表
周期会议设置规则
旧版接口
修改会议信息
会议账号管理
创建会议账号
查询会议账号
更新会议账号
服务端 Java SDK
开发者中心网易会议服务端 API查询会议信息

查询会议信息

更新时间： 2025/04/09 14:46:36

通过本系列接口查询某一会议的信息。

查询单个会议信息

请求 URL

GET https://roomkit.yunxinapi.com/scene/meeting/api/{appId}/v1/info/{meetingId}

URL 参数

参数名称 参数类型 是否必选 示例 说明
appId String 是 abcdefg**** 应用的 App Key。在 网易云信控制台 上，可获取应用密钥（App Key）。
meetingId Long 是 110120119 会议唯一 ID。

请求头参数

请求中 Header 的设置，请参考 请求结构 说明。

响应参数

以下是返回结果中 data 属性内包含的参数。其他统一响应参数的相关说明请参考 返回结果。

参数名称 参数类型 示例 说明
meetingId Long 110120119 会议唯一 ID。
meetingNum String 123456789 随机会议码（9 位数字）或者个人会议码（10 位数字）。
subject String 随机会议 预约会议的主题。
startTime Long 1616738307000 预约开始时间。单位为毫秒。
endTime Long 1616738307000 预约结束时间。单位为毫秒。
password String 123456 会议密码。无密码则置空。
settings JsonObject - 会议设置。详细信息请参考 settings 结构。
state Integer 1 会议状态：
  • 1：待开始
  • 2：进行中
  • 3：已结束
  • 4：已取消
  • 5：已回收
meetingShortNum String 1234 会议短号。

返回示例

JSON{
    "meetingId": "123456****",
    "meetingNum": "123456789",
    "subject": "随机会议",
    "startTime": "1616738307000",
    "endTime": "1618844844651",
    "password": "123456",
    "settings":{
    }
    "state": "1",
    "meetingShortNum": "1234"
}

使用会议号查询会议信息

使用具体的会议号查询会议信息。

请求 URL

GET https://roomkit.yunxinapi.com/scene/meeting/api/v1/info-by-meeting-num/{meetingNum}

URL 参数

参数名称 参数类型 是否必选 示例 说明
meetingNum String 否 "824756214" 会议号（9 位数字）或者个人会议号（10 位数字）。

请求头参数

请求中 Header 的设置，请参考 请求结构 说明。

响应参数

以下是返回结果中 data 属性内包含的参数。其他统一响应参数的相关说明请参考 返回结果。

参数名称 参数类型 示例 说明
meetingId Long 110120119 会议唯一 ID。
meetingNum String "824756214" 会议号（9 位数字）或者个人会议号（10 位数字）。
subject String "张三预约的会议" 会议的主题。
startTime Long 1616738307000 会议开始时间。单位为毫秒。
endTime Long 1616738307000 会议结束时间。单位为毫秒。
type Integer 3 会议类型：
  • 0：未开始
  • 1：进行中
  • 2：已结束
state Integer 5 会议状态：
  • 1：待开始
  • 2：进行中
  • 3：已结束
  • 4：已取消
  • 5：已回收
timezoneId String "Asia/Shanghai" 世界时区。
shortMeetingNum Integer - 会议短号。
settings Object - 会议设置，包括房间信息、直播信息、录制配置。详细信息请参考 settings 结构。
ownerUserUuid String "ac939366f*****caf29620c" 会议所有者 ID。
ownerNickname String "random" 会议所有者昵称。

返回示例

JSON{
    "meetingId": 847104,
    "meetingNum": "824756214",
    "roomUuid": "824756214",
    "subject": "张三预约的会议",
    "type": 3,
    "state": 5,
    "startTime": 1737466200000,
    "endTime": 1737468000000,
    "timezoneId": "Asia/Shanghai",
    "settings": {
    },
    "ownerUserUuid": "ac939366f*****caf29620c",
    "roomArchiveId": "847104",
    "meetingAppKey": "4649991c6ab7cc*****d8793e5"
}

批量查询会议信息

请求 URL

POST https://roomkit.yunxinapi.com/scene/meeting/api/{appId}/v1/infoList

URL 参数

参数名称 参数类型 是否必选 示例 说明
appId String 是 abcdefg**** 应用的 App Key。在 网易云信控制台 上，可获取应用密钥（App Key）。

请求头参数

请求中 Header 的设置，请参考 请求结构 说明。

请求体参数

参数名称 参数类型 示例 说明
meetingIds List [110120119, 120110119] 会议唯一 ID 列表。

响应参数

以下是返回结果中 data 属性内包含的参数。其他统一响应参数的相关说明请参考 返回结果。

参数名称 参数类型 示例 说明
meetingId Long 110120119 会议唯一 ID。
meetingNum String 123456789 随机会议码（9 位数字）或者个人会议码（10 位数字）。
subject String 随机会议 预约会议的主题。
startTime Long 1616738307000 预约开始时间。单位为毫秒。
endTime Long 1616738307000 预约结束时间。单位为毫秒。
password String 123456 会议密码。无密码则置空。
settings JsonObject - 会议设置。详细信息请参考 settings 结构。
state Integer 1 会议状态：
  • 1：待开始
  • 2：进行中
  • 3：已结束
  • 4：已取消
  • 5：已回收
meetingShortNum String 1234 会议短号。

请求体示例

JSON{
  "meetingIds": [
    110120119,
    120110119
  ]
}

响应体示例

JSON{
  "meetingInfos": [
    {
      "meetingId": "123456****",
      "meetingNum": "123456789",
      "subject": "随机会议",
      "startTime": "1616738307000",
      "endTime": "1618844844651",
      "password": "123456",
      "settings": {},
      "state": "1",
      "meetingShortNum": "1234"
    },
    {
      "meetingId": "654321****",
      "meetingNum": "987654321",
      "subject": "随机会议",
      "startTime": "1616738307000",
      "endTime": "1618844844651",
      "password": "123456",
      "settings": {},
      "state": "3",
      "meetingShortNum": "1111"
    }
  ]
}

获取正在进行的会议列表

本接口返回指定用户账户当前参与的所有进行中会议列表，包含以下三种场景：

  • 用户作为 参会者 正在加入的会议。

  • 用户作为 创建者 发起的进行中会议。

  • 用户作为 被邀请成员 参与的进行中会议。

返回结果将按会议实际开始时间升序排列，即从最早开始到最晚开始。

请求 URL

GET https://roomkit.yunxinapi.com/scene/meeting/api/v1/user/{userUuid}/meetings/ongoing

请求头参数

请求中 Header 的设置，请参考 请求结构 说明。

请求体参数

参数名称 参数类型 是否必选 说明
userUuid String 是 会议账户 ID，该参数为路径参数。
meetingNum String 否 会议号。
startTime Long 否 开始时间的时间戳，单位为毫秒。
endTime Long 否 结束时间的时间戳，单位为毫秒。
pageNum Integer 否 返回结果的页码，从 1 开始，默认 1。
pageSize Integer 否 每页记录数，默认 20，最大 50。

响应参数

参数名称 参数类型 说明
total Long 总记录数。
- data List<MeetingInfoDto> 会议信息列表。
meetingId String 会议 ID。
meetingNum String 会议号。
subject String 会议主题文案。
startTime Long 会议开始时间的时间戳，单位为毫秒。
endTime Long 会议结束时间的时间戳，单位为毫秒。
type Integer 会议类型：
  • 0：未开始
  • 1：进行中
  • 2：已结束
state Integer 会议状态：
  • 1：待开始
  • 2：进行中
  • 3：已结束
  • 4：已取消
  • 5：已回收
timezoneId String 会议时间相关信息的时区。
shortMeetingNum Integer 会议短号。
settings Object 详细信息请参考 settings 结构。
ownerUserUUid String 会议主持人的账号 ID。
ownerNickname String 会议主持人的昵称。

响应体示例

JSON{
"data": [
{
    "meetingId": 847104,
    "meetingNum": "824756214",
    "roomUuid": "824756214",
    "subject": "优秀的鲸鱼预约的会议",
    "type": 3,
    "state": 5,
    "startTime": 1737466200000,
    "endTime": 1737468000000,
    "timezoneId": "Asia/Shanghai",
    "settings": {
    },
    "ownerUserUuid": "ac939366f193b40ca*****",
    "roomArchiveId": "847104",
    "meetingAppKey": "4649991c6ab7cc5a4309ccf25d8793e5"
},
{
    "meetingId": 847105,
    "meetingNum": "824966738",
    "roomUuid": "824966738",
    "subject": "1234",
    "type": 3,
    "state": 5,
    "startTime": 1737466200000,
    "endTime": 1737468000000,
    "timezoneId": "Asia/Shanghai",
    "settings": {},
    "ownerUserUuid": "ac939366f193b40ca*****",
    "roomArchiveId": "847105",
    "meetingAppKey": "4649991c6ab7cc5a4309ccf25d8793e5"
}
]
}

获取未开始的会议列表

本接口返回指定用户账户所有未开始的会议列表，包含以下两种场景：

  • 用户作为 创建者 发起的未实际开始的会议。

  • 用户作为 被邀请成员 参与的未开始的会议。

返回结果将按会议的 实际开始时间 升序排列，即从最早开始到最晚开始。

请求 URL

GET https://roomkit.yunxinapi.com/scene/meeting/api/v1/user/{userUuid}/meetings/scheduled

请求头参数

请求中 Header 的设置，请参考 请求结构 说明。

请求体参数

参数名称 参数类型 是否必选 说明
userUuid String 是 会议账户 ID，该参数为路径参数。
meetingNum String 否 会议号。
startTime Long 否 开始时间的时间戳，单位为毫秒。
endTime Long 否 结束时间的时间戳，单位为毫秒。
pageNum Integer 否 返回结果的页码，从 1 开始。
pageSize Integer 否 每页记录数。

响应参数

参数名称 参数类型 说明
total Long 总记录数。
- data List<MeetingInfoDto> 会议信息列表。
meetingId String 会议 ID。
meetingNum String 会议号。
subject String 会议主题文案。
startTime Long 会议开始时间的时间戳，单位为毫秒。
endTime Long 会议结束时间的时间戳，单位为毫秒。
type Integer 会议类型：
  • 0：未开始
  • 1：进行中
  • 2：已结束
state Integer 会议状态：
  • 1：待开始
  • 2：进行中
  • 3：已结束
  • 4：已取消
  • 5：已回收
timezoneId String 会议时间相关信息的时区。
shortMeetingNum Integer 会议短号。
settings Object 详细信息请参考 settings 结构。
ownerUserUUid String 会议主持人的账号 ID。
ownerNickname String 会议主持人的昵称。

响应体示例

JSON{
"data": [
{
    "meetingId": 847104,
    "meetingNum": "824756214",
    "roomUuid": "824756214",
    "subject": "优秀的鲸鱼预约的会议",
    "type": 3,
    "state": 5,
    "startTime": 1737466200000,
    "endTime": 1737468000000,
    "timezoneId": "Asia/Shanghai",
    "settings": {},
    "ownerUserUuid": "ac939366f193b40ca*****",
    "roomArchiveId": "847104",
    "meetingAppKey": "4649991c6ab7cc5a4309ccf25d8793e5"
},
{
    "meetingId": 847105,
    "meetingNum": "824966738",
    "roomUuid": "824966738",
    "subject": "1234",
    "type": 3,
    "state": 5,
    "startTime": 1737466200000,
    "endTime": 1737468000000,
    "timezoneId": "Asia/Shanghai",
    "settings": {},
    "ownerUserUuid": "ac939366f193b40ca*****",
    "roomArchiveId": "847105",
    "meetingAppKey": "4649991c6ab7cc5a4309ccf25d8793e5"
}
]
}

获取当前用户历史会议列表

本接口返回指定用户账户所有的历史会议列表，包含以下两种场景：

  • 用户作为 创建者 发起过的历史会议。

  • 用户作为 参会者 参与过的历史会议。

返回结果将按会议实际开始时间升序排列，即从最早开始到最晚开始。

请求 URL

GET https://roomkit.yunxinapi.com/scene/meeting/api/v1/user/{userUuid}/meetings/historical

请求头参数

请求中 Header 的设置，请参考 请求结构 说明。

请求体参数

参数名称 参数类型 是否必选 说明
userUuid String 是 会议账户 ID，该参数为路径参数。
meetingNum String 否 会议号。
startTime Long 是 开始时间的时间戳，单位为毫秒。查询历史必传，查询最大时间间隔 31 天。
endTime Long 是 结束时间的时间戳，单位为毫秒。查询历史必传，最大时间间隔 31 天。
pageNum Integer 否 返回结果的页码，从 1 开始。
pageSize Integer 否 每页记录数。

响应参数

参数名称 参数类型 说明
total Long 总记录数。
- data List<MeetingInfoDto> 会议信息列表。
meetingId String 会议 ID。
meetingNum String 会议号。
subject String 会议主题文案。
startTime Long 会议开始时间的时间戳，单位为毫秒。
endTime Long 会议结束时间的时间戳，单位为毫秒。
type Integer 会议类型：
  • 0：未开始
  • 1：进行中
  • 2：已结束
state Integer 会议状态：
  • 1：待开始
  • 2：进行中
  • 3：已结束
  • 4：已取消
  • 5：已回收
timezoneId String 会议时间相关信息的时区。
shortMeetingNum Integer 会议短号。
settings Object 详细信息请参考 settings 结构。
ownerUserUUid String 会议主持人的账号 ID。
ownerNickname String 会议主持人的昵称。

响应体示例

JSON{
"data": [
{
    "meetingId": 847105,
    "meetingNum": "824966738",
    "roomUuid": "824966738",
    "subject": "1234",
    "type": 3,
    "state": 5,
    "startTime": 1737466200000,
    "endTime": 1737468000000,
    "timezoneId": "Asia/Shanghai",
    "settings": {},
    "ownerUserUuid": "ac939366f193b40ca*****",
    "roomArchiveId": "847105",
    "meetingAppKey": "4649991c6ab7cc5a4309ccf25d8793e5"
}
]
}

查询会议成员列表

查询会议成员列表，返回当前会议室所有成员列表。

请求 URL

GET https://roomkit.yunxinapi.com/scene/meeting/api/v1/meeting-members?meetingId={meetingId}&online=true

请求头参数

请求中 Header 的设置，请参考 请求结构 说明。

请求查询参数

参数名称 数据类型 是否必选 说明
meetingId Long 是 会议 ID。
online Boolean 否 传 true 表示只查询在线用户。

请求示例

GET {host}/scene/meeting/api/v1/meeting-members?meetingId={meetingId}

响应参数

参数名称 数据类型 说明
code Integer 状态码，0=成功。
msg String 消息。
requestId String 请求 ID。
- data Object 无。
total Integer 总数。
- data Object 结构。
userUuid String 用户 ID。
userName String 用户昵称。
role String 成员角色。
ip String 设备入会的 IP 地址。
location String 位置。
firstEntryTime Long 首次入会时间。
lastLeaveTime Long 最后离会时间，为 0 表示未离开会议。
clientType String 设备类别。
- history List 参会历史记录，history 的结构。
entryTime Long 进会时间，页面取第一条的 entryTime !=0 的记录作为入会时间。
leaveTime Long 离会时间，页面取最后的 leaveTime !=0 的记录作为最后离会时间。
entryCount Integer 入会次数。
duration Long 参会时长。

响应体示例

JSON{
"data":{
    "total": 100,
    "data": [
      {
          "userUuid": "test111",
          "role": "host",
          "state": 1,
          "ip": "192.1.1.1",
          "location": "浙江杭州",
          "clientType": "Windows",
          "history":[
                {
                      "entryTime": 17666666666,
                      "leaveTime": 17800000000,                  
                },
                {
                      "entryTime": 17666666667,
                      "leaveTime": 17800000009,                
                }          
          ],
          "entryCount": 3,
          "duration": 100000                 
      }
    ]
}
}

导出参会成员概览

导出参会成员概览。导出结果包含会议信息和参会成员信息，格式为 .xlsx 表格文件，文件中的具体字段同 会议查询接口。您可调用 /scene/meeting/api/v1/export/{taskId} 接口查询异步操作结果。

请求 URL

POST https://roomkit.yunxinapi.com/scene/meeting/api/v1/export-member-list?meetingId={meetingId}&fileType={xlsx}

请求头参数

请求中 Header 的设置，请参考 请求结构 说明。

请求路径参数

参数名称 参数类型 是否必选 说明
meetingId String 是 会议的唯一 ID。
fileType String 否 导出文件类型，默认为 xlsx。可支持文件类型：xlsx。

响应参数

参数名称 参数类型 说明
taskId String 任务 ID。

查询异步任务结果

获取异步导出任务的结果。目前提供 导出参会成员概览 的接口。

请求 URL

GET https://roomkit.yunxinapi.com/scene/meeting/api/v1/export/{taskId}

请求参数

参数名称 参数类型 是否必选 说明
taskId String 是 任务 ID。

响应参数

参数名称 参数类型 说明

status

Integer

任务状态：

  • 0：处理中
  • 1：成功
  • 2：失败
operateTime Long 操作时间。
businessCode Integer 1：成员参会记录导出。
taskId String 任务 ID。
resultData Object 结果。
url String 任务下载链接，有效期 2 小时。
errMsg String 错误信息。
此文档是否对你有帮助？
有帮助
去反馈
  • 查询单个会议信息
  • 使用会议号查询会议信息
  • 批量查询会议信息
  • 获取正在进行的会议列表
  • 获取未开始的会议列表
  • 获取当前用户历史会议列表
  • 查询会议成员列表
  • 导出参会成员概览
  • 查询异步任务结果
在线咨询微信咨询电话咨询
© 1997-2024 网易公司增值电信业务许可证B1-20180288浙B1.B2-20090185浙公网安备浙公网安备 33010802002218号浙ICP备17006647号-3工业和信息化部备案管理系统网站隐私政策