会议录制与直播

获取录制配置

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-task 鉴权：需要（见概览）录像任务列表。一次录制 = 一个任务，任务下可能有多个录像文件（超过分片时长会滚动切段，中途中断续录也会另起一段）。要拿可播放的文件请用「录像任务详情」（内联全部文件与地址）或「录像文件列表」。 请求参数

string

房间号，空表示不限

string

会议ID，空表示不限

integer

任务状态，不传表示不限：0 待开始 1 进行中 2 待结束 3 异常结束 4 正常结束

string

录像标题，模糊匹配；空表示不限（最大长度 100）

string

标签，模糊匹配；空表示不限（最大长度 50）

integer

开始时间

integer

结束时间

integer

页数，从1开始示例：1

integer

每页数据量示例：10

请求示例：

{
  "begin_at": 0,
  "end_at": 0,
  "meeting_id": "",
  "page": 1,
  "per-page": 10,
  "room_no": "",
  "tag": "",
  "task_status": 0,
  "title": ""
}

响应参数

string

任务ID

string

任务发起人ID

string

任务发起人名

string

频道

string

频道标题

string

外部会议号

integer

任务类型 1录像 2合流 4录音 8直播流, 按位组合

integer

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

string

错误描述

integer

录制开始时间(时间戳), 0表示底层任务还没跑起来

integer

录制结束时间(时间戳), 0表示未结束

integer

录像文件数, 一次录制超过分片时长或中断续录都会多出文件

integer

全部录像文件的总时长(秒)

integer

全部录像文件的总字节

string

录像标签逗号隔开

array<object>

录像文件列表, 仅任务详情返回

显示元素字段

string

录像文件ID, 取播放地址时用

string

所属录像任务ID

string

频道

integer

分片序号, 从1开始, 按它排序即播放顺序

integer

录像大小(字节)

integer

本片时长(秒)

integer

本片开始时间(时间戳)

integer

本片结束时间(时间戳)

integer

相对任务开始的偏移(毫秒), 做多片连播的进度轴用

integer

分片原因 0未知 1按时长切段 2中断后续录(与上一片间有空洞)

string

预签名播放地址, 仅任务详情返回

integer

记录创建时间(时间戳)

integer

任务创建时间(时间戳)

integer

任务更新时间(时间戳)

integer

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

响应示例：

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "began_at": 0,
      "channel": "",
      "created_at": 0,
      "ended_at": 0,
      "err_desc": "",
      "now": 0,
      "op_name": "",
      "op_uid": "",
      "record_count": 0,
      "records": [
        {
          "addr": "",
          "began_at": 0,
          "channel": "",
          "created_at": 0,
          "duration": 0,
          "ended_at": 0,
          "offset_ms": 0,
          "reason": 0,
          "record_id": "",
          "seq": 0,
          "task_id": "",
          "vod_size": 0
        }
      ],
      "room_no": "",
      "tags": "",
      "task_id": "",
      "task_status": 0,
      "task_type": 0,
      "title": "",
      "total_duration": 0,
      "total_size": 0,
      "updated_at": 0
    }
  ]
}

录像任务详情

POST /server/v1/mcu/detail 鉴权：需要（见概览）录像任务详情：任务状态、起止时间、总时长，以及本次录制的全部录像文件（records 数组，含每个文件的播放地址、时长、起止时间与分片序号）。 请求参数

string

任务ID

string

会议ID(无TaskId时必填)

boolean

是否返回内网播放地址

请求示例：

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

响应参数

string

任务ID

string

任务发起人ID

string

任务发起人名

string

频道

string

频道标题

string

外部会议号

integer

任务类型 1录像 2合流 4录音 8直播流, 按位组合

integer

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

string

错误描述

integer

录制开始时间(时间戳), 0表示底层任务还没跑起来

integer

录制结束时间(时间戳), 0表示未结束

integer

录像文件数, 一次录制超过分片时长或中断续录都会多出文件

integer

全部录像文件的总时长(秒)

integer

全部录像文件的总字节

string

录像标签逗号隔开

array<object>

录像文件列表, 仅任务详情返回

显示元素字段

string

录像文件ID, 取播放地址时用

string

所属录像任务ID

string

频道

integer

分片序号, 从1开始, 按它排序即播放顺序

integer

录像大小(字节)

integer

本片时长(秒)

integer

本片开始时间(时间戳)

integer

本片结束时间(时间戳)

integer

相对任务开始的偏移(毫秒), 做多片连播的进度轴用

integer

分片原因 0未知 1按时长切段 2中断后续录(与上一片间有空洞)

string

预签名播放地址, 仅任务详情返回

integer

记录创建时间(时间戳)

integer

任务创建时间(时间戳)

integer

任务更新时间(时间戳)

integer

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

响应示例：

{
  "code": 0,
  "data": {
    "began_at": 0,
    "channel": "",
    "created_at": 0,
    "ended_at": 0,
    "err_desc": "",
    "now": 0,
    "op_name": "",
    "op_uid": "",
    "record_count": 0,
    "records": [
      {
        "addr": "",
        "began_at": 0,
        "channel": "",
        "created_at": 0,
        "duration": 0,
        "ended_at": 0,
        "offset_ms": 0,
        "reason": 0,
        "record_id": "",
        "seq": 0,
        "task_id": "",
        "vod_size": 0
      }
    ],
    "room_no": "",
    "tags": "",
    "task_id": "",
    "task_status": 0,
    "task_type": 0,
    "title": "",
    "total_duration": 0,
    "total_size": 0,
    "updated_at": 0
  }
}

录像文件列表

POST /server/v1/mcu/list-record 鉴权：需要（见概览）录像文件列表，一条就是一次录制产出的一个文件（分片）。按 seq 升序即播放顺序；offset_ms 是相对任务开始的偏移，做多片连播的进度轴用它； reason=2 表示这一片与上一片之间有时间空洞（录制曾中断后续录）。 请求参数

string

录像任务ID，只看某一次录制的文件时传；空表示不限

string

会议ID，空表示不限

integer

页数，从1开始示例：1

integer

每页数据量示例：10

请求示例：

{
  "meeting_id": "",
  "page": 1,
  "per-page": 10,
  "task_id": ""
}

响应参数

string

录像文件ID, 取播放地址时用

string

所属录像任务ID

string

频道

integer

分片序号, 从1开始, 按它排序即播放顺序

integer

录像大小(字节)

integer

本片时长(秒)

integer

本片开始时间(时间戳)

integer

本片结束时间(时间戳)

integer

相对任务开始的偏移(毫秒), 做多片连播的进度轴用

integer

分片原因 0未知 1按时长切段 2中断后续录(与上一片间有空洞)

string

预签名播放地址, 仅任务详情返回

integer

记录创建时间(时间戳)

响应示例：

{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "addr": "",
      "began_at": 0,
      "channel": "",
      "created_at": 0,
      "duration": 0,
      "ended_at": 0,
      "offset_ms": 0,
      "reason": 0,
      "record_id": "",
      "seq": 0,
      "task_id": "",
      "vod_size": 0
    }
  ]
}

单个录像文件的点播地址

POST /server/v1/mcu/vod-url 鉴权：需要（见概览）获取单个录像文件的播放地址。地址有有效期（2 小时），不要长期缓存 请求参数

string

必填

录像文件ID，取自任务详情或录像文件列表

boolean

是否局域网

请求示例：

{
  "is_lan": false,
  "record_id": ""
}

响应参数

string

录像地址

integer

录像大小(字节)

integer

本片开始时间(兼容字段, 同began_at)

integer

本片时长(秒)(兼容字段, 同duration)

string

录像文件ID, 单独取地址/删除时用

string

所属录像任务ID

integer

分片序号, 从1开始, 按它排序即播放顺序

integer

本片开始时间(时间戳)

integer

本片结束时间(时间戳)

integer

本片时长(秒)

integer

相对任务开始的偏移(毫秒), 做多片连播的进度轴用

integer

分片原因 0未知 1按时长切段 2中断后续录(与上一片间有空洞)

响应示例：

{
  "code": 0,
  "data": {
    "began_at": 0,
    "duration": 0,
    "ended_at": 0,
    "mcu_at": 0,
    "mcu_dur": 0,
    "offset_ms": 0,
    "reason": 0,
    "record_id": "",
    "seq": 0,
    "size": 0,
    "task_id": "",
    "url": ""
  }
}

批量获取录像文件点播地址

POST /server/v1/mcu/vod-url/batch 鉴权：需要（见概览）批量获取录像文件播放地址，一次最多 50 个，适合整场连播时一次性取全 请求参数

array<string>

必填

录像文件ID列表，单次最多 50 个（最大长度 50）

boolean

是否局域网

请求示例：

{
  "is_lan": false,
  "record_ids": [
    ""
  ]
}

响应参数

string

录像地址

integer

录像大小(字节)

integer

本片开始时间(兼容字段, 同began_at)

integer

本片时长(秒)(兼容字段, 同duration)

string

录像文件ID, 单独取地址/删除时用

string

所属录像任务ID

integer

分片序号, 从1开始, 按它排序即播放顺序

integer

本片开始时间(时间戳)

integer

本片结束时间(时间戳)

integer

本片时长(秒)

integer

相对任务开始的偏移(毫秒), 做多片连播的进度轴用

integer

分片原因 0未知 1按时长切段 2中断后续录(与上一片间有空洞)

响应示例：

{
  "code": 0,
  "data": [
    {
      "began_at": 0,
      "duration": 0,
      "ended_at": 0,
      "mcu_at": 0,
      "mcu_dur": 0,
      "offset_ms": 0,
      "reason": 0,
      "record_id": "",
      "seq": 0,
      "size": 0,
      "task_id": "",
      "url": ""
    }
  ]
}

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

POST /server/v1/mcu/vods-url 鉴权：需要（见概览）一场会议全部录像的点播地址。一次录制产出多个文件时会全部返回，按分片序号排序。 url/size/mcu_at/mcu_dur 是老字段，语义不变（mcu_at 为本片开始时间、mcu_dur 为本片时长）； record_id / seq / offset_ms 等新增字段用于精确定位与多片连播。 请求参数

string

会议ID(无RoomNo时必填)

string

房间号

boolean

是否局域网

请求示例：

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

响应参数

string

录像地址

integer

录像大小(字节)

integer

本片开始时间(兼容字段, 同began_at)

integer

本片时长(秒)(兼容字段, 同duration)

string

录像文件ID, 单独取地址/删除时用

string

所属录像任务ID

integer

分片序号, 从1开始, 按它排序即播放顺序

integer

本片开始时间(时间戳)

integer

本片结束时间(时间戳)

integer

本片时长(秒)

integer

相对任务开始的偏移(毫秒), 做多片连播的进度轴用

integer

分片原因 0未知 1按时长切段 2中断后续录(与上一片间有空洞)

响应示例：

{
  "code": 0,
  "data": [
    {
      "began_at": 0,
      "duration": 0,
      "ended_at": 0,
      "mcu_at": 0,
      "mcu_dur": 0,
      "offset_ms": 0,
      "reason": 0,
      "record_id": "",
      "seq": 0,
      "size": 0,
      "task_id": "",
      "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-task 鉴权：需要（见概览）删除录像任务，其下全部录像文件一并删除 请求参数

string

任务ID

string

会议ID(无TaskId时必填)

boolean

是否返回内网播放地址

请求示例：

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

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

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

删除单个录像文件

POST /server/v1/mcu/del-record 鉴权：需要（见概览）删除单个录像文件，同一次录制的其他文件不受影响 请求参数

string

必填

录像文件ID

请求示例：

{
  "record_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
}

概览

极简对接

Web SDK

Android SDK

Windows SDK

Swift SDK（iOS/macOS）

iOS SDK

HarmonyOS SDK

服务端 API

获取录制配置

保存录制配置

录像任务列表

录像任务详情

录像文件列表

单个录像文件的点播地址

批量获取录像文件点播地址

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

直播流地址

删除录像任务

删除单个录像文件

开始 / 更新录制任务

结束录制任务

​获取录制配置

​保存录制配置

​录像任务列表

​录像任务详情

​录像文件列表

​单个录像文件的点播地址

​批量获取录像文件点播地址

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

​直播流地址

​删除录像任务

​删除单个录像文件

​开始 / 更新录制任务

​结束录制任务

获取录制配置

保存录制配置

录像任务列表

录像任务详情

录像文件列表

单个录像文件的点播地址

批量获取录像文件点播地址

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

直播流地址

删除录像任务

删除单个录像文件

开始 / 更新录制任务

结束录制任务