Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Viewing Participants as the Host
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Viewing Participants as the Host

Description

This API is used by the host to view multiple participants in turn, view continuous presence, or focus on one participant. This API can be called only when the host uses a professional meeting terminal (such as TE series).

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/mmc/control/conferences/chairView

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

conferenceID

Yes

String

Query

Meeting ID.

X-Conference-Authorization

Yes

String

Header

Meeting control token, which can be obtained by calling the API for Obtaining a Meeting Control Token.

viewType

Yes

Integer

Body

Operation type.

  • 0: The host views participants in turn.
  • 1: The host views continuous presence.
  • 2: The host focuses on a participant.

participantID

No

String

Body

ID of the participant to view.

This parameter is mandatory when viewType is set to 2.

switchTime

No

Integer

Body

Interval for displaying participants in turn, in seconds. This parameter is mandatory when viewType is set to 0.

Value range: 10 to 120. Default value: 10.

status

No

Integer

Body

Starting or stopping displaying participants in turn. This parameter is mandatory when viewType is set to 0.

  • 0: Stop displaying participants in turn.
  • 1: Start displaying participants in turn.

Status Codes

Table 3 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

None

Example Request

PUT /v1/mmc/control/conferences/chairView?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
content-type: application/json
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
 "viewType":0
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 39
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 571b4dfceff545fae29aa14cea761079
Server: api-gateway
X-Request-Id: f78b007ec2dabf1498620131c7bc19e0

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.

Example cURL Command

curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"viewType":0,"switchTime":"30","status":1}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/chairView?conferenceID=914083136
Parent topic: APIs