v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

Meetings

Create a Meeting with Id

API v1 create meeting passing in newly requested meeting Id

post/domains/{domain}/users/{user}/meetings/{id}

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

idstring required

Meeting Id to create

Request body

descriptionstring

current_timestamp'YYYY-MM-DDTHH:MM:SS.ssZ'

This is the time stamp that the formated via RFC 3339

meeting-calendar-invite-idstring

meeting-ordinal-sequenceinteger

core-serverstring

chat-session-idstring

meeting-registration-idstring

meeting-instance-idstring

meeting-namestring required

meeting-typestring

limits-max-participantsinteger

meeting-statusstring

meeting-schedule-start-datetime'YYYY-MM-DDTHH:MM:SS.ssZ'

This is the time stamp that the formated via RFC 3339

This is the time zone that the user is primarily located in

meeting-schedule-duration-minutesinteger

meeting-schedule-recurrence-rulestring

meeting-video-allowed-from'yes' | 'no'

meeting-audio-allowed-from'yes' | 'no'

meeting-chat-enabled'yes' | 'no'

meeting-chat-history-enabled'yes' | 'no'

meeting-question-answer-enabled'yes' | 'no'

meeting-recording-enabled'yes' | 'no'

meeting-join-require-invite-enabled'yes' | 'no'

meeting-join-require-passcode-enabled'yes' | 'no'

meeting-require-host-to-begin-enabled'yes' | 'no'

meeting-allow-changes-from-hosts-enabled'yes' | 'no'

meeting-hide-attendee-list-enabled'yes' | 'no'

meeting-lock-enabled'yes' | 'no'

meeting-lock-allowed'yes' | 'no'

meeting-room-enabled'yes' | 'no'

meeting-dial-in-number-blobstring

meeting-passcodestring

meeting-previous-presenter-attendee-idstring

meeting-presenter-attendee-idstring

meeting-video-layout integer

last-modified-datetime'YYYY-MM-DDTHH:MM:SS.ssZ'

This is the time stamp that the formated via RFC 3339

meeting-instance-actual-start-datetime'YYYY-MM-DDTHH:MM:SS.ssZ'

This is the time stamp that the formated via RFC 3339

Response

idinteger required

The meeting id

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

userstring required

This is the main user extension for the user account.

descriptionstring

The description about the meeting

current_timestampstring date-time required

The current timestamp value of the meeting

meeting-calendar-invite-idstring

The read only value for the meeting to use with calendar integration

meeting-ordinal-sequenceinteger

The read only value for the meeting with manage the calendar integrations

core-serverstring

The core server which the meeting was created on and events are driven from

chat-session-idstring

The read only value identifying the meeting chat room session

meeting-registration-idstring

The token value for guest to use to register for a webinar

meeting-instance-idstring

The instance value of a meeting with used to associate with a recording or differentiating recurring meetings

meeting-namestring

The descriptive name of the meeting

meeting-type'presentation' | 'conference'

The meeting category either the standard meeting 'conference' or a webinar style meeting by using 'presentation'

limits-max-participantsinteger

The maximum number of participants allows in the meeting

meeting-schedule-start-datetimestring date-time required

The scheduled start time for the meeting

This is the time zone that the user is primarily located in

meeting-schedule-duration-minutesinteger

The scheduled length of the meeting

meeting-schedule-recurrence-rulestring

The read only value describing the recuring nature of the meeting using RFC 5545

meeting-video-allowed-from'everyone' | 'host' | 'presenters'

The value indicating which attendee types can share video

meeting-audio-allowed-from'everyone' | 'host' | 'presenters'

The value indicating which attendee types can share audio

meeting-chat-enabledinteger

meeting-chat-history-enabledinteger

meeting-question-answer-enabledinteger

meeting-recording-enabledinteger

meeting-join-require-invite-enabledinteger

meeting-join-require-passcode-enabledinteger

meeting-require-host-to-begin-enabledinteger

meeting-allow-changes-from-hosts-enabledinteger

meeting-hide-attendee-list-enabledinteger

meeting-lock-enabledinteger

meeting-lock-allowedstring

The value indicating if the meeting is allowed to be locked

meeting-room-enabledinteger required

meeting-passcodestring

The passcode used to enter meeting if it is required

meeting-previous-presenter-attendee-idstring

The value of the previous attendee that prsented their screen

meeting-presenter-attendee-idstring

The value of the current attendee that is sharing their screen

meeting-video-layout 'spotlight' | 'conversation' | 'grid'

The current meeting layout default for entire meeting

last-modified-datetimestring date-time

The timestamp of the last time the meeting was modified

meeting-instance-actual-start-datetimestring date-time

The timestamp the current meeting instance was started

Example response

{
  "domain": "example.com",
  "user": "1000"
}