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

Updated on 2024-01-19 GMT+08:00

Online Debugging

CLI Examples

View PDF

Creating a Recurring Meeting Series

Description

This API is used to schedule a recurring meeting series.

Debugging

You can debug this API in API Explorer.

Prototype

**Table 1** Prototype
Request Method	POST
Request Address	/v1/mmc/management/cycleconferences
Transport Protocol	HTTPS

Request Parameters

**Table 2** Parameters
Parameter	Mandatory	Type	Location	Description
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 you do not specify this parameter when scheduling a meeting, the meeting will start 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. startDate and endDate must match the time zone specified by timeZoneID.
recordType	No	Integer	Body	Recording type. Default value: 0. 0: disabled. 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.
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: Use the value of id returned by the preceding query API, not the value of vmrId. When creating a meeting using a personal meeting ID, set vmrMode to 0. When creating a meeting using a cloud meeting room, set vmrMode to 1.
concurrentParticipants	No	Integer	Body	Maximum number of participants in the meeting. 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.

**Table 5** Subconfs data structure
Parameter	Type	Description
cycleSubConfID	string	UUID of a recurring meeting.
conferenceID	string	Meeting ID.
mediaType	string	Media type of the meeting. Voice: voice. Video: SD video. HDVideo: HD video. Data: data.
startTime	string	Meeting start time (format: YYYY-MM-DD HH:MM).
endTime	string	Meeting end time (format: YYYY-MM-DD HH:MM).
isAutoRecord	Integer	Whether recording is enabled automatically. 0: no. 1: yes.
confConfigInfo	Confconfinginfo object	Other settings about the recurring meeting.
recordAuthType	Integer	Authentication mode for watching or downloading the recording. 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	string	Meeting description. The value can contain up to 200 characters.

**Table 6** Confconfiginfo data structure
Parameter	Type	Description
callInRestriction	Integer	Users who are allowed to join the meeting. 0: everyone. 2: enterprise users. 3: invited users.
audienceCallInRestriction	Integer	Users allowed to join the webinar as attendees. 0: everyone. 2: enterprise users and invited users.
allowGuestStartConf	Boolean	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	Boolean	Whether the waiting room is enabled.
showAudienceCountInfo	ShowAudienceCountInfo object	Rule of displaying the number of webinar attendees.

**Table 7** ShowAudienceCountInfo data structure
Parameter	Type	Description
showAudienceMode	Integer	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	Integer	Attendee quantity base. The value ranges from 0 to 10,000.
multiple	Double	Multiplier. The value ranges from 1 to 10. The value can be accurate to one decimal place.

Example Request

POST /v1/mmc/management/cycleconferences
Connection: keep-alive
X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN
Content-Type: application/json
user-agent: WeLink-desktop
Content-Length: 548
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
{
    "subject": "Regular Recurring Meeting",
    "mediaTypes": "Data,Voice,HDVideo",
    "startTime": "",
    "length": 120,
    "timeZoneID": "56",
    "vmrFlag": 1,
    "vmrID": "ff80808167ef1edf0167f339533f05a8",
    "cycleParams": {
        "startDate": "2021-08-31",
        "endDate": "2021-09-02",
        "cycle": "Day",
        "interval": 1,
        "preRemindDays": 1
    },
    "attendees": [
        {
            "userUUID": "ff80808167ef1edf0167f339533d05a6",
            "name": "Suzhou Branch",
            "email": "******",
            "sms": "+991116006724",
            "deptName": "Enterprise Collaboration Cloud Service Program",
            "role": 0,
            "phone": "+99119*****724",
            "type": "normal"
        }
    ],
    "confConfigInfo": {
        "isSendNotify": "false",
        "isSendSms": "false",
        "isSendCalendar": "false"
    },
    "recordType": 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: 1153
Connection: keep-alive
http_proxy_id: 79ea4d8bdb461a4b811a117f9cf3dbde
Server: api-gateway
X-Request-Id: 1ccc1d7937dd0f66067aeecb9f1df241

[
    {
        "conferenceID": "986256843",
        "mediaTypes": "HDVideo,Data,Voice",
        "subject": "Regular Recurring Meeting",
        "size": 0,
        "timeZoneID": "56",
        "startTime": "2021-09-01 08:39",
        "endTime": "2021-09-01 09:09",
        "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": "fe24d1350a3611ecbe71a328ac3ca004",
                "conferenceID": "986256843",
                "startTime": "2021-09-01 08:39",
                "endTime": "2021-09-01 09:09",
                "mediaType": "HDVideo,Data,Voice",
                "isAutoRecord": 0,
                "recordAuthType": 2,
                "confConfigInfo": {
                    "callInRestriction": 0,
                    "audienceCallInRestriction": 0,
                    "allowGuestStartConf": true,
                    "enableWaitingRoom": false
                }
            },
            {
                "cycleSubConfID": "fe24d1360a3611ecbe71fdd2c36bc8c2",
                "conferenceID": "986256843",
                "startTime": "2021-09-02 08:39",
                "endTime": "2021-09-02 09:09",
                "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 POST -H 'X-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"conferenceType": "2","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}],
"cycleParams": {"startDate": "2021-08-31","endDate": "2021-09-02","cycle": "Day","interval": 1,"preRemindDays": 1}}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/cycleconferences'

Parent topic: APIs

Previous topic: Modifying a Scheduled Meeting

Next topic: Canceling a Recurring Meeting Series