Help Center/ Meeting/ Server API Reference/ Meeting Management/ APIs/ Modifying a Recurring Meeting
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF

Modifying a Recurring Meeting

Description

This API is used to modify a scheduled recurring meeting. After a meeting starts, it cannot be modified.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/mmc/management/conferences/cyclesubconf

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

conferenceID

Yes

String

Query

Meeting ID.

userUUID

No

String

Query

UUID of a user.

NOTE:

This parameter will be discarded. Do not use it.

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

X-Authorization-Type

No

String

Header

Whether the request is sent from a third-party portal.

NOTE:

This parameter will be discarded. Do not use it.

X-Site-Id

No

String

Header

ID of the HCS Online site where the authentication is performed.

NOTE:

This parameter will be discarded. Do not use it.

cycleSubConfID

Yes

string

Body

UUID of a recurring meeting.

mediaTypes

Yes

string

Body

Media type of the meeting.

  • Voice: voice meeting.
  • HDVideo: video meeting.

startTime

Yes

string

Body

UTC time when the meeting starts. Format: yyyy-MM-dd HH:mm.

NOTE:
  • If the start time is not specified or the value is null, the meeting starts immediately.
  • The time is the UTC±00:00 time.

length

Yes

Integer

Body

Meeting duration, in minutes. The default value is 30 minutes.

The maximum value is 1440 minutes (24 hours) and the minimum value is 15 minutes.

isAutoRecord

No

Integer

Body

Whether to automatically start recording for the meeting. This parameter is valid only when recordType is set to 2 or 3. Default value: 0.

  • 1: The recording is automatically started.
  • 0: The recording is not automatically started.

confConfigInfo

No

ConfConfigInfo object

Body

Other meeting settings.

recordAuthType

No

Integer

Body

Recording playback authentication mode. This parameter is valid only when recordType is set to 2 or 3.

  • 0: Users who obtain the link of the recording can watch or download the recording.
  • 1: Only enterprise users can watch or download the recording.
  • 2: Only meeting participants can view and download the recording.

description

No

string

Body

Meeting description, which contains up to 200 characters.
Table 3 ConfConfigInfo data structure

Parameter

Mandatory

Type

Location

Description

callInRestriction

No

Integer

Body

Users who are allowed to join the meeting.

  • 0: everyone.
  • 2: enterprise users.
  • 3: invited users.

audienceCallInRestriction

No

Integer

Body

Users allowed to join the webinar as attendees.

  • 0: everyone.
  • 2: enterprise users and invited users.

allowGuestStartConf

No

Boolean

Body

Whether guests can start the meeting.

  • true: Guests can start the meeting.
  • false: Guests cannot start the meeting.
NOTE:

This parameter is valid only for meetings with random IDs.

enableWaitingRoom

No

Boolean

Body

Whether the waiting room is enabled.

showAudienceCountInfo

No

ShowAudienceCountInfo object

Body

Rule of displaying the number of webinar attendees.
Table 4 ShowAudienceCountInfo data structure

Parameter

Mandatory

Type

Location

Description

showAudienceMode

No

Integer

Body

Rule of displaying the number of attendees. The server calculates and delivers the number of attendees to clients.

  • 0: not displayed.
  • 1 The number of attendees is displayed after multiplication. You can set the multiplication based on the number of attendees in real time or the accumulated number of attendees (for example, N). You can configure a multiplier (X) and attendee quantity base (Y). Number of attendees displayed = N x X + Y.

baseAudienceCount

No

Integer

Body

Attendee quantity base. The value ranges from 0 to 10,000.

multiple

No

Double

Body

Multiplier. The value ranges from 1 to 10. The value can be accurate to one decimal place.

Status Codes

Table 5 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/management/conferences/cyclesubconf?conferenceID=985325849
Connection: keep-alive
X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN
Content-Type: application/json
user-agent: WeLink-desktop
Content-Length: 372
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "cycleSubConfID": "393439b00a2e11ecbe71d7c576a87729",
    "mediaTypes": "Video",
    "startTime": "2021-09-01 07:36",
    "length": 45,
    "description": ""
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 2164
Connection: keep-alive
http_proxy_id: 462abfcfa8a41c2c5450eb7648bf5ad2
Server: api-gateway
X-Request-Id: 7ba6f742610c03a64262b126fb336a5d

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-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"cycleSubConfID": "393439b00a2e11ecbe71d7c576a87729","mediaTypes": "Video","startTime": "2021-09-01 07:36","length": 45,"description": ""}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/cyclesubconf?conferenceID=985325849'
Parent topic: APIs