Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Inviting a Participant to Share a Screen
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Inviting a Participant to Share a Screen

Description

This API is used to invite a participant to share the desktop or cancel the invitation.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/mmc/control/conferences/participants/share/invite

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

conferenceID

Yes

String

Query

Meeting ID.

participantID

Yes

String

Query

ID of the invited participant.

X-Conference-Authorization

Yes

String

Header

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

share

Yes

Integer

Body

Invitation flag.

  • 0: Cancel invitation.
  • 1: Invite the participant to share a screen.

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.

Example Request

PUT /v1/mmc/control/conferences/participants/share/invite?conferenceID=986947855&participantID=4a5rg64ag5p8pvvnam1rr6m8lqra6a61
Connection: keep-alive
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)
x-conference-authorization: Basic Y25yYjQyNmNhMzgyMWY4YTE4ZTc4ZDU5ZGE1NzJhNDIxNjQ0YzUyZGZkOWE0NzMwMjk4
{
    "share":1
}

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 -d '{"share": 1}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/share/invite
?conferenceID=986947855&participantID=4a5rg64ag5p8pvvnam1rr6m8lqra6a61
Parent topic: APIs