更新时间:2026-02-04 GMT+08:00

保存多画面布局 - SaveLayout

功能介绍

该接口用于保存多画面布局。保存的多画面布局,只能在当前会议使用,会议结束后,保存的多画面布局就会释放。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v1/mmc/control/conferences/layOut

表1 Query参数

参数

是否必选

参数类型

描述

conferenceID

String

会议ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Conference-Authorization

String

会控Token,通过获取会控token接口获得。

表3 请求Body参数

参数

是否必选

参数类型

描述

restPicLayout

RestPicLayout object

会议多画面布局信息。

表4 RestPicLayout

参数

是否必选

参数类型

描述

switchTime

Integer

多画面轮询时间,单位秒。

最小值:10

picNum

Integer

多画面画面数量。

最小值:1

layOutName

String

多画面布局名称。

imageType

String

画面类型。

  • SINGLE:一画面
  • TWO:二画面
  • THREE:三画面
  • FOUR:四画面
  • FIVE:五画面
  • SIX:六画面
  • SEVEN:七画面
  • EIGHT:八画面
  • NINE:九画面
  • TEN:十画面
  • THIRTEEN:十三画面
  • SIXTEEN:十六画面
  • TWENTY_FIVE:二十五画面

uuid

String

布局UUID。

subscriberInPics

Array of PicInfoNotify objects

子画面列表。

表5 PicInfoNotify

参数

是否必选

参数类型

描述

index

Integer

多画面中每个画面的编号,编号从1开始。

id

Array of strings

每个画面中的与会者SIP号码。SIP号码可以通过查询企业通讯获取。

share

Integer

是否为辅流。

  • 0: 不是辅流

  • 1: 是辅流

响应参数

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误码描述。

请求示例

PUT https://{endpoint}/v1/mmc/control/conferences/layOut?conferenceID=914370850

{
  "restPicLayout" : {
    "imageType" : "Two",
    "switchTime" : 10,
    "layOutName" : "my_saved_layout",
    "subscriberInPics" : [ {
      "index" : 1,
      "id" : [ "+99111221231895886" ],
      "share" : 0
    }, {
      "index" : 2,
      "id" : [ "+99111221231894887" ],
      "share" : 0
    } ]
  }
}

响应示例

状态码: 400

参数异常。

{
  "error_code" : "MMC.111072065",
  "error_msg" : "CONF_NOT_FOUND_OR_AUTH_FAILED"
}

状态码

状态码

描述

200

操作成功。

400

参数异常。

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心