文档首页/ 华为云会议 Meeting/ 服务端API参考/ 会议控制/ 接口参考/ 查询多画面布局
更新时间：2023-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询多画面布局

功能介绍

该接口用于查询当前会议已保存的多画面布局。

调试

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

URI

GET /v1/mmc/control/conferences/layOut

表1 Query参数

参数

是否必选

参数类型

描述

conferenceID

是

String

会议ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Conference-Authorization

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

returnCode

Integer

结果码。

  • 0：成功

  • 非0：失败

最小值：0

最大值：2147483647

returnDesc

String

结果描述。

  • Success：成功

  • 其他：失败原因

picLayouts

Array of RestPicLayout objects

多画面布局。
表4 RestPicLayout

参数

参数类型

描述

switchTime

Integer

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

最小值：10

picNum

Integer

多画面画面数量。

最小值：1

layOutName

String

多画面布局名称。

imageType

String

画面类型。

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

响应示例

状态码： 200

操作成功。

{
  "returnCode" : 0,
  "returnDesc" : "Success",
  "picLayouts" : [ {
    "uuid" : "aa3aaaf349f511edbea72fd2b9a0ad61",
    "imageType" : "Two",
    "switchTime" : 10,
    "layOutName" : "my_saved_layout",
    "subscriberInPics" : [ {
      "index" : 1,
      "id" : [ "+99111221231895886#Desktop" ],
      "share" : 0
    }, {
      "index" : 2,
      "id" : [ "+99111221231894887#Desktop" ],
      "share" : 0
    } ]
  } ]
}

状态码： 400

参数异常。

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

状态码

状态码

描述

200

操作成功。

400

参数异常。

错误码

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

父主题： 接口参考

相关文档