Help Center/ Meeting/ Server API Reference/ Meeting Management/ APIs/ Modifying a Recurring Meeting Series

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

Online Debugging

CLI Examples

View PDF

Modifying a Recurring Meeting Series

Description

This API is used to modify a scheduled recurring meeting series. 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/cycleconferences
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.
startTime	No	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	No	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.
subject	No	String	Body	Meeting topic. The value can contain up to 128 characters.
mediaTypes	Yes	String	Body	Media type of the meeting. Voice: voice meeting. HDVideo: video meeting.
groupuri	No	String	Body	Temporary group ID used when an instant meeting is created on the client. This parameter is carried in the conference-info header or when other participants are invited. The value can contain up to 31 characters.
attendees	No	Array of Attendee objects	Body	Participant list.
cycleParams	No	CycleParams object	Body	Recurring meeting parameter list, which is mandatory for a recurring meeting series.
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.
encryptMode	No	Integer	Body	Meeting media encryption mode. The default value is defined in the enterprise-level configuration. 0: adaptive encryption. 1: forced encryption. 2: not encrypted.
language	No	String	Body	Language of meeting SMS or email notifications. The default language is Chinese. zh-CN: Chinese. en-US: English.
timeZoneID	No	String	Body	Meeting time zone in meeting notifications. For details, see Time zone mapping. NOTE: For example, if timeZoneID is set to 26, the time in the meeting notification sent by Huawei Cloud Meeting is Tue, Nov 11, 2021 00:00 - 02:00 (GMT) Greenwich Mean Time:Dublin, Edinburgh, Lisbon, London. If the notification of a non-recurring meeting is sent by a third-party system, leave this parameter blank.
recordType	No	Integer	Body	Recording type. Default value: 0. 0: no recording. 1: live broadcast. 2: recording. 3: live broadcast and recording.
liveAddress	No	String	Body	Live streaming URL of the video. This parameter is valid when the recording type is live broadcast or live broadcast + recording. The value can contain up to 255 characters.
auxAddress	No	String	Body	Live streaming URL of the presentation. This parameter is valid when the recording type is live broadcast or live broadcast + recording. The value can contain up to 255 characters.
recordAuxStream	No	Integer	Body	Whether to record the presentation. This parameter is valid only when recordType is set to 2 or 3. By default, only the video is recorded, and the presentation is not recorded. 0: Do not record the presentation. 1: Record the presentation.
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.
vmrFlag	No	Integer	Body	Whether to use a cloud meeting room or personal meeting ID to hold the scheduled meeting. Default value: 0. 0: Do not use a cloud meeting room or personal meeting ID. 1: Use a cloud meeting room or personal meeting ID. NOTE: vmrFlag cannot be modified.
vmrID	No	String	Body	ID of the cloud meeting room bound to the account that creates the meeting. Obtain the value by calling the API for Querying Cloud Meeting Rooms by Page and the Personal Meeting ID as a Common User. NOTE: vmrID cannot be modified.
concurrentParticipants	No	Integer	Body	Maximum number of participants in the meeting. Default value: 0. 0: unlimited. > 0
supportSimultaneousInterpretation	No	Boolean	Body	Whether simultaneous interpretation is supported. true: supported. false: not supported.

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

**Table 4** Response parameters
Parameter	Type	Description
[Array element]	Array of ConferenceInfo	Meeting information list.

Example Request

PUT /v1/mmc/management/cycleconferences?conferenceID=914087436
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)

{
    "mediaTypes": "HDVideo",
    "cycleParams": {
        "startDate": "2021-09-01",
        "endDate": "2021-09-02",
        "cycle": "Day",
        "preRemindDays": 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: 2164
Connection: keep-alive
http_proxy_id: 462abfcfa8a41c2c5450eb7648bf5ad2
Server: api-gateway
X-Request-Id: 7ba6f742610c03a64262b126fb336a5d

[
    {
        "conferenceID": "986256843",
        "mediaTypes": "HDVideo,Data,Voice",
        "subject": "Conference Topic",
        "size": 0,
        "timeZoneID": "56",
        "startTime": "2021-09-01 08:46",
        "endTime": "2021-09-01 09:16",
        "conferenceState": "Schedule",
        "accessNumber": "+86571150",
        "language": "zh-CN",
        "passwordEntry": [
            {
                "conferenceRole": "chair",
                "password": "******"
            },
            {
                "conferenceRole": "general",
                "password": "******"
            }
        ],
        "userUUID": "fe235be7aa6045b98a33f27b365cbca9",
        "scheduserName": "Suzhou Branch",
        "multiStreamFlag": 1,
        "conferenceType": 2,
        "confType": "CYCLE",
        "cycleParams": {
            "startDate": "2021-09-01",
            "cycle": "Day",
            "endDate": "2021-09-02",
            "cycleCount": 0,
            "interval": 1,
            "preRemindDays": 1
        },
        "isAutoMute": 0,
        "isHardTerminalAutoMute": 0,
        "isSoftTerminalAutoMute": 0,
        "isAutoRecord": 0,
        "chairJoinUri": "https://100.95.188.184:443/#/j/986256843/fa4def332cb83f5b1ec74c64d0658a8570f45ad3e8d0df8c",
        "guestJoinUri": "https://100.95.188.184:443/#/j/986256843/53f55ec44263d666e8ed70594624aa10497c631a91d3b8c1",
        "recordType": 0,
        "recordAuxStream": 0,
        "recordAuthType": 2,
        "confConfigInfo": {
            "inviteMode": "AUTO_INVITE",
            "prolongLength": 15,
            "isGuestFreePwd": false,
            "isSendNotify": true,
            "isSendSms": true,
            "isSendCalendar": true,
            "isAutoMute": false,
            "isHardTerminalAutoMute": false,
            "callInRestriction": 0,
            "audienceCallInRestriction": 0,
            "allowGuestStartConf": true,
            "enableWaitingRoom": false
        },
        "vmrFlag": 0,
        "scheduleVmr": false,
        "isHasRecordFile": false,
        "terminlCount": 0,
        "normalCount": 0,
        "deptName": "corpzxytest111",
        "confMode": "RTC",
        "webinar": false,
        "concurrentParticipants": 0,
        "subConfs": [
            {
                "cycleSubConfID": "ff1cf7020a3711ecbe71e167f3b9d5b1",
                "conferenceID": "986256843",
                "startTime": "2021-09-01 08:46",
                "endTime": "2021-09-01 09:16",
                "mediaType": "HDVideo,Data,Voice",
                "isAutoRecord": 0,
                "recordAuthType": 2,
                "confConfigInfo": {
                    "callInRestriction": 0,
                    "audienceCallInRestriction": 0,
                    "allowGuestStartConf": true,
                    "enableWaitingRoom": false
                }
            },
            {
                "cycleSubConfID": "ff1cf7030a3711ecbe7183f6162d654d",
                "conferenceID": "986256843",
                "startTime": "2021-09-02 08:46",
                "endTime": "2021-09-02 09:16",
                "mediaType": "HDVideo,Data,Voice",
                "isAutoRecord": 0,
                "recordAuthType": 2,
                "confConfigInfo": {
                    "callInRestriction": 0,
                    "audienceCallInRestriction": 0,
                    "allowGuestStartConf": true,
                    "enableWaitingRoom": false
                }
            }
        ]
    }
]

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 '{"mediaTypes": "HDVideo","cycleParams": {"startDate": "2021-09-01","endDate": "2021-09-02","cycle": "Day","preRemindDays": 1}}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/cycleconferences?conferenceID=986256843'

Parent topic: APIs

Previous topic: Canceling a Recurring Meeting

Next topic: Modifying a Recurring Meeting