跳到主要内容

接口概览

登陆认证#

接口名称接口方法接口URL
token获取POST/api/v1/system/token
保持token心跳POST/api/v1/system/token/{account_token}/heartbeat
登陆POST/api/v1/system/login
保持用户心跳POST/api/v1/system/heartbeat
登录认证API版本信息GET/api/system/version

会议管理#

接口名称接口方法接口URL
获取个人模板列表GET/api/v1/mc/personal_templates
获取个人模板详情GET/api/v1/mc/personal_templates/{id}
创建个人模板POST/api/v1/mc/personal_templates
修改个人模板POST/api/v1/mc/personal_templates/{id}
删除个人模板DELETE/api/v1/mc/personal_templates/{id}
获取预约会议列表GET/api/v1/mc/booked_confs
获取预约会议信息GET/api/v1/mc/booked_confs/{conf_id}
获取会议列表GET/api/v1/mc/meetings
获取会议信息GET/api/v1/mc/meetings/{meeting_id}
创建会议POST/api/v1/mc/confs
结束会议DELETE/api/v1/mc/confs/{conf_id}
获取简单个人模板详情GET/api/v1/mc/personal_templates/{id}/simple
获取个人模板参会人员GET/api/v1/mc/personal_templates/{id}/invite_members
获取个人模板混音信息GET/api/v1/mc/personal_templates/{id}/mix
获取个人模板VMP信息GET/api/v1/mc/personal_templates/{id}/vmp
获取个人模板轮询信息GET/api/v1/mc/personal_templates/{id}/poll
获取个人模板vipGET/api/v1/mc/personal_templates/{id}/vip
创建虚拟会议室POST/api/v1/mc/virtual_meeting_rooms
修改虚拟会议室POST/api/v1/mc/virtual_meeting_rooms/{id}
删除虚拟会议室DELETE/api/v1/mc/virtual_meeting_rooms/{id}
获取虚拟会议室列表GET/api/v1/mc/virtual_meeting_rooms
获取虚拟会议室详情GET/api/v1/mc/virtual_meeting_rooms/{id}
获取资源占用情况GET/api/v1/mc/resources
获取当前用户域可以使用的会议平台GET/api/v1/mc/platforms
获取会议室区域列表GET/api/v1/mc/meeting_room_areas
创建会议室区域POST/api/v1/mc/meeting_room_areas
修改会议室区域POST/api/v1/mc/meeting_room_areas/{id}
删除会议室区域DELETE/api/v1/mc/meeting_room_areas/{id}
上传会议文件POST/api/v1/mc/meeting_files/{meeting_id}
删除会议文件DELETE/api/v1/mc/meeting_files/{file_id}
获取会议文件列表GET/api/v1/mc/meeting_files/{meeting_id}
获取会管API版本信息GET/api/mc/version
预约视频会议POST/api/v1/mc/booked_confs
更新视频会议POST/api/v1/mc/booked_confs/{conf_id}
删除预约会议DELETE/api/v1/mc/booked_confs/{conf_id}
会议名称校验GET/api/v1/mc/valid_conf_name

会议控制#

接口名称接口方法接口URL
获取视频会议列表GET/api/v1/vc/confs
获取视频会议信息GET/api/v1/vc/confs/{conf_id}
获取会议级联信息GET/api/v1/vc/confs/{conf_id}/cascades
获取级联会议终端列表GET/api/v1/vc/confs/{conf_id}/cascades/{cascade_id}/mts
获取本级会议终端列表GET/api/v1/vc/confs/{conf_id}/mts
获取与会终端信息GET/api/v1/vc/confs/{conf_id}/mts/{mt_id}
批量添加级联终端POST/api/v1/vc/confs/{conf_id}/cascades/{cascade_id}/mts
批量添加本级终端POST/api/v1/vc/confs/{conf_id}/mts
批量删除终端DELETE/api/v1/vc/confs/{conf_id}/mts
获取上传终端GET/api/v1/vc/confs/{conf_id}/upload
上传终端操作PUT/api/v1/vc/confs/{conf_id}/upload
获取上传终端轮询信息GET/api/v1/vc/confs/{conf_id}/upload_poll
开启上传终端轮询PUT/api/v1/vc/confs/{conf_id}/upload_poll
修改上传终端轮询状态PUT/api/v1/vc/confs/{conf_id}/upload_poll/state
批量呼叫终端POST/api/v1/vc/confs/{conf_id}/online_mts
批量挂断终端DELETE/api/v1/vc/confs/{conf_id}/online_mts
获取会议主席GET/api/v1/vc/confs/{conf_id}/chairman
指定会议主席PUT/api/v1/vc/confs/{conf_id}/chairman
获取会议发言人GET/api/v1/vc/confs/{conf_id}/speaker
指定会议发言人PUT/api/v1/vc/confs/{conf_id}/speaker
获取会议双流源GET/api/v1/vc/confs/{conf_id}/dualstream
指定会议双流源PUT/api/v1/vc/confs/{conf_id}/dualstream
取消会议双流源DELETE/api/v1/vc/confs/{conf_id}/dualstream
延长会议时间POST/api/v1/vc/confs/{conf_id}/delay
会场静音操作PUT/api/v1/vc/confs/{conf_id}/silence
会场哑音操作PUT/api/v1/vc/confs/{conf_id}/mute
会议安全操作PUT/api/v1/vc/confs/{conf_id}/safty
修改会议名称POST/api/v1/vc/confs/{conf_id}/name
发送短消息POST/api/v1/vc/confs/{conf_id}/sms
设置强制广播PUT/api/v1/vc/confs/{conf_id}/forcebroadcast
开启/关闭语音激励PUT/api/v1/vc/confs/{conf_id}/vad
获取语音激励信息GET/api/v1/vc/confs/{conf_id}/vad
获取会议混音信息GET/api/v1/vc/confs/{conf_id}/mixs/{mix_id}
开启会议混音POST/api/v1/vc/confs/{conf_id}/mixs
停止会议混音DELETE/api/v1/vc/confs/{conf_id}/mixs/{mix_id}
添加混音成员POST/api/v1/vc/confs/{conf_id}/mixs/{mix_id}/members
删除混音成员DELETE/api/v1/vc/confs/{conf_id}/mixs/{mix_id}/members
获取会议画面合成信息GET/api/v1/vc/confs/{conf_id}/vmps/{vmp_id}
开启会议画面合成POST/api/v1/vc/confs/{conf_id}/vmps
修改会议画面合成POST/api/v1/vc/confs/{conf_id}/vmps/{vmp_id}
停止会议画面合成DELETE/api/v1/vc/confs/{conf_id}/vmps/{vmp_id}
获取主席轮询信息GET/api/v1/vc/confs/{conf_id}/chairman_poll
开启主席轮询PUT/api/v1/vc/confs/{conf_id}/chairman_poll
修改主席轮询状态PUT/api/v1/vc/confs/{conf_id}/chairman_poll/state
获取会议轮询信息GET/api/v1/vc/confs/{conf_id}/poll
开启会议轮询PUT/api/v1/vc/confs/{conf_id}/poll
修改会议轮询状态PUT/api/v1/vc/confs/{conf_id}/poll/state
开启录像POST/api/v1/vc/confs/{conf_id}/recorders
获取录像状态GET/api/v1/vc/confs/{conf_id}/recorders/{rec_id}
获取录像列表GET/api/v1/vc/confs/{conf_id}/recorders
修改录像状态PUT/api/v1/vc/confs/{conf_id}/recorders/{rec_id}/state
停止录像DELETE/api/v1/vc/confs/{conf_id}/recorders/{rec_id}
开始放像PUT/api/v1/vc/confs/{conf_id}/playback
暂停、继续、停止放像PUT/api/v1/vc/confs/{conf_id}/playback/state
调整放像进度PUT/api/v1/vc/confs/{conf_id}/playback/current_progress
获取会议放像状态GET/api/v1/vc/confs/{conf_id}/playback
开启终端自主画面合成POST/api/v1/vc/confs/{conf_id}/mtvmps
获取终端自主画面合成信息GET/api/v1/vc/confs/{conf_id}/mtvmps/{mt_id}
修改终端自主画面合成参数PUT/api/v1/vc/confs/{conf_id}/mtvmps/{mt_id}
停止终端自主画面合成DELETE/api/v1/vc/confs/{conf_id}/mtvmps/{mt_id}
获取开启自主画面合成的终端列表GET/api/v1/vc/confs/{conf_id}/mtvmps
开启终端单通道自主画面合成POST/api/v1/vc/confs/{conf_id}/mt_channel_vmps
获取终端单通道自主画面合成信息GET/api/v1/vc/confs/{conf_id}/mt_channel_vmps/{mt_id}/{mt_chn_idx}
修改终端单通道自主画面合成参数PUT/api/v1/vc/confs/{conf_id}/mt_channel_vmps/{mt_id}/{mt_chn_idx}
停止终端单通道自主画面合成DELETE/api/v1/vc/confs/{conf_id}/mt_channel_vmps/{mt_id}/{mt_chn_idx}
获取开启单通道自主画面合成的终端列表GET/api/v1/vc/confs/{conf_id}/mt_channel_vmps
开启电视墙自主画面合成POST/api/v1/vc/confs/{conf_id}/hduvmps
获取电视墙自主画面合成信息GET/api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id}
修改电视墙自主画面合成参数PUT/api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id}
停止电视墙自主画面合成DELETE/api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id}
获取开启自主画面合成的电视墙列表GET/api/v1/vc/confs/{conf_id}/hduvmps
获取平台电视墙列表GET/api/v1/vc/hdus
获取会议电视墙列表GET/api/v1/vc/confs/{conf_id}/hdus
获取电视墙通道信息GET/api/v1/vc/confs/{conf_id}/hdus/{hdu_id}
开启电视墙POST/api/v1/vc/confs/{conf_id}/hdus
电视墙别名操作PUT/api/v1/vc/confs/{conf_id}/hdus/{hdu_id}/alias
关闭电视墙DELETE/api/v1/vc/confs/{conf_id}/hdus/{hdu_id}
获取电视墙批量轮询信息GET/api/v1/vc/confs/{conf_id}/hdupoll/{hdupoll_id}
开启电视墙批量轮询POST/api/v1/vc/confs/{conf_id}/hdupoll
修改电视墙批量轮询状态PUT/api/v1/vc/confs/{conf_id}/hdupoll/state
获取监控列表GET/api/v1/vc/confs/{conf_id}/monitors
获取监控信息GET/api/v1/vc/confs/{conf_id}/monitors/{dst_ip}/{dst_port}
开启监控POST/api/v1/vc/confs/{conf_id}/monitors
取消监控DELETE/api/v1/vc/confs/{conf_id}/monitors/{dst_ip}/{dst_port}
监控心跳保活POST/api/v1/vc/confs/{conf_id}/monitors_heartbeat
监控请求关键帧POST/api/v1/vc/confs/{conf_id}/neediframe/monitors
获取终端选看列表GET/api/v1/vc/confs/{conf_id}/inspections
开启终端选看POST/api/v1/vc/confs/{conf_id}/inspections
取消终端选看DELETE/api/v1/vc/confs/{conf_id}/inspections/{mt_id}/{mode}
获取终端通道选看列表GET/api/v1/vc/confs/{conf_id}/inspection_channels
开启终端单通道选看POST/api/v1/vc/confs/{conf_id}/inspection_channels
取消终端单通道选看DELETE/api/v1/vc/confs/{conf_id}/inspection_channels/{mt_id}/{mode}/{mt_chn_idx}
修改终端呼叫模式PUT/api/v1/vc/confs/{conf_id}/mts/{mt_id}/call_mode
终端静音操作PUT/api/v1/vc/confs/{conf_id}/mts/{mt_id}/silence
终端哑音操作PUT/api/v1/vc/confs/{conf_id}/mts/{mt_id}/mute
修改终端音量PUT/api/v1/vc/confs/{conf_id}/mts/{mt_id}/volume
终端摄像头控制POST/api/v1/vc/confs/{conf_id}/mts/{mt_id}/camera
获取终端视频源信息GET/api/v1/vc/confs/{conf_id}/mts/{mt_id}/videos
设置终端当前视频源PUT/api/v1/vc/confs/{conf_id}/mts/{mt_id}/videos
设置VIP列表PUT/api/v1/vc/confs/{conf_id}/viplist
获取VIP列表GET/api/v1/vc/confs/{conf_id}/viplist
获取用户域的vrs地址列表GET/api/v1/vc/vrs
获取会控API版本信息GET/api/vc/version
设置双流模式PUT/api/v1/vc/confs/{conf_id}/dualmode

网管系统#

接口名称接口方法接口URL
请求所有域信息GET/api/v1/nms/domains
请求指定平台域下的物理服务器设备列表GET/api/v1/nms/platform_domains/{domain_moid}/physicals
请求物理服务器上的逻辑服务器设备列表GET/api/v1/nms/physicals/{p_server_moid}/logicals
请求指定平台域下的逻辑服务器设备列表GET/api/v1/nms/platform_domains/{domain_moid}/logicals
请求指定用户域的终端设备列表GET/api/v1/nms/user_domains/{domain_moid}/terminals
请求指定物理服务器的详细信息GET/api/v1/nms/physicals/{p_server_moid}/detail
请求指定媒体资源服务器上报的端口资源信息GET/api/v1/nms/mediaresources/{mediaresource_moid}/portinfo
请求非受管终端设备列表GET/api/v1/nms/old_terminals
获取网管API版本信息GET/api/nms/version
请求终端在线统计数据GET/api/v1/nms/service_domains/{domain_moid}/terminal_online_statistic
请求平台域端口资源统计信息GET/api/v1/nms/platform_domains/{domain_moid}/mediaresources
请求服务器未修复告警信息GET/api/v1/nms/servers/{server_moid}/unrepaired_warnings
请求终端未修复告警信息GET/api/v1/nms/terminals/{terminal_moid}/unrepaired_warnings
请求服务域正在召开的会议信息GET/api/v1/nms/service_domains/{service_moid}/meetings
请求会议终端信息详情GET/api/v1/nms/meetings/{conf_id}/terminal_detail

账号管理#

接口名称接口方法接口URL
创建部门POST/api/v1/amc/departments
编辑部门PUT/api/v1/amc/departments/{department_moid}
删除部门DELETE/api/v1/amc/departments/{department_moid}
查询部门信息GET/api/v1/amc/departments
查询单个部门的用户信息GET/api/v1/amc/departments/{department_moid}/accounts
创建账号POST/api/v1/amc/accounts
编辑账号PUT/api/v1/amc/accounts/{account_moid}
删除账号DELETE/api/v1/amc/accounts/{account_moid}
查询账号信息GET/api/v1/amc/accounts/{account_moid}
查询所有账号信息GET/api/v1/amc/accounts
停用账号PUT/api/v1/amc/accounts/{account_moid}/disable
重置密码PUT/api/v1/amc/accounts/{account_moid}/password
查询会议审批信息GET/api/v1/amc/approval_infos
启用停用会议审批功能PUT/api/v1/amc/approval_infos
获取集团顶级公共群组列表GET/api/v1/amc/public_groups
获取指定公共群组组织架构信息GET/api/v1/amc/public_groups/{public_group_moid}
获取指定集团公共群组所有人员信息GET/api/v1/amc/public_groups/{public_group_moid}/users
获取账号API版本信息GET/api/amc/version

录播系统#

接口名称接口方法接口URL
本地用户登录POST/api/v2/vrs/login
获取文件夹列表GET/api/v2/vrs/program_folder
添加文件夹POST/api/v2/vrs/program_folder
修改文件夹PUT/api/v2/vrs/program_folder/{id}
删除文件夹DELETE/api/v2/vrs/program_folder/{id}
获取节目列表GET/api/v2/vrs/program
批量删除节目DELETE/api/v2/vrs/program
批量发布节目PUT/api/v2/vrs/program_release_batch
节目批量移动PUT/api/v2/vrs/program_to_folder
获取直播室列表GET/api/v2/vrs/liveroom
获取预约直播室列表GET/api/v2/vrs/resroom
获取录像室列表GET/api/v2/vrs/recroom
添加录像室POST/api/v2/vrs/recroom
删除录像室DELETE/api/v2/vrs/recroom/{id}
修改录像室PUT/api/v2/vrs/recroom/{id}
录像室开始录像PUT/api/v2/vrs/recroom/{id}/startrec
录像室停止录像PUT/api/v2/vrs/recroom/{id}/stoprec
录像室暂停录像PUT/api/v2/vrs/recroom/{id}/pauserec
录像室恢复录像PUT/api/v2/vrs/recroom/{id}/resumerec
录像室开始直播PUT/api/v2/vrs/recroom/{id}/startlive
录像室停止直播PUT/api/v2/vrs/recroom/{id}/stoplive
获取放像室列表GET/api/v2/vrs/playroom
添加放像室POST/api/v2/vrs/playroom
删除放像室DELETE/api/v2/vrs/playroom/{id}
修改放像室PUT/api/v2/vrs/playroom/{id}
放像室开始放像PUT/api/v2/vrs/playroom/{id}/startplay
放像室停止放像PUT/api/v2/vrs/playroom/{id}/stopplay
放像室暂停放像PUT/api/v2/vrs/playroom/{id}/pauseplay
放像室恢复放像PUT/api/v2/vrs/playroom/{id}/resumeplay
获取转码任务信息GET/api/v2/vrs/transtask
批量添加转码任务POST/api/v2/vrs/transtask
批量操作转码任务PUT/api/v2/vrs/transtask
获取VRS的IP组GET/api/v2/vrs/vrsip
获取VRS API版本信息GET/api/vrs/version

统一出席#

接口名称接口方法接口URL
获取终端列表GET/api/v1/upu/mts