string
设置事件通知
POST /server/v1/meet/set-callback
鉴权:需要(见概览)
设置回调信息
请求参数
array<string>
监听事件列表
string
回调地址
string
返回数据
查询会议列表
POST /server/v1/meet/list-meet
鉴权:需要(见概览)
会议列表
请求参数
string
房间号
string
会议ID
array<string>
会议id列表
integer
按会议类型筛选 1即时会议 2预约会议
array<integer>
按会议状态筛选,可多选 1未开始 2进行中 3已结束
string
按创建者用户ID筛选
integer
开始时间
integer
结束时间
integer
会议计划开始时间区间
integer
会议计划开始时间区间
integer
开始时间 (时间戳),预约会议必填
string
排序,可排序字段 created_at,前缀 - 表示倒序(可排序字段:created_at)
integer
页数,从1开始
示例:
1integer
每页数据量
示例:
10string
会议id
string
房间号
string
会议标题
string
会议说明
integer
会议状态 1未开始 2进行中 3结束
integer
1 无限制(默认) 2 密码进入 3 仅邀请人员参会
integer
会议类型 1即时会议 2预约会议
integer
开始时间 (时间戳),预约会议必填
integer
持续时间(单位分钟),预约会议必填
integer
开始时间
integer
结束时间
integer
最后一人离会的时间戳,会议未结束时为 0
integer
入会静音选项
boolean
水印是否关闭 false:不关闭 true:关闭
boolean
截屏是否禁止 false:不禁止 true:禁止
boolean
房间禁音允许自我解除 false:允许解除 true:不允许
boolean
房间禁视频允许自我解除 false:允许解除 true:不允许
boolean
房间禁音频 false:不禁音 true:禁音
boolean
房间禁视频 false:不禁视频 true:禁视频
禁止共享 false:不禁止(默认) true:禁止
boolean
房间禁聊天 false:不禁聊天 true:禁聊天
boolean
等待室是否关闭 false:不关闭 true:关闭
boolean
在主持人前禁入会 false:允许 true:禁止
boolean
强制入会
boolean
锁定状态 false:不锁定 true:锁定
object
扩展字段
string
会议创建者ID
string
会议创建者名称
string
主持人用户ID
array<string>
联席主持人用户ID列表
array<string>
邀请人员ID列表
array<object>
邀请人员详情列表
integer
会议模式字段 1普通模式 2合成模式
boolean
是否自动录像
any
布局数据
integer
录制状态 0待开始 1进行中 2待结束 3异常结束 4正常结束
integer
创建时间(时间戳)
integer
更新时间
查询会中人员列表
POST /server/v1/meet/list-user
鉴权:需要(见概览)
会中人员
请求参数
string
房间号
string
会议ID
integer
页数,从1开始
示例:
1integer
每页数据量
示例:
10string
用户ID
string
会中昵称
integer
用户角色
integer
音频状态 1开, 2关
integer
视频状态 1开, 2关
共享状态 0无共享 1屏幕 2白板
boolean
是否已被踢出
boolean
是否被禁止聊天 false:未禁止 true:已禁止
integer
设备类型 0未知 1Windows 2Android 3iOS 4Linux 5MacOS 6webrtc 7小程序,80及以上为接入设备
string
扩展字段,入会时由客户端带入
integer
进入时间
查询会议相关人员
POST /server/v1/meet/meeting-users
鉴权:需要(见概览)
会议相关人员
请求参数
string
房间号
string
会议ID
integer
页数,从1开始
示例:
1integer
每页数据量
示例:
10string
用户ID
string
用户帐号
string
真实名称
string
会中昵称
string
用户头像
integer
用户角色
boolean
是否邀约(白名单)
integer
首次入会时间
integer
最后离开会时间
查询参会记录
POST /server/v1/meet/list-record
鉴权:需要(见概览)
参会记录
请求参数
string
房间号
string
会议ID
string
用户ID
integer
开始时间
integer
结束时间
string
排序,可排序字段 updated_at / created_at,逗号分隔,前缀 - 表示倒序(可排序字段:updated_at、created_at)
integer
页数,从1开始
示例:
1integer
每页数据量
示例:
10string
应用ID
string
会议ID
string
用户ID
string
会中昵称
string
手机号
integer
用户角色
integer
进入时间
integer
离开时间
integer
设备类型 0未知 1Windows 2Android 3iOS 4Linux 5MacOS 6webrtc 7小程序,80及以上为接入设备
string
扩展字段,入会时由客户端带入
会中发送自定义消息
POST /server/v1/meet/send-room-custom-message
鉴权:需要(见概览)
请求参数
string
必填
会议ID
string
必填
消息内容,最长500字符(最大长度 500)
string
用户id
string
返回数据
会议详情
POST /server/v1/meet/detail
鉴权:需要(见概览)
请求参数
string
房间号
string
会议ID
string
设备ID
string
房间号
string
会议标题
string
会议说明
integer
会议状态 1未开始 2进行中 3已结束
integer
1 无限制(默认) 2 密码进入 3 仅邀请人员参会
integer
会议类型 1即时会议 2预约会议
string
密码,attend_type为2时必填
integer
开始时间 (时间戳),预约会议必填
integer
持续时间(单位分钟),预约会议必填
integer
实际开始时间(时间戳),未开始为 0
integer
结束时间
integer
最后一人离会的时间戳,会议未结束时为 0
integer
当前在线人数
integer
入会静音状态 1:开启入会静音(所有人入会默认静音) 2:关闭(跟随客户端初始音频状态) 3:超6人静音(超过6人后入会静音) 默认值3
boolean
水印是否关闭 false:不关闭 true:关闭
boolean
截屏是否禁止 false:不禁止 true:禁止
boolean
全体静音时是否禁止成员自行解除 false:不禁止 true:禁止
boolean
全体关视频时是否禁止成员自行打开 false:不禁止 true:禁止
boolean
全体静音 false:未静音 true:已静音
boolean
全体关视频 false:未关 true:已关
禁止共享 false:不禁止(默认) true:禁止
boolean
是否禁止全体聊天 false:不禁止 true:禁止
boolean
等待室是否关闭 false:不关闭 true:关闭
boolean
主持人入会前是否禁止他人进入 false:允许 true:禁止
boolean
强制入会
boolean
锁定状态,锁定后新人无法进入 false:不锁定 true:锁定
object
扩展字段
string
会议创建者ID
string
会议创建者名称
string
主持人用户ID
array<string>
联席主持人用户ID列表
array<string>
邀请人员ID列表
array<object>
邀请人员详情列表
integer
会议模式字段 1普通模式 2合成模式 3语音模式 4培训模式 5小组讨论模式
boolean
是否自动录像
any
布局数据
integer
录制状态 0待开始 1进行中 2待结束 3异常结束 4正常结束
integer
创建时间(时间戳)
integer
更新时间
取消会议
POST /server/v1/meet/cancel
鉴权:需要(见概览)
取消会议(仅会议前)
请求参数
string
房间号
string
会议ID
string
返回数据
创建会议
POST /server/v1/meet/create
鉴权:需要(见概览)
请求参数
string
创建人
string
创建人昵称
string
房间号(最大长度 50)
string
必填
会议标题(最大长度 100)
string
会议说明(最大长度 500)
string
入会密码(最大长度 50)
integer
必填
会议类型 1:即时会议 2:预约会议
integer
加入会议类型 1 无限制 2 密码进入 3 邀请人员参会 4密码+白名单
array<string>
联席主持ID列表
array<string>
邀请人员列表(兼容旧接口)
array<object>
邀请人员详情列表(新接口)
integer
开始时间
integer
持续时长 (单位分钟)
integer
入会静音选项
boolean
水印是否关闭 false:不关闭 true:关闭
boolean
截屏是否禁止 false:不禁止 true:禁止
boolean
房间禁音允许自我解除 false:允许解除 true:不允许
boolean
房间禁视频允许自我解除 false:允许解除 true:不允许
boolean
房间禁音频 false:不禁音 true:禁音
boolean
房间禁视频 false:不禁视频 true:禁视频
房间禁共享 false:不禁共享 true:禁共享
boolean
房间禁聊天 false:不禁聊天 true:禁聊天
boolean
等待室是否关闭 false:不关闭 true:关闭
boolean
主持人入会前是否允许其他人加入 false:允许 true:不允许
boolean
是否强制加入
object
扩展字段
integer
会议模式字段 1普通模式 2合成模式
boolean
是否自动录像
object
布局数据
string
会议ID,后续所有会议接口都用它
string
房间号,用户在客户端输入这个号码进会
会前修改会议
POST /server/v1/meet/update
鉴权:需要(见概览)
更新会议
请求参数
string
必填
会议ID
string
创建人
string
会议标题(最大长度 100)
string
会议说明(最大长度 500)
integer
加入会议类型 1 无限制 2 密码进入 3 邀请人员参会 4密码+白名单
string
入会密码(最大长度 50)
array<string>
邀请人员列表(兼容旧接口)
array<object>
邀请人员详情列表(新接口)
integer
开始时间
integer
持续时长 (单位分钟)
integer
入会静音选项
boolean
水印是否关闭 false:不关闭 true:关闭
boolean
截屏是否禁止 false:不禁止 true:禁止
boolean
房间禁聊天 false:不禁聊天 true:禁聊天
boolean
等待室是否关闭 false:不关闭 true:关闭
boolean
主持人入会前是否允许其他人加入 false:允许 true:不允许
boolean
是否强制加入
array<string>
联席主持ID列表
object
扩展字段
integer
会议模式字段 1普通模式 2合成模式
boolean
是否自动录像
object
布局数据
string
返回数据
修改参会人员
POST /server/v1/meet/update-conferee
鉴权:需要(见概览)
会议时修改参会人员
请求参数
string
房间号
string
会议ID
array<string>
参会人员(兼容旧接口)
array<object>
参会人员详情列表(新接口)
boolean
是否是追加
boolean
是否强制加入(调呼叫入会时参数才有效)
string
返回数据
移除参会人员
POST /server/v1/meet/delete-conferee
鉴权:需要(见概览)
删除白名单用户
请求参数
string
房间号
string
会议ID
array<string>
必填
用户ID列表
string
返回数据
查询用户聊天记录
POST /server/v1/meet/user-chat-record
鉴权:需要(见概览)
用户聊天记录
请求参数
string
房间号
string
会议ID
string
按发送者用户ID筛选
integer
消息类型 1:文本 2:文件 3:图片 4:语音
string
消息内容
integer
聊天时间区间
integer
聊天时间区间
string
排序字段,逗号分隔,前缀 - 表示倒序,如 -created_at
integer
页数,从1开始
示例:
1integer
每页数据量
示例:
10string
设备ID
string
会议ID
string
消息发送者第三方用户ID
string
消息发送者名称
string
消息发送者真实姓名
integer
消息发送者角色
integer
消息类型 1:文本 2:文件 3:图片 4:语音
string
消息内容
integer
发送时间(时间戳)
查询聊天记录中的文件
POST /server/v1/meet/chat-record-files
鉴权:需要(见概览)
聊天记录文件
请求参数
string
房间号
string
会议ID
string
文件名
string
文件大小(字节)
string
文件的Key
string
播放/下载地址 2小时有效
今日会议概况
POST /server/v1/meet/today
鉴权:需要(见概览)
今日数据
请求参数
无
响应参数
integer
日期
integer
次数
integer
时长(秒)
会议量统计
POST /server/v1/meet/stats
鉴权:需要(见概览)
会议统计
请求参数
integer
开始时间
integer
结束时间
string
日期
integer
次数
integer
时长(秒)