Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Saving a Continuous Presence Layout

Updated on 2023-12-22 GMT+08:00

View PDF

Saving a Continuous Presence Layout

Description

This API is used to save a continuous presence layout. The continuous presence layout saved in a meeting can be used only in the meeting. After the meeting ends, the saved continuous presence layout is released.

Debugging

You can debug this API in API Explorer.

URI

PUT /v1/mmc/control/conferences/layOut

**Table 1** Query parameter
Parameter	Mandatory	Type	Description
conferenceID	Yes	String	Meeting ID.

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Conference-Authorization	Yes	String	Meeting control token, which can be obtained by calling the API for Obtaining a Meeting Control Token.

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
restPicLayout	No	RestPicLayout object	Information about the continuous presence layout.

**Table 4** RestPicLayout
Parameter	Mandatory	Type	Description
switchTime	No	Integer	Interval for displaying participants in turn, in seconds. Minimum value: 10
picNum	No	Integer	Number of screens in the continuous presence. Minimum value: 1
layOutName	No	String	Name of the continuous presence layout.
imageType	No	String	Layout type.
uuid	No	String	Layout UUID.
subscriberInPics	No	Array of PicInfoNotify objects	Screen list.

**Table 5** PicInfoNotify
Parameter	Mandatory	Type	Description
index	No	Integer	Number of each screen in continuous presence. The number starts from 1.
id	No	Array of strings	SIP numbers of the participants in each screen. The SIP numbers can be obtained by calling the API for Querying the Corporate Directory.
share	No	Integer	Whether a stream is a presentation. 0: no. 1: yes.

Response Parameters

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

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
    } ]
  }
}

Example Response

Status code: 400

Invalid parameters.

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

Status Codes

Status Code	Description
200	Operation successful.
400	Invalid parameters.

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Parent topic: APIs

Previous topic: Querying a Continuous Presence Layout

Next topic: Deleting a Continuous Presence Layout