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

Creating a Meeting

Description

This API is used to create an instant meeting or schedule a meeting.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/mmc/management/conferences

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. Enter a maximum of 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: 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.
Table 3 Attendee data structure

Parameter

Mandatory

Type

Description

userUUID

No

String

Participant UUID.

accountId

No

String

Participant account.

  • In the account/password authentication scenario, this parameter is optional. Use the ID of a Huawei Cloud Meeting account.
  • In the app ID authentication scenario, this parameter is mandatory. Use the ID of a third-party user. The appId parameter must be carried.

appId

No

String

App ID. In the app ID authentication scenario, this parameter is mandatory. For details, see Requesting an App ID.

name

No

String

Participant name. The value can contain up to 96 characters.

role

No

Integer

Participant role in the meeting. Default value: 0.

  • 0: common participant.
  • 1: meeting host.

phone

No

String

Number. SIP numbers or mobile numbers are supported.

  • Mandatory for account/password authentication.
  • Optional for app ID authentication.
NOTE:
  • The number can be obtained through the API for Querying the Corporate Directory. The return value of number is a SIP number, and the return value of phone is a mobile number.
  • If you enter a SIP number, the system calls the corresponding soft terminal or hard terminal. If you enter a mobile number, the system dials the mobile number.
  • To make a call to a mobile phone, the PSTN permission must be enabled. Otherwise, the call cannot be made.

phone2

No

String

Reserved field. The value types are the same as those of the phone parameter.

phone3

No

String

Reserved field. The value types are the same as those of the phone parameter.

email

No

String

Email address. This parameter is mandatory when email notifications are required.

sms

No

String

Mobile number for receiving SMS notifications. This parameter is mandatory when SMS notifications are required.

isMute

No

Integer

Whether to mute participants automatically when they join the meeting. Default value: 0.

  • 0: Do not mute participants automatically.
  • 1: Mute participants automatically.
NOTE:

This parameter is valid only when participants are invited to this meeting.

isAutoInvite

No

Integer

Whether to automatically invite participants when the meeting starts. The default value is defined in the enterprise-level configuration.

  • 0: Do not automatically invite participants.
  • 1: Automatically invite participants.
NOTE:

This parameter is valid only for meetings held using concurrent participant resources and a random ID.

type

No

String

Terminal type. The options are as follows:

  • normal: soft client.
  • terminal: hard terminal.
  • outside: external participant.
  • mobile: mobile number.
  • ideahub: IdeaHub.
  • board: whiteboard (SmartRooms), including MaxHub, Hisense devices, and IdeaHub B2.
  • hwvision: smart TV.

address

No

String

Information about the meeting room where the terminal is located. This field is reserved.

deptUUID

No

String

Department ID.

deptName

No

String

Department name. The value can contain up to 128 characters.

Table 4 CycleParams data structure

Parameter

Mandatory

Type

Description

startDate

Yes

String

Start date of a recurring meeting series, in the format of YYYY-MM-DD.

The start date cannot be earlier than the current date.

NOTE:

The date should match the time zone specified by timeZoneID. It is not the date of the UTC time.

endDate

Yes

String

End date of a recurring meeting series, in the format of YYYY-MM-DD.

The interval between the start date and end date cannot exceed one year. Up to 50 meetings are allowed between the start date and end date. If there are more than 50 meetings, Huawei Cloud Meeting Management Platform automatically adjusts the end date.

NOTE:

The date should match the time zone specified by timeZoneID. It is not the date of the UTC time.

cycle

Yes

String

Period type. The options are as follows:

  • Day
  • Week
  • Month

interval

No

Integer

Recurring meeting interval.

  • If cycle is set to Day, the recurring meeting is held at an interval of the specified number of days. The value ranges from 1 to 15.
  • If cycle is set to Week, the recurring meeting is held at an interval of the specified number of weeks. The value ranges from 1 to 5.
  • If cycle is set to Month, the recurring meeting is held at an interval of the specified number of months. The value ranges from 1 to 3.

point

No

Array of integers

Point for holding the recurring meeting. This parameter is valid only when cycle is set to Week or Month.

  • If cycle is set to Week and point is set to 1 and 3, the meeting is held on Monday and Wednesday. If point is set to 0, the meeting is held on Sunday.
  • If cycle is set to Month and point is set to 12 and 20, the meeting is held on the twelfth and twentieth day of each month. The point value ranges from 1 to 31. If the specified day does not exist in a month, the meeting is held at the end of the month.

preRemindDays

Yes

Integer

Advance notification days. All participants receive the meeting notification N days before each recurring meeting starts. The value ranges from 0 to 30.

The default value is 1.

Table 5 ConfConfigInfo data structure

Parameter

Mandatory

Type

Description

isSendNotify

No

Boolean

Whether to send emails. The default value is defined in the enterprise-level configuration.

  • true: Send emails.
  • false: Do not send emails.

isSendSms

No

Boolean

Whether to send SMS notifications. The default value is defined in the enterprise-level configuration.

  • true: Send SMS notifications.
  • false: Do not send SMS notifications.
    NOTE:

    Only enterprises using commercial editions can send SMS notifications. For free enterprises, SMS notifications will not be sent even if isSendSms is set to true.

isSendCalendar

No

Boolean

Whether to send calendar emails. The default value is defined in the enterprise-level configuration.

  • true: Send calendar emails.
  • false: Do not send calendar emails.

isAutoMute

No

Boolean

Whether to mute the soft client of a guest when the guest joins the meeting. The default value is defined in the enterprise-level configuration.

  • true: Mute the guest automatically.
  • false: Do not mute the guest automatically.

isHardTerminalAutoMute

No

Boolean

Whether to mute the hard terminal of a guest when the guest joins the meeting. The default value is defined in the enterprise-level configuration.

  • true: Mute the guest automatically.
  • false: Do not mute the guest automatically.

isGuestFreePwd

No

Boolean

Whether a guest can join the meeting without the password.

  • true: Guests can join the meeting without the guest password.
  • false: Guests can only join the meeting using the guest password.
NOTE:

This parameter is valid only for meetings with random meeting IDs.

callInRestriction

No

Integer

Users who are allowed to join the meeting.

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

allowGuestStartConf

No

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 meeting IDs.

guestPwd

No

String

Guest password, which contains 4 to 16 digits.

vmrIDType

No

Integer

Type of the ID of the cloud meeting room meeting.

  • 0: fixed meeting ID.
  • 1: random meeting ID.

prolongLength

No

Integer

Duration for automatically extending a meeting. The value ranges from 0 to 60.

  • 0: The meeting automatically ends when the end time arrives and is not extended.
  • Other values: The meeting is extended by the specified duration.
NOTE:
  • The meeting end time is calculated based on the meeting duration. For example, a two-hour meeting starts at 9:00 and ends at 11:00. If participants join the meeting at 8:00, the meeting automatically ends at 10:00.
  • If this parameter is set to other values, the meeting can be automatically extended for multiple times as long as there are participants in the meeting.

enableWaitingRoom

No

Boolean

Whether to enable the waiting room (valid only for MMR enterprises).

  • true: enabled.
  • false: disabled.

isHostCameraOn

No

Boolean

Whether the camera is enabled when the host joins the meeting.

  • true: enabled.

  • false: disabled.

isGuestCameraOn

No

Boolean

Whether the camera is enabled when a guest joins the meeting.

  • true: enabled.

  • false: disabled.

Status Codes

Table 6 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 7 Response parameters

Parameter

Type

Description

[Array element]

Array of ConferenceInfo

Meeting information list.

Table 8 ConferenceInfo data structure

Parameter

Type

Description

conferenceID

String

Meeting ID.

subject

String

Meeting topic.

size

Integer

Number of participants added during meeting scheduling.

timeZoneID

String

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.

startTime

String

Meeting start time, in the format of YYYY-MM-DD HH:MM.

endTime

String

Meeting end time, in the format of YYYY-MM-DD HH:MM.

mediaTypes

String

Media type of the meeting.

The value consists of one or multiple enumerated values, which are separated by commas (,). The enumerated values are as follows: Example: mediaTypes: "Voice,Data,HDVideo"

  • Voice: voice.
  • Video: SD video.
  • HDVideo: HD video.
  • Data: data.

conferenceState

String

Meeting status.

  • Schedule: The meeting is to be held.
  • Creating: The meeting is being created.
  • Created: The meeting has been created and is in progress.
  • Destroyed: The meeting has ended.

language

String

Language of meeting SMS or email notifications. The default language is Chinese.

  • zh-CN: Chinese.
  • en-US: English.

accessNumber

String

SIP number for accessing the meeting.

passwordEntry

Array of PasswordEntry objects

Meeting password.

NOTE:
  • When a meeting is created, the host password and guest password are returned.
  • When the host queries a meeting, the host password and guest password are returned.
  • When a guest queries a meeting, the guest password is returned.

userUUID

String

UUID of the user who schedules the meeting.

scheduserName

String

Name of the meeting scheduler.

conferenceType

Integer

Meeting type.

  • 0: ordinary meeting.
  • 2: recurring meeting.

confType

String

Meeting type.

  • FUTURE: upcoming meeting (when the meeting is created).
  • IMMEDIATELY: instant meeting (when the meeting is created).
  • CYCLE: recurring meeting.

cycleParams

CycleParams object

Recurring meeting series parameter. This parameter list is carried when the meeting is a recurring meeting series.

isAutoMute

Integer

Whether to mute participants automatically when they join the meeting.

  • 0: Do not mute participants automatically.
  • 1: Mute participants automatically.

isAutoRecord

Integer

Whether to enable recording automatically.

  • 0: Do not enable recording automatically.
  • 1: Enable recording automatically.

chairJoinUri

String

Link for the host to join the meeting.

guestJoinUri

String

Link for guests to join the meeting.

audienceJoinUri

String

Link for attendees to watch the webinar.

recordType

Integer

Recording type.

  • 0: disabled.
  • 1: live broadcast.
  • 2: recording.
  • 3: live broadcast and recording.

auxAddress

String

Live broadcast address of the presentation.

liveAddress

String

Live broadcast address of the video.

recordAuxStream

Integer

Whether to record the presentation.

  • 0: Do not record the presentation.
  • 1: Record the presentation.

recordAuthType

Integer

Authentication mode for recording playback.

  • 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.

liveUrl

String

Live broadcast URL.

confConfigInfo

ConfConfigInfo object

Other meeting settings.

vmrFlag

Integer

Whether to use a cloud meeting room or personal meeting ID to hold the scheduled meeting.

  • 0: Do not use a cloud meeting room or personal meeting ID.
  • 1: Use a cloud meeting room or personal meeting ID.

isHasRecordFile

Boolean

Whether a meeting recording file exists. This parameter is returned only when historical meetings are queried.

true: The historical meeting has a recording file.

false: The historical meeting does not have a recording file.

vmrConferenceID

String

Cloud meeting room meeting ID or personal meeting ID. This parameter is not empty when vmrFlag is set to 1.

confUUID

String

UUID of the meeting.

NOTE:
  • The UUID is returned only when an instant meeting is created. It will not be returned for a scheduled meeting.
  • You can obtain the UUID of a historical meeting by calling the API for Querying the Historical Meeting List.

partAttendeeInfo

Array of PartAttendee objects

Information about invited participants.

NOTE:

terminlCount

Integer

Number of hard terminals, such as IdeaHubs and TE30.

normalCount

Integer

Number of common terminals, such as PCs and mobile apps.

deptName

String

Name of the enterprise that the user who schedules the meeting belongs to.

role

String

Participant role.

  • chair: host.
  • general: guest or panelist.
  • audience: attendee.
NOTE:
  • This parameter is returned only when meeting details are queried.
  • The role of person who initiates the query is returned.

multiStreamFlag

Integer

Whether the meeting is a multi-streaming video meeting.

  • 1: multi-streaming video meeting.

webinar

Boolean

Whether the meeting is a webinar.

onlineAttendeeAmount

Integer

Number of online participants, including participants who are invited to the meeting or proactively join the meeting.

NOTE:

This parameter is returned only after you call the API for Querying the Ongoing Meeting List.

confMode

String

Meeting type.

  • COMMON: MCU meeting.
  • RTC: MMR meeting.

scheduleVmr

Boolean

Whether the meeting is held in a cloud meeting room.

  • true: yes.
  • false: no.
NOTE:

This parameter will be discarded. Do not use it.

vmrID

String

Cloud meeting room ID.

concurrentParticipants

Integer

Maximum number of participants in the meeting. Default value: 0.

  • 0: unlimited.
  • > 0

supportSimultaneousInterpretation

Boolean

Whether simultaneous interpretation is supported.

  • true: supported.
  • false: not supported.

picDisplay

MultiPicDisplayDO object

Continuous presence settings.

subConfs

Array of Subconfs objects

Recurring meeting list.

cycleSubConfID

String

UUID of the first recurring meeting.

Table 9 PasswordEntry data structure

Parameter

Type

Description

conferenceRole

String

Participant role in the meeting.

  • chair: meeting host.
  • general: common participant.

password

String

Password for a participant role, which is in plaintext mode.

Table 10 PartAttendee data structure

Parameter

Type

Description

name

String

Participant name.

phone

String

Number. SIP number or mobile number.

phone2

String

Reserved field. The value types are the same as those of the phone parameter.

phone3

String

Reserved field. The value types are the same as those of the phone parameter.

type

String

Terminal type. The options are as follows:

  • normal: soft client.
  • terminal: hard terminal.
  • outside: external participant.
  • mobile: mobile number.
  • ideahub: IdeaHub.
  • board: whiteboard (SmartRooms), including MaxHub, Hisense devices, and IdeaHub B2.
  • hwvision: smart TV.

role

Integer

Participant role in the meeting. Default value: 0.

  • 0: common participant.
  • 1: meeting host.

isMute

Integer

Whether to mute participants automatically when they join the meeting. Default value: 0.

  • 0: Do not mute participants automatically.
  • 1: Mute participants automatically.
NOTE:

This parameter is valid only when participants are invited to this meeting.

Table 11 MultiPicDisplayDO data structure

Parameter

Type

Description

manualSet

Integer

Whether continuous presence is customized.

  • 0: no. The automatic continuous presence is used.
  • 1: yes.

imageType

String

Layout type. Options:

  • Single: single screen.
  • Two: two screens.
  • Three: three screens. Three-2: three screens-2. Three-3: three screens-3. Three-4: three screens-4.
  • Four: four screens. Four-2: four screens-2. Four-3: four screens-3.
  • Five: five screens. Five-2: five screens-2.
  • Six: six screens. Six-2: six screens-2. Six-3: six screens-3. Six-4: six screens-4. Six-5: six screens-5.
  • Seven: seven screens. Seven-2: seven screens-2. Seven-3: seven screens-3. Seven-4: seven screens-4.
  • Eight: eight screens. Eight-2: eight screens-2. Eight-3: eight screens-3. Eight-4: eight screens-4.
  • Nine: nine screens.
  • Ten: 10 screens. Ten-2: 10 screens-2. Ten-3: 10 screens-3. Ten-4: 10 screens-4. Ten-5: 10 screens-5. Ten-6: 10 screens-6.
  • Thirteen: 13 screens. Thirteen-2: 13 screens-2. Thirteen-3: 13 screens-3. Thirteen-4: 13 screens-4. Thirteen-5: 13 screens-5. ThirteenR: 13 screens-R. ThirteenM: 13 screens-M.
  • Sixteen: 16 screens.
  • Seventeen: 17 screens.
  • Twenty-Five: 25 screens.
  • Custom: customized continuous presence (coming soon).

subscriberInPics

Array of PicInfoNotify objects

Screen list.

switchTime

Integer

Interval for displaying participants in turn, in seconds. This parameter is valid only when a screen contains multiple video sources.

picLayoutInfo

PicLayoutInfo object

Details about the custom continuous presence layout. This parameter is reserved and is not supported currently.

Table 12 PicInfoNotify data structure

Parameter

Type

Description

index

Integer

Number of each screen in continuous presence. The number starts from 1.

id

Array of strings

SIP number of the participant in each screen. The SIP number can be obtained through the API for Querying the Corporate Directory.

share

Integer

Whether a stream is a presentation.

  • 0: no.
  • 1: yes.
Table 13 PicLayoutInfo data structure

Parameter

Type

Description

x

Integer

Number of horizontal screens.

y

Integer

Number of vertical screens.

subPicLayoutInfoList

Array of SubPicLayoutInfo objects

Continuous presence settings.

Table 14 SubPicLayoutInfo data structure

Parameter

Type

Description

id

Integer

Screen index.

left

Integer

Screen index from left to right.

top

Integer

Screen index from top to bottom.

xSize

Integer

Horizontal size of the screen.

ySize

Integer

Vertical size of the screen.

Table 15 CycleParams data structure

Parameter

Type

Description

startDate

String

Start date of a recurring meeting series, in the format of YYYY-MM-DD.

The start date cannot be earlier than the current date.

NOTE:

The date should match the time zone specified by timeZoneID. It is not the date of the UTC time.

endDate

String

End date of a recurring meeting series, in the format of YYYY-MM-DD.

The interval between the start date and end date cannot exceed one year. Up to 50 meetings are allowed between the start date and end date. If there are more than 50 meetings, Huawei Cloud Meeting Management Platform automatically adjusts the end date.

NOTE:

The date should match the time zone specified by timeZoneID. It is not the date of the UTC time.

cycle

String

Period type. The options are as follows:

  • Day
  • Week
  • Month

interval

Integer

Recurring meeting interval.

  • If cycle is set to Day, the recurring meeting is held at an interval of the specified number of days. The value ranges from 1 to 15.
  • If cycle is set to Week, the recurring meeting is held at an interval of the specified number of weeks. The value ranges from 1 to 5.
  • If cycle is set to Month, the recurring meeting is held at an interval of the specified number of months. The value ranges from 1 to 3.

point

Array of integers

Point for holding the recurring meeting. This parameter is valid only when cycle is set to Week or Month.

  • If cycle is set to Week and point is set to 1 and 3, the meeting is held on Monday and Wednesday. If point is set to 0, the meeting is held on Sunday.
  • If cycle is set to Month and point is set to 12 and 20, the meeting is held on the twelfth and twentieth day of each month. The point value ranges from 1 to 31. If the specified day does not exist in a month, the meeting is held at the end of the month.

preRemindDays

Integer

Advance notification days. All participants receive the meeting notification N days before each recurring meeting starts. The value ranges from 0 to 30.

The default value is 1.

Table 16 ConfConfigInfo data structure

Parameter

Type

Description

isSendNotify

Boolean

Whether to send emails. The default value is defined in the enterprise-level configuration.

  • true: Send calendar emails.
  • false: Do not send emails.

isSendSms

Boolean

Whether to send SMS notifications. The default value is defined in the enterprise-level configuration.

  • true: Send SMS notifications.
  • false: Do not send SMS notifications.

isSendCalendar

Boolean

Whether to send calendar emails. The default value is defined in the enterprise-level configuration.

  • true: Send calendar emails.
  • false: Do not send calendar emails.

isAutoMute

Boolean

Whether to mute the soft client of a guest when the guest joins the meeting. The default value is defined in the enterprise-level configuration.

  • true: Mute the guest automatically.
  • false: Do not mute the guest automatically.

isHardTerminalAutoMute

Boolean

Whether to mute the hard terminal of a guest when the guest joins the meeting. The default value is defined in the enterprise-level configuration.

  • true: Mute the guest automatically.
  • false: Do not mute the guest automatically.

isGuestFreePwd

Boolean

Whether guests can join the meeting without the guest password. This parameter is valid only for meetings with random IDs.

  • true: Guests can join the meeting without the guest password.
  • false: Guests can only join the meeting using the guest password.
NOTE:

This parameter is valid only for meetings with random meeting IDs.

callInRestriction

Integer

Users who are allowed to join the meeting.

  • 0: everyone.
  • 2: enterprise users.
  • 3: 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 meeting IDs.

guestPwd

String

Guest password, which contains 4 to 16 digits.

vmrIDType

Integer

Type of the ID of the cloud meeting room meeting.

  • 0: fixed meeting ID.
  • 1: random meeting ID.

prolongLength

Integer

Duration for automatically extending a meeting. The value ranges from 0 to 60.

  • 0: The meeting automatically ends when the end time arrives and is not extended.
  • Other values: The meeting is extended by the specified duration.
NOTE:
  • The meeting end time is calculated based on the meeting duration. For example, a two-hour meeting starts at 9:00 and ends at 11:00. If participants join the meeting at 8:00, the meeting automatically ends at 10:00.
  • If this parameter is set to other values, the meeting can be automatically extended for multiple times as long as there are participants in the meeting.

enableWaitingRoom

Boolean

Waiting room status.

  • true: enabled.
  • false: disabled.

isHostCameraOn

Boolean

Whether the camera is enabled when the host joins the meeting.

  • true: enabled.

  • false: disabled.

isGuestCameraOn

Boolean

Whether the camera is enabled when a guest joins the meeting.

  • true: enabled.

  • false: disabled.

Example Request

POST /v1/mmc/management/conferences
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
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 Meeting",
    "mediaTypes": "HDVideo",
    "startTime": "2022-08-30 12:00",
    "length": 60,
    "attendees": [
        {
            "accountId": "zhangshan@huawei.com",
            "appId": "caaab5a3e584497990f6a9b582a0ae42"
        }
    ],
   "confConfigInfo": {
       "isSendNotify": false,
       "isSendSms": false,
       "isSendCalendar": false
    }
}

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": "914673889",
        "mediaTypes": "Data,Voice,HDVideo",
        "subject": "Regular Meeting",
        "size": 1,
        "timeZoneID": "56",
        "startTime": "2022-08-30 12:00",
        "endTime": "2022-08-30 13:00",
        "conferenceState": "Schedule",
        "accessNumber": "+991117",
        "language": "zh-CN",
        "passwordEntry": [
            {
                "conferenceRole": "chair",
                "password": "******"
            },
            {
                "conferenceRole": "general",
                "password": "******"
            }
        ],
        "userUUID": "ff80808167ef1edf0167f339533d05a6",
        "scheduserName": "Kim",
        "conferenceType": 0,
        "confType": "FUTURE",
        "isAutoMute": 1,
        "isAutoRecord": 0,
        "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914673889/6a30b8b5a325105da031442627828e496f91021ece36405f",
        "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914673889/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d",
        "recordType": 2,
        "confConfigInfo": {  
            "isSendNotify": false,
            "isSendSms": false,
            "isAutoMute": true
        },
        "vmrFlag": 0,
        "partAttendeeInfo": [
            {
                "phone": "+99111********4158",
                "name": "Tom",               
                "type": "normal"
            }
        ],
        "terminlCount": 0,
        "normalCount": 1,
        "deptName": "Enterprise Collaboration Cloud Service Program"
    }
]

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:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"conferenceType": "0","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}]}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences'