Skip to main content

会议授权

获取会议授权

获取meet_token 接口URL
/server/v1/user-auth/grant
请求Body参数
响应示例
  • 成功(200)

踢出授权用户

接口URL
/server/v1/user-auth/kickout
请求Body参数
响应示例
  • 成功(200)

会议外

创建会议

接口URL
/server/v1/meet/create
请求Body参数
响应示例
  • 成功(200)

会前修改会议

接口URL
/server/v1/meet/update
请求Body参数
响应示例
  • 成功(200)

取消会议

接口URL
/server/v1/meet/cancel
请求Body参数
响应示例
  • 成功(200)

会议详情

接口URL
/server/v1/meet/detail
请求Body参数
响应示例
  • 成功(200)

查询会议列表

接口URL
/server/v1/meet/list-meet
请求Body参数
响应示例
  • 成功(200)

会议相关人员

接口URL
/server/v1/meet/meeting-users
请求Body参数
响应示例
  • 成功(200)

查询参会记录

接口URL
/server/v1/meet/list-record
请求Body参数
响应示例
  • 成功(200)

修改参会人员

接口URL
/server/v1/meet/update-conferee
请求Body参数
响应示例
  • 成功(200)
  • 失败(404)

移除参会人员

接口URL
/server/v1/meet/delete-conferee
请求Body参数
响应示例
  • 成功(200)
  • 失败(404)

用户聊天记录

接口URL
/server/v1/meet/user-chat-record
请求Body参数
响应示例
  • 成功(200)

聊天记录文件

接口URL
/server/v1/meet/chat-record-files
请求Body参数
响应示例
  • 成功(200)

设置事件通知

接口URL
/server/v1/meet/set-callback
请求Body参数
响应示例
  • 成功(200)
事件通知的配置方式
通过当前接口(设置事件通知)来配置回调。
上层业务方应当在业务服务启动时调用此接口来配置回调地址与监听的事件列表,
也建议在业务服务停止/卸载时同样来调用此接口设置回调地址与事件列表为空。
事件通知方式 1.POST application/json 请求
Header头额外项及签名验证方法与接口调用说明完全相同
请求的URL尾部会自动附加事件类型参数?event=xxxxx
请求体为json串, 结构定义示例如下
2.异步通知重试策略
  • http响应超过5秒, 或响应的http状态不是200时判定为失败
  • 响应数据体中code不是0时判定为失败
  • 首次失败2秒后重试, 之后每隔10秒重试, 共重试5次
3.events支持的事件及data对象中字段的定义
  • 会议状态变化 meeting_status_change
  • 用户进入会议 user_enter
  • 用户退出会议 user_exit
  • MCU状态变化 mcu_status_change
  • MCU录像完成 mcu_record_done
  • MCU警告 mcu_alarm

会中操作

结束会议

接口URL
/server/v1/meet-admin/destroy
请求Body参数
响应示例
  • 成功(200)

更新会议全体禁音频

接口URL
/server/v1/meet-admin/update-room-mic-state
请求Body参数
响应示例
  • 成功(200)

更新会议全体禁视频

接口URL
/server/v1/meet-admin/update-room-camera-state
请求Body参数
响应示例
  • 成功(200)

更新会议全体禁共享

接口URL
/server/v1/meet-admin/update-room-share-disabled
请求Body参数
响应示例
  • 成功(200)

更新会议锁定状态

接口URL
/server/v1/meet-admin/update-locked
请求Body参数
响应示例
  • 成功(200)

更改会议水印开关状态

接口URL
/server/v1/meet-admin/update-watermark-disabled
请求Body参数
响应示例
  • 成功(200)

更新会议聊天禁用状态

接口URL
/server/v1/meet-admin/update-room-chat-disabled
请求Body参数
响应示例
  • 成功(200)

修改会议截屏限制

接口URL
/server/v1/meet-admin/update-room-screenshot-disabled
请求Body参数
响应示例
  • 成功(200)

修改会议中用户名称

接口URL
/server/v1/meet-admin/update-user-name
请求Body参数
响应示例
  • 成功(200)

修改会议中用户角色

接口URL
/server/v1/meet-admin/update-user-role
请求Body参数
响应示例
  • 成功(200)

会中踢人

接口URL
/server/v1/meet-admin/kickout-user
请求Body参数
响应示例
  • 成功(200)

请求用户共享

接口URL
/server/v1/meet-admin/request-user-share
请求Body参数
响应示例
  • 成功(200)

结束进行中的共享

接口URL
/server/v1/meet-admin/stop-room-share
请求Body参数
响应示例
  • 成功(200)

请求用户打开摄像头

接口URL
/server/v1/meet-admin/request-user-open-camera
请求Body参数
响应示例
  • 成功(200)

关闭用户摄像头

接口URL
/server/v1/meet-admin/close-user-camera
请求Body参数
响应示例
  • 成功(200)

请求用户打开麦克风

接口URL
/server/v1/meet-admin/request-user-open-mic
请求Body参数
响应示例
  • 成功(200)

关闭用户麦克风

接口URL
/server/v1/meet-admin/close-user-mic
请求Body参数
响应示例
  • 成功(200)

处理举手申请

接口URL
/server/v1/meet-admin/confirm-handup
请求Body参数
响应示例
  • 成功(200)

会中发送自定义消息

接口URL
/server/v1/meet/send-room-custom-message
请求Body参数
响应示例
  • 成功(200)

查询会中人员列表

接口URL
/server/v1/meet/list-user
请求Body参数
响应示例
  • 成功(200)

会议时呼叫人员

接口URL
/server/v1/meet-admin/call-users
请求Body参数
响应示例
  • 成功(200)
  • 失败(404)

MCU任务

开始/更新MCU任务

接口URL
/server/v1/mcu/start
请求Body参数
响应示例
  • 成功(200)

结束MCU任务

接口URL
/server/v1/mcu/stop
请求Body参数
响应示例
  • 成功(200)

获取录像配置

接口URL
/server/v1/mcu/record-config
请求Body参数
响应示例
  • 成功(200)

保存录像配置

接口URL
/server/v1/mcu/save-record-config
请求Body参数
响应示例
  • 成功(200)

录像详情

接口URL
/server/v1/mcu/record-detail
请求Body参数
响应示例
  • 成功(200)

删除录像

接口URL
/server/v1/mcu/del-record
请求Body参数
响应示例
  • 成功(200)

修改录像

接口URL
/server/v1/mcu/update-record
请求Body参数
响应示例
  • 成功(200)

录像列表

接口URL
/server/v1/mcu/list-record
请求Body参数
响应示例
  • 成功(200)

录像播放地址

说明: 一般用于根据上面的”录像列表”中的数据,用task_id来获取单个录像的播放地址。传meeting_id参数时仅返回最后一个录像的播放地址。 接口URL
/server/v1/mcu/vod-url
请求Body参数
响应示例
  • 成功(200)

会议的多录像播放地址

说明: 一场会议可能有多个录像。 接口URL
/server/v1/mcu/vods-url
请求Body参数
响应示例
  • 成功(200)

获取直播流地址

接口URL
/server/v1/mcu/live-url
请求Body参数
响应示例
  • 成功(200)

设备管理

新增设备

接口URL
/server/v1/agent/create?type=regsip
请求Query参数 请求Body参数
响应示例
  • 成功(200)

修改设备

接口URL
/server/v1/agent/update?type=regsip
请求Query参数 请求Body参数
响应示例
  • 成功(200)

设备列表

设备列表,最终由应用层封装接口给应用层前端调用 接口URL
/server/v1/agent/list
请求Body参数
响应示例
  • 成功(200)

设备网关列表

接口URL
/server/v1/agent/list-gw?type=regsip
Content-Type
none
请求Query参数 响应示例
  • 成功(200)

设备详情

接口URL
/server/v1/agent/detail
请求Body参数
响应示例
  • 成功(200)

删除设备

接口URL
/server/v1/agent/delete
请求Body参数
响应示例
  • 成功(200)

邀请设备入会

接口URL
/server/v1/agent/invite
请求Body参数
响应示例
  • 成功(200)

邀请设备列表

单人多次进入有多条记录 接口URL
/server/v1/agent/list-invite
请求Body参数
响应示例
  • 成功(200)
  • 失败(200)

开关设备视频

开关设备视频,应用层后端检测到是操作设备时进行调用,如会中主持人开关设备的音视频,如何判定是否设备:根据uid是否以_agent_开头 接口URL
/server/v1/agent/set-camera-enabled
请求Body参数
响应示例
  • 成功(200)
  • 失败(404)

开关设备音频

开关设备音频,应用层后端检测到是操作设备时进行调用,如会中主持人开关设备的音视频,如何判定是否设备:根据uid是否以_agent_开头 接口URL
/server/v1/agent/set-mic-enabled
请求Body参数
响应示例
  • 成功(200)
  • 失败(404)

用户相关

在评标项类型目中约定的用户角色如下
  • 0: 未知
  • 1: 澄清人
  • 2: 评标专家
  • 3: 监管人员
  • 4: 见证人员

用户信息同步

接口URL
/stm/srvapi/v1/member/sync
请求Body参数
响应示例
  • 成功(200)

移除用户

接口URL
/stm/srvapi/v1/member/remove
请求Body参数
响应示例
  • 成功(200)

根据uids取用户信息

接口URL
/stm/srvapi/v1/member/info
请求Body参数
响应示例
  • 成功(200)

获取用户授权

接口URL
/stm/srvapi/v1/member/grant
请求Body参数
响应示例
  • 成功(200)

浏览器直接入会说明

完全体格式: https://IP或域名/meeting/stm/ui/outer?token=xxxxx&room_no=nnnnn&nickname=mmmmm 示例值:
参数解释:
注:token通过获取用户授权接口取得。