会议录制与直播

获取录制配置

POST /server/v1/mcu/record-config 鉴权：需要（见概览）全局默认录像配置信息 请求参数 无 响应参数

string

应用ID

string

布局类型 auto,full,grids_2,grids_4,…

integer

水印类型 1无,2单排,3多排

string

窗口标签位置字母或组合:L左,R右,T上,B下,空表示不启用标签

integer

配置创建时间(时间戳)

integer

配置更新时间(时间戳)

响应示例：

{
  "code": 0,
  "data": {
    "app_id": "",
    "created_at": 0,
    "layout": "",
    "updated_at": 0,
    "watermark_type": 0,
    "window_tag_type": ""
  }
}

保存录制配置

POST /server/v1/mcu/save-record-config 鉴权：需要（见概览）全局默认录像配置更新 请求参数

string

布局类型 auto,full,grids_2,grids_4,…

integer

水印类型 1无,2单排,3多排

string

窗口标签位置字母或组合:L左,R右,T上,B下,空表示不启用标签

请求示例：

{
  "layout": "",
  "watermark_type": 0,
  "window_tag_type": ""
}

响应参数 data 为 null 响应示例：

{
  "code": 0,
  "data": null
}

录像列表

POST /server/v1/mcu/list-record 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

integer

开始时间

integer

结束时间

array<string>

附加筛选条件，格式字段:操作符:值（如 title:like:周会）；room_no/meeting_id 已自动转成条件，不用重复传

string

排序字段，逗号分隔，前缀 - 表示倒序，如 -created_at

integer

页数，从1开始示例：1

integer

每页数据量示例：10

请求示例：

{
  "begin_at": 0,
  "end_at": 0,
  "meeting_id": "",
  "page": 1,
  "per-page": 10,
  "room_no": "",
  "search": [
    ""
  ],
  "sort": ""
}

响应参数

string

任务ID

string

任务发起人ID

string

任务发起人名

string

频道

string

频道标题

string

外部会议号

integer

0待开始 1进行中 2待结束 3异常结束 4正常结束

string

错误描述

string

录像文件key

integer

录像大小(字节)

string

转码文件key

integer

转码大小(字节)

integer

MCU开始时间

integer

Mcu时长(秒)

string

录像标签逗号隔开

integer

任务创建时间(时间戳)

integer

任务更新时间(时间戳)

integer

当前时间, 用于前端本地时间不准时辅助计算录制时长

响应示例：

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "channel": "",
      "created_at": 0,
      "err_desc": "",
      "mcu_at": 0,
      "mcu_dur": 0,
      "mp4_key": "",
      "mp4_size": 0,
      "now": 0,
      "op_name": "",
      "op_uid": "",
      "room_no": "",
      "tags": "",
      "task_id": "",
      "task_status": 0,
      "title": "",
      "updated_at": 0,
      "vod_key": "",
      "vod_size": 0
    }
  ]
}

单个录像的点播地址

POST /server/v1/mcu/vod-url 鉴权：需要（见概览）获取录像地址(单个) 请求参数

string

任务ID

string

频道(无TaskId时必填)

boolean

是否局域网

请求示例：

{
  "is_lan": false,
  "meeting_id": "",
  "task_id": ""
}

响应参数

string

键为动态值，见上方说明

响应示例：

{
  "code": 0,
  "data": {}
}

一场会议全部录像的点播地址

POST /server/v1/mcu/vods-url 鉴权：需要（见概览）获取录像地址(多个) 请求参数

string

会议ID(无RoomNo时必填)

string

房间号

string

类型, 可选值: "", “mp4”

boolean

是否局域网

请求示例：

{
  "is_lan": false,
  "meeting_id": "",
  "room_no": "",
  "type": ""
}

响应参数

string

录像地址

integer

录像大小(字节)

integer

MCU开始时间

integer

Mcu时长(秒)

响应示例：

{
  "code": 0,
  "data": [
    {
      "mcu_at": 0,
      "mcu_dur": 0,
      "size": 0,
      "url": ""
    }
  ]
}

直播流地址

POST /server/v1/mcu/live-url 鉴权：需要（见概览）获取直播地址 请求参数

string

房间号

string

会议ID

请求示例：

{
  "meeting_id": "",
  "room_no": ""
}

响应参数

string

RTMP 拉流地址

string

HTTP-FLV 拉流地址

string

HLS 拉流地址

响应示例：

{
  "code": 0,
  "data": {
    "flv": "",
    "hls": "",
    "rtmp": ""
  }
}

删除录像

POST /server/v1/mcu/del-record 鉴权：需要（见概览） 请求参数

string

必填

任务ID

请求示例：

{
  "task_id": ""
}

响应参数 data 为 null 响应示例：

{
  "code": 0,
  "data": null
}

开始 / 更新录制任务

POST /server/v1/mcu/start 鉴权：需要（见概览）开始录制任务 请求参数

string

房间号

string

会议ID

integer

必填

任务类型，按位组合：1录像、2合流、4录音、8直播流；如 3 表示录像+合流，9 表示录像+直播示例：9

string

录制任务标题

string

任务发起人ID

string

任务发起人名称

string

录像标签,逗号分隔

object

必填

布局数据

显示字段

string

必填

布局类型

object

水印

显示字段

integer

类型 0默认, 1无, 2单排, 3多排

string

指定内容, 空表示自动(会议标题)

integer

字体大小, 0表示默认值

string

字体颜色, 空表示默认值

string

轮廓颜色, 空表示默认值

integer

轮廓线宽, 0表示默认值

string

会中无人时显示的文本, 空表示无人时停止录制

object

默认标签

显示字段

string

类型, 字母或组合: L左, R右, T上, B下

string

指定内容, 空表示自动(会中名称)

integer

字体大小, 0表示默认

string

字体颜色, 空表示默认

string

背景颜色, 空表示默认

integer

轮询时长(秒) 0不轮询

array<object>

逻辑块列表

显示元素字段

array<object>

宫格列表, 空表示剩余格子共用此处的用户

array<string>

用户ID列表, 空表示大轮询在线剩余用户, 多个表示小轮询

请求示例：

{
  "layout_data": {
    "div_list": [
      {
        "cells": [
          {
            "bind_share": false,
            "idx": 0,
            "tag": {
              "bg_color": "",
              "color": "",
              "size": 0,
              "text": "",
              "type": ""
            }
          }
        ],
        "uids": [
          ""
        ]
      }
    ],
    "layout": "",
    "nobody_text": "",
    "polling_dur": 0,
    "tag": {
      "bg_color": "",
      "color": "",
      "size": 0,
      "text": "",
      "type": ""
    },
    "watermark": {
      "color": "",
      "ol_color": "",
      "ol_width": 0,
      "size": 0,
      "text": "",
      "type": 0
    }
  },
  "meeting_id": "",
  "op_name": "",
  "op_uid": "",
  "room_no": "",
  "tags": "",
  "task_type": 9,
  "title": ""
}

响应参数

string

键为动态值，见上方说明

响应示例：

{
  "code": 0,
  "data": {}
}

结束录制任务

POST /server/v1/mcu/stop 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

integer

任务类型(选填)。不传表示停掉该会议所有类型的任务；传了则只停指定类型，取值同启动接口示例：1

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "task_type": 1
}

响应参数 data 为 null 响应示例：

{
  "code": 0,
  "data": null
}

概览

带 UI 极简对接

iOS SDK

Android SDK

Windows SDK

Web SDK

微信小程序 SDK

服务端 API

获取录制配置

保存录制配置

录像列表

单个录像的点播地址

一场会议全部录像的点播地址

直播流地址

删除录像

开始 / 更新录制任务

结束录制任务

​获取录制配置

​保存录制配置

​录像列表

​单个录像的点播地址

​一场会议全部录像的点播地址

​直播流地址

​删除录像

​开始 / 更新录制任务

​结束录制任务

获取录制配置

保存录制配置

录像列表

单个录像的点播地址

一场会议全部录像的点播地址

直播流地址

删除录像

开始 / 更新录制任务

结束录制任务