Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Querying a Continuous Presence Layout
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF

Querying a Continuous Presence Layout

Description

This API is used to query a continuous presence layout saved in a meeting.

Debugging

You can debug this API in API Explorer.

URI

GET /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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

returnCode

Integer

Result code.

  • 0: successful.

  • Other values: failed.

Minimum value: 0

Maximum value: 2147483647

returnDesc

String

Result description.

  • Success: The operation succeeds.

  • Other values: failure cause.

picLayouts

Array of RestPicLayout objects

Continuous presence layout.
Table 4 RestPicLayout

Parameter

Type

Description

switchTime

Integer

Interval for displaying participants in turn, in seconds.

Minimum value: 10

picNum

Integer

Number of screens in the continuous presence.

Minimum value: 1

layOutName

String

Name of the continuous presence layout.

imageType

String

Layout type.

uuid

String

Layout UUID.

subscriberInPics

Array of PicInfoNotify objects

Screen list.
Table 5 PicInfoNotify

Parameter

Type

Description

index

Integer

Number of each screen in continuous presence. The number starts from 1.

id

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

Integer

Whether a stream is a presentation.

  • 0: no.

  • 1: yes.

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

Example Response

Status code: 200

Operation successful.

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

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