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
Request Method |
POST |
---|---|
Request Address |
/v1/mmc/management/conferences |
Transport Protocol |
HTTPS |
Request 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:
|
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.
|
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.
|
encryptMode |
No |
Integer |
Body |
Meeting media encryption mode. The default value is defined in the enterprise-level configuration.
|
language |
No |
String |
Body |
Language of meeting SMS or email notifications. The default language is Chinese.
|
timeZoneID |
No |
String |
Body |
Meeting time zone in meeting notifications. For details, see Time zone mapping.
NOTE:
|
recordType |
No |
Integer |
Body |
Recording type. Default value: 0.
|
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.
|
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.
|
vmrFlag |
No |
Integer |
Body |
Whether to use a cloud meeting room or personal meeting ID to hold the scheduled meeting. Default value: 0.
|
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:
|
concurrentParticipants |
No |
Integer |
Body |
Maximum number of participants in the meeting.
|
supportSimultaneousInterpretation |
No |
Boolean |
Body |
Whether simultaneous interpretation is supported.
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
userUUID |
No |
String |
Participant UUID. |
accountId |
No |
String |
Participant account.
|
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.
|
phone |
No |
String |
Number. SIP numbers or mobile numbers are supported.
NOTE:
|
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. |
|
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.
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.
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:
|
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. |
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:
|
interval |
No |
Integer |
Recurring meeting interval.
|
point |
No |
Array of integers |
Point for holding the recurring meeting. This parameter is valid only when cycle is set to Week or 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
isSendNotify |
No |
Boolean |
Whether to send emails. The default value is defined in the enterprise-level configuration.
|
isSendSms |
No |
Boolean |
Whether to send SMS notifications. The default value is defined in the enterprise-level configuration.
|
isSendCalendar |
No |
Boolean |
Whether to send calendar emails. The default value is defined in the enterprise-level configuration.
|
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.
|
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.
|
isGuestFreePwd |
No |
Boolean |
Whether a guest can join the meeting without the password.
NOTE:
This parameter is valid only for meetings with random meeting IDs. |
callInRestriction |
No |
Integer |
Users who are allowed to join the meeting.
|
allowGuestStartConf |
No |
Boolean |
Whether guests can 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.
|
prolongLength |
No |
Integer |
Duration for automatically extending a meeting. The value ranges from 0 to 60.
NOTE:
|
enableWaitingRoom |
No |
Boolean |
Whether to enable the waiting room (valid only for MMR enterprises).
|
isHostCameraOn |
No |
Boolean |
Whether the camera is enabled when the host joins the meeting. |
isGuestCameraOn |
No |
Boolean |
Whether the camera is enabled when a guest joins the meeting. |
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
Parameter |
Type |
Description |
---|---|---|
[Array element] |
Array of ConferenceInfo |
Meeting information list. |
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:
|
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"
|
conferenceState |
String |
Meeting status.
|
language |
String |
Language of meeting SMS or email notifications. The default language is Chinese.
|
accessNumber |
String |
SIP number for accessing the meeting. |
passwordEntry |
Array of PasswordEntry objects |
Meeting password.
NOTE:
|
userUUID |
String |
UUID of the user who schedules the meeting. |
scheduserName |
String |
Name of the meeting scheduler. |
conferenceType |
Integer |
Meeting type.
|
confType |
String |
Meeting type.
|
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.
|
isAutoRecord |
Integer |
Whether to 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.
|
auxAddress |
String |
Live broadcast address of the presentation. |
liveAddress |
String |
Live broadcast address of the video. |
recordAuxStream |
Integer |
Whether to record the presentation.
|
recordAuthType |
Integer |
Authentication mode for recording playback.
|
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.
|
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:
|
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.
NOTE:
|
multiStreamFlag |
Integer |
Whether the meeting is a 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.
|
scheduleVmr |
Boolean |
Whether the meeting is held in a cloud meeting room.
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.
|
supportSimultaneousInterpretation |
Boolean |
Whether simultaneous interpretation is supported.
|
picDisplay |
MultiPicDisplayDO object |
Continuous presence settings. |
subConfs |
Array of Subconfs objects |
Recurring meeting list. |
cycleSubConfID |
String |
UUID of the first recurring meeting. |
Parameter |
Type |
Description |
---|---|---|
conferenceRole |
String |
Participant role in the meeting.
|
password |
String |
Password for a participant role, which is in plaintext mode. |
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:
|
role |
Integer |
Participant role in the meeting. Default value: 0.
|
isMute |
Integer |
Whether to mute participants automatically when they join the meeting. Default value: 0.
NOTE:
This parameter is valid only when participants are invited to this meeting. |
Parameter |
Type |
Description |
---|---|---|
manualSet |
Integer |
Whether continuous presence is customized.
|
imageType |
String |
Layout type. Options:
|
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. |
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.
|
Parameter |
Type |
Description |
---|---|---|
x |
Integer |
Number of horizontal screens. |
y |
Integer |
Number of vertical screens. |
subPicLayoutInfoList |
Array of SubPicLayoutInfo objects |
Continuous presence settings. |
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. |
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:
|
interval |
Integer |
Recurring meeting interval.
|
point |
Array of integers |
Point for holding the recurring meeting. This parameter is valid only when cycle is set to Week or 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. |
Parameter |
Type |
Description |
---|---|---|
isSendNotify |
Boolean |
Whether to send emails. The default value is defined in the enterprise-level configuration.
|
isSendSms |
Boolean |
Whether to send SMS notifications. The default value is defined in the enterprise-level configuration.
|
isSendCalendar |
Boolean |
Whether to send calendar emails. The default value is defined in the enterprise-level configuration.
|
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.
|
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.
|
isGuestFreePwd |
Boolean |
Whether guests can join the meeting without the guest password. This parameter is valid only for meetings with random IDs.
NOTE:
This parameter is valid only for meetings with random meeting IDs. |
callInRestriction |
Integer |
Users who are allowed to join the meeting.
|
allowGuestStartConf |
Boolean |
Whether guests can 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.
|
prolongLength |
Integer |
Duration for automatically extending a meeting. The value ranges from 0 to 60.
NOTE:
|
enableWaitingRoom |
Boolean |
Waiting room status.
|
isHostCameraOn |
Boolean |
Whether the camera is enabled when the host joins the meeting. |
isGuestCameraOn |
Boolean |
Whether the camera is enabled when a guest joins the meeting. |
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'
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot