List Meetings
The previous List Meetings of a Meeting Series API is merged into the List Meetings API.
Retrieves details for meetings with a specified meeting number, web link, meeting type, etc. Please note that there are various products in the Webex Suite such as Meetings and Events. Currently, only meetings of the Meetings product are supported by this API, meetings of others in the suite are not supported. Ad-hoc meetings created by Create a Meeting with adhoc of true and a roomId will not be listed, but the ended and ongoing ad-hoc meeting instances will be listed.
Lists scheduled meeting and meeting instances of a meeting series identified by meetingSeriesId. Scheduled meetings of an ad-hoc meeting created by Create a Meeting with adhoc of true and a roomId are not listed, but the ended and ongoing meeting instances of it are. Each scheduled meeting or meeting instance of a meeting series has its own start, end, etc. Thus, for example, when a daily meeting has been scheduled from 2019-04-01 to 2019-04-10, there are 10 scheduled meeting instances in this series, one instance for each day, and each one has its own attributes. When a scheduled meeting has been started and ended or is happening, there are even more ended or in-progress meeting instances.
Long result sets are split into pages.
The default value of
meetingSerieswill be used ifmeetingTypeis not specified. When listing meetings withmeetingType=meetingSeriesimplicitly or explicitly, the API returns all the recurring meeting series where the user is the meeting host or an invitee to the meeting. Please note that a meeting with norecurrenceattribute is considered a meeting series with only one occurrence and it can also be listed withmeetingType=meetingSeries. A recurring meeting series may have multiple occurrences which are scattered over weeks, months, or years. So, any meeting series that overlaps with the time range specified byfromandtowill be listed. For example, a monthly meeting series withstart=2024-01-01T10:00:00Z,end=2024-01-01T11:00:00Zandrecurrence=FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=1;UNTIL=20250210T000000Zcan be listed withmeetingType=meetingSeries&from=2024-10-01&to=2024-11-01even if thestartandendare not in the specified time range.If
meetingSeriesIdparameter is specified,meetingNumber,webLink,roomId,current,integrationTag,scheduledType,siteUrlwill be ignored.If
meetingNumberis specified, the operation returns an array of meeting objects specified by themeetingNumber. Each object in the array can be a scheduled meeting or a meeting series depending on whether thecurrentparameter istrueorfalse, and each object contains the simultaneous interpretation object. WhenmeetingNumberis specified, parameters offrom,to,meetingType,state,isModifiedandsiteUrlwill be ignored. Please note thatmeetingNumber,webLinkandroomIdare mutually exclusive and they cannot be specified simultaneously.If
webLinkis specified, the operation returns an array of meeting objects specified by thewebLink. Each object in the array is a scheduled meeting, and each object contains the simultaneous interpretation object. WhenwebLinkis specified, parameters ofcurrent,from,to,meetingType,state,isModifiedandsiteUrlwill be ignored. Please note thatmeetingNumber,webLinkandroomIdare mutually exclusive and they cannot be specified simultaneously.If
roomIdis specified, the operation returns an array of meeting objects of the Webex space specified by theroomId. WhenroomIdis specified, parameters ofcurrent,meetingType,stateandisModifiedwill be ignored. The meeting objects are queried on the user's preferred site if nositeUrlis specified; otherwise, queried on the specified site.meetingNumber,webLinkandroomIdare mutually exclusive and they cannot be specified simultaneously.If
stateparameter is specified, the returned array only has items in the specified state. Ifstateis not specified, return items of all states.If
meetingTypeequals "meetingSeries", thescheduledTypeparameter can be "meeting", "webinar" or null. IfscheduledTypeis specified, the returned array only has items of the specified scheduled type; otherwise, it has items of "meeting" and "webinar".If
meetingTypeequals "scheduledMeeting", thescheduledTypeparameter can be "meeting", "webinar", "personalRoomMeeting" or null. IfscheduledTypeis specified, the returned array only has items of the specified scheduled type; otherwise, it has items of all scheduled types.If
meetingTypeequals "meeting", thescheduledTypeparameter can be "meeting", "webinar" or null. IfscheduledTypeis specified, the returned array only has items of the specified scheduled type; otherwise, it has items of "meeting" and "webinar". Please note that ended or in-progress meeting instances of personal room also fall into the category of "meeting"scheduledType.If
meetingTypeequals "meeting", a maximum of 10000 meeting instances can be listed even if pagination is enabled.If
isModifiedparameter is specified, the returned array only has items which have been modified to exceptional meetings. This parameter only applies to scheduled meeting.If any of the
hasChat,hasRecording,hasTranscription,hasClosedCaption,hasPollsandhasQAparameters is specified, themeetingTypemust be "meeting" andstatemust be "ended". These parameters are null by default.The
currentparameter only applies to meeting series. If it'sfalse, thestartandendattributes of each returned meeting series object are for the first scheduled meeting of that series. If it'strueor not specified, thestartandendattributes are for the scheduled meeting which is ready to start or join or the upcoming scheduled meeting of that series.If
fromandtoare specified, the operation returns an array of meeting objects in that specified time range.If the parameter
siteUrlhas a value, the operation lists meetings on the specified site; otherwise, lists meetings on the user's all sites. All available Webex sites of the user can be retrieved byGet Site ListAPI.trackingCodesis not supported for ended meeting instances.A full admin or a content admin can list all the ended and ongoing meeting instances of the organization he manages with the
meeting:admin_schedule_readscope andmeetingType=meetingparameter.To learn more about which attributes are available for different meeting states, please refer to Available Meeting Attributes for Different Meeting States.
Request Header
password: Meeting password. Required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost or invitee of the meeting.timezone: Time zone for time stamps in response body, defined in conformance with the IANA time zone database. The default value isUTCif not specified.
Query Parameters
Meeting number for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.
URL encoded link to information page for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive.
Associated Webex space ID for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive.
Unique identifier for the meeting series. The meeting ID of a scheduled personal room meeting is not supported.
Limit the maximum number of meetings in the response, up to 100. This parameter is ignored if meetingNumber, webLink or roomId is specified.
Start date and time (inclusive) for the range for which meetings are to be returned in any ISO 8601 compliant format. from cannot be after to. This parameter will be ignored if meetingNumber, webLink or roomId is specified.
End date and time (exclusive) for the range for which meetings are to be returned in any ISO 8601 compliant format. to cannot be before from. This parameter will be ignored if meetingNumber, webLink or roomId is specified.
Meeting type for the meeting objects being requested. This parameter will be ignored if meetingNumber, webLink or roomId is specified.
Meeting state for the meeting objects being requested. If not specified, return meetings of all states. This parameter will be ignored if meetingNumber, webLink or roomId is specified. Details of an ended meeting will only be available 15 minutes after the meeting has ended. inProgress meetings are not fully supported. The API will try to return details of an inProgress meeting 15 minutes after the meeting starts. However, it may take longer depending on the traffic. See the Webex Meetings guide for more information about the states of meetings.
Scheduled type for the meeting objects being requested.
Flag identifying whether a meeting has been modified. Only applies to scheduled meetings. If true, only return modified scheduled meetings; if false, only return unmodified scheduled meetings; if not specified, all scheduled meetings will be returned.
Flag identifying whether a meeting has a chat log. Only applies to ended meeting instances. If true, only return meeting instances which have chats; if false, only return meeting instances which have no chats; if not specified, all meeting instances will be returned.
Flag identifying meetings which have been recorded. Only applies to ended meeting instances. If true, only return meeting instances which have been recorded; if false, only return meeting instances which have not been recorded; if not specified, all meeting instances will be returned.
Flag identifying meetings with transcripts. Only applies to ended meeting instances. If true, only return meeting instances which have transcripts; if false, only return meeting instances which have no transcripts; if not specified, all meeting instances will be returned.
Flag identifying meetings with closed captions. Only applies to ended meeting instances. If true, only return meeting instances which have closed captions; if false, only return meeting instances which have no closed captions; if not specified, all meeting instances will be returned.
Flag identifying meetings with polls. Only applies to ended meeting instances. If true, only return meeting instances which have polls; if false, only return meeting instances which have no polls; if not specified, all meeting instances will be returned.
Flag identifying meetings with Q&A. Only applies to ended meeting instances. If true, only return meeting instances which have Q&A; if false, only return meeting instances which have no Q&A; if not specified, all meeting instances will be returned.
Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where meetingNumber is specified and the meeting is not an exceptional meeting from a meeting series. If it's true, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's false, return the entire meeting series.
Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API returns meetings as if the user calling the API were the user of hostEmail themself, and the meetings returned by the API include the meetings where the user of hostEmail is the meeting host and those where they are an invitee.
URL of the Webex site which the API lists meetings from. If not specified, the API lists meetings from user's all sites. All available Webex sites of the user can be retrieved by Get Site List API.
External key created by an integration application. This parameter is used by the integration application to query meetings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.
Response Properties
Meetings array.
Unique identifier for meeting. For a meeting series, the id is used to identify the entire series. For scheduled meetings from a series, the id is used to identify that scheduled meeting. For a meeting instance that is in progress or has concluded, the id is used to identify that instance.
Unique identifier for meeting series. It only apples to scheduled meeting and meeting instance. If it's a scheduled meeting from a series or a meeting instance that is happening or has happened, the meetingSeriesId is the id of the primary series.
Unique identifier for scheduled meeting which current meeting is associated with. It only apples to meeting instance which is happening or has happened. It's the id of the scheduled meeting this instance is associated with.
Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.
Meeting title. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Meeting agenda. The agenda can be a maximum of 1300 characters long. This attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Meeting password. Applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
8-digit numeric password used to join a meeting from audio and video devices. This attribute applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended.
Meeting type.
Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a recurrence rule. When a non-recurring meeting is scheduled with no recurrence, its meetingType is also meetingSeries which is a meeting series with only one occurrence in Webex meeting modeling.
Instance from a primary meeting series.
Meeting instance that is in progress or has completed.
Meeting state.
Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.
Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.
Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.
Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.
Applies to meeting series and meeting instance. For meeting series, indicates that an instance of this series is in progress; for a meeting instances, indicates that the meeting has been joined and unlocked.
Applies to scheduled meetings and meeting instances. For scheduled meetings, indicates that the meeting was started and is now over. For meeting instances, indicates that the meeting instance has concluded.
This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.
This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.
Only applies to meeting series in the inProgress state, scheduled meetings in the ready state, and meeting instances in the inProgress state, whether or not the meeting host joined the meeting. If true, the meeting host has joined the meeitng even if they dropped off; otherwise, the meeting host hasn't ever join the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if attendeeDidJoin is true and hostDidJoin is false.
Only applies to meeting series in the inProgress state, scheduled meetings in the ready state, and meeting instances in the inProgress state. Whether or not anyone has joined the meeting. If true, the meeting host or any attendee has joined the meeting; otherwise, no one has joined the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if attendeeDidJoin is true and hostDidJoin is false.
This state only applies to scheduled meeting. Flag identifying whether or not the scheduled meeting has been modified.
Time zone of start and end, conforming with the IANA time zone database.
Start time for meeting in ISO 8601 compliant format. If the meetingType of a meeting is meetingSeries, start is the scheduled start time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, start is the date and time the upcoming or ongoing meeting of the series starts. If the meetingType of a meeting is scheduledMeeting, start is the scheduled start time of this occurrence. If the meetingType of a meeting is meeting, start is the actual start time of the meeting instance. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
End time for a meeting in ISO 8601 compliant format. If the meetingType of a meeting is meetingSeries, end is the scheduled end time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, end is the date and time the upcoming or ongoing meeting of the series ends. If the meetingType of a meeting is scheduledMeeting, end is the scheduled end time of this occurrence. If the meetingType of a meeting is meeting, end is the actual end time of the meeting instance. If a meeting instance is in progress, end is not available. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Meeting series recurrence rule (conforming with RFC 2445). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Can be modified for a meeting series using the Update a Meeting API. Multiple days or dates for monthly or yearly recurrence rule are not supported, only the first day or date specified is taken. For example, "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10,11,12" is not supported and it will be partially supported as "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10".
Unique identifier for the meeting host.
Display name for the meeting host.
Email address for the meeting host.
Key for joining the meeting as host.
Site URL for the meeting.
Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.
SIP address for callback from a video system.
IP address for callback from a video system.
Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings.
Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by a siteUrl parameter when creating the meeting. If not specified, it's a user's preferred site. The allowAnyUserToBeCoHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Whether or not to allow any attendee to join the meeting before the host joins the meeting. The enabledJoinBeforeHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Whether or not to allow any attendee to connect to audio before the host joins the meeting. Only applicable if the enabledJoinBeforeHost attribute is set to true. The enableConnectAudioBeforeHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the enabledJoinBeforeHost attribute is set to true. The joinBeforeHostMinutes attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API. Valid options for a meeting are 0, 5, 10, and 15, and valid options for a webinar are 0, 15, 30, 45, and 60. The default is 0 if not specified.
Whether or not to exclude the meeting password from the email invitation.
Whether or not to allow the meeting to be listed on the public calendar.
The number of minutes before the meeting begins, that an email reminder is sent to the host.
Specifies how the people who aren't on the invite can join the unlocked meeting.
If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.
If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.
If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.
Unique identifier for a meeting session type for the user. This attribute is required when scheduling a webinar meeting. All available meeting session types enabled for the user can be retrieved using the List Meeting Session Types API.
Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's personal room.
If the value of scheduledType attribute is meeting, it is a regular meeting.
If the value of scheduledType attribute is webinar, it is a webinar meeting.
If the value of scheduledType attribute is personalRoomMeeting, it is a meeting scheduled in the user's personal room.
Whether or not webcast view is enabled.
Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read password management for details. If not specified, a random password conforming to the site's password rules will be generated automatically.
8-digit numeric panelist password to join a webinar meeting from audio and video devices.
Whether or not to automatically lock the meeting after it starts.
The number of minutes after the meeting begins, for automatically locking it.
Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by the siteUrl parameter when creating the meeting. If not specified, it's a user's preferred site. The allowFirstUserToBeCoHost attribute can be modified for a meeting series or a scheduled meeting uisng the Update a Meeting API.
Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Whether or not this meeting instance has chat.
Whether or not this meeting instance has been recorded. true if the meeting instance has been recorded even if the recording has been deleted.
Whether or not this meeting instance has a transcription.
Whether or not this meeting instance has closed captions.
Whether or not this meeting instance has polls.
Whether or not this meeting instance has Q&A.
Whether or not this meeting instance has a registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances.
Whether or not someone has registered a this meeting instance via the registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances.
Whether this meeting instance has a survey and someone has responded to the survey. Only applies to ended webinar instances. Doesn't apply to meeting series, scheduled meetings, in-progress meeting or webinar instances, or ended meeting instances.
Information for callbacks from a meeting to phone or for joining a teleconference using a phone.
Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the accessCode.
Array of call-in numbers for joining a teleconference from a phone.
Label for the call-in number.
Call-in number to join the teleconference from a phone.
Type of toll for the call-in number.
HATEOAS information of global call-in numbers for joining a teleconference from a phone.
Meeting Options.
Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.
Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.
Whether or not to allow any attendee to poll in the meeting. Can only be set true for a webinar. The value of this attribute depends on the session type for a meeting. Please contact your site admin if this attribute is not available. Not supported if the site has been migrated to the Webex Suite meeting platform.
Whether or not to allow any attendee to take notes in the meeting. The value of this attribute also depends on the session type. Not supported if the site has been migrated to the Webex Suite meeting platform.
Whether note taking is enabled. If the value of enabledNote is false, users cannot set this attribute and get the default value allowAll. Not supported if the site has been migrated to the Webex Suite meeting platform.
If the value of noteType attribute is allowAll, all participants can take notes.
If the value of noteType attribute is allowOne, only a single note taker is allowed.
Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.
Whether or not to allow any attendee to share Universal Communications Format media files in the meeting. The value of this attribute also depends on the sessionType. Not supported if the site has been migrated to the Webex Suite meeting platform.
Attendee Privileges. This attribute is not supported for a webinar.
Whether or not to allow any attendee to share content in the meeting.
Whether or not to allow any attendee to save shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to print shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to annotate shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to view participants.
Whether or not to allow any attendee to see a small preview image of any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.
Whether or not to allow any attendee to view any shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to scroll through any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to contact the operator privately.
Whether or not to allow any attendee to chat with the host in private.
Whether or not to allow any attendee to chat with the presenter in private.
Whether or not to allow any attendee to chat with other participants in private.
Meeting registration. When this option is enabled, meeting invitees must register personal information in order to join the meeting. Meeting invitees will receive an email with a registration link for the registration. When the registration form has been submitted and approved, an email with a real meeting link will be received. By clicking that link the meeting invitee can join the meeting. Please note that meeting registration does not apply to a meeting when it's a recurring meeting with a recurrence field or no password or when the feature toggle DecoupleJBHWithRegistration is disabled the Join Before Host option is enabled for the meeting, See Register for a Meeting in Cisco Webex Meetings for details.
Whether or not meeting registration requests are accepted automatically.
Whether or not a registrant's first name is required for meeting registration.
Whether or not a registrant's last name is required for meeting registration.
Whether or not a registrant's email is required for meeting registration.
Whether or not a registrant's job title is shown or required for meeting registration.
Whether or not a registrant's company name is shown or required for meeting registration.
Whether or not a registrant's first address field is shown or required for meeting registration.
Whether or not a registrant's second address field is shown or required for meeting registration.
Whether or not a registrant's city is shown or required for meeting registration.
Whether or not a registrant's state is shown or required for meeting registration.
Whether or not a registrant's postal code is shown or required for meeting registration.
Whether or not a registrant's country or region is shown or required for meeting registration.
Whether or not a registrant's work phone number is shown or required for meeting registration.
Whether or not a registrant's fax number is shown or required for meeting registration.
Maximum number of meeting registrations. This only applies to meetings. The maximum number of participants for meetings and webinars, with the limit based on the user capacity and controlled by a toggle at the site level. The default maximum number of participants for webinars is 10000, but the actual maximum number of participants is limited by the user capacity.
If true, generate random ID authentication for each registrant. Webinars only.
External keys created by an integration application in its domain, for example, Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc.
Simultaneous interpretation information for the meeting.
Whether or not simultaneous interpretation is enabled.
Interpreters for meeting.
Unique identifier for meeting interpreter.
Email address of meeting interpreter.
Display name of meeting interpreter.
Whether or not breakout sessions are enabled.
HATEOAS Breakout Sessions information for meeting.
Link relation describing how the target resource is related to the current context (conforming with RFC5998).
Target resource URI (conforming with RFC5998).
Target resource method (conforming with RFC5998).
Tracking codes information.
Name for the tracking code.
Value for the tracking code.
Whether or not the audio watermark is enabled.
Whether or not the visual watermark is enabled.
Opacity level for visual watermark.
Audio connection options.
Choose how meeting attendees join the audio portion of the meeting.
Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.
Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.
Other teleconference services.
The way of attendees join the audio portion of the meeting is the default value.
Whether or not to show toll-free call-in numbers.
Whether or not to show global call-in numbers to attendees.
Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.
Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.
All call-in users joining the meeting will hear the beep.
All call-in users joining the meeting will hear their names.
Turn off beeps and name announcements.
Whether or not to allow the host to unmute participants.
Whether or not to allow attendees to unmute themselves.
Whether or not to auto-mute attendees when attendees enter meetings.
Require attendees to sign in before joining the webinar.
Restrict webinar to invited attendees only.
Whether or not live streaming is enabled. If enabled, the liveStream must be specified. The RTMP streaming specified by liveStream.rtmpUrl can be started and viewed during the meeting without any ad-hoc settings.
Live streaming settings. Applies when enabledLiveStream is true.
A descriptive text to describe the destination of the live streaming.
Live streaming RTMP URL.
The URL to view the live streaming, i.e. the playback URL.
Live streaming layout when there's no shared content.
The video layout that allows you to see multiple participants in a meeting in grids.
The video layout that displays the active speaker on the stage and up to six participants in thumbnails across the top.
The video layout that only displays the active speaker.
Live streaming layout when there's shared content.
The video layout that displays the shared content on the stage and up to six participants in thumbnails across the top.
The layout that displays the shared content in the main part of the screen and a large thumbnail of the active speaker in the upper right corner.
The layout that only displays the shared content in the main part of the screen and does not display the participants.
Whether or not to allow change the live streaming layout in the meeitng.
Whether or not to follow the stage layout when it's being synchronized.
Resolution of the live streaming.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Meeting number for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.
- URL encoded link to information page for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive.
- Associated Webex space ID for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive.
- Unique identifier for the meeting series. The meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported.
- Limit the maximum number of meetings in the response, up to 100. This parameter is ignored if `meetingNumber`, `webLink` or `roomId` is specified.
- Start date and time (inclusive) for the range for which meetings are to be returned in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
- End date and time (exclusive) for the range for which meetings are to be returned in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
- Meeting type for the meeting objects being requested. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
- Meeting state for the meeting objects being requested. If not specified, return meetings of all states. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified. Details of an `ended` meeting will only be available 15 minutes after the meeting has ended. `inProgress` meetings are not fully supported. The API will try to return details of an `inProgress` meeting 15 minutes after the meeting starts. However, it may take longer depending on the traffic. See the [Webex Meetings](/docs/meetings#meeting-states) guide for more information about the states of meetings.
- Scheduled type for the meeting objects being requested.
- Flag identifying whether a meeting has been modified. Only applies to scheduled meetings. If `true`, only return modified scheduled meetings; if `false`, only return unmodified scheduled meetings; if not specified, all scheduled meetings will be returned.
- Flag identifying whether a meeting has a chat log. Only applies to ended meeting instances. If `true`, only return meeting instances which have chats; if `false`, only return meeting instances which have no chats; if not specified, all meeting instances will be returned.
- Flag identifying meetings which have been recorded. Only applies to ended meeting instances. If true, only return meeting instances which have been recorded; if false, only return meeting instances which have not been recorded; if not specified, all meeting instances will be returned.
- Flag identifying meetings with transcripts. Only applies to ended meeting instances. If `true`, only return meeting instances which have transcripts; if `false`, only return meeting instances which have no transcripts; if not specified, all meeting instances will be returned.
- Flag identifying meetings with closed captions. Only applies to ended meeting instances. If `true`, only return meeting instances which have closed captions; if `false`, only return meeting instances which have no closed captions; if not specified, all meeting instances will be returned.
- Flag identifying meetings with polls. Only applies to ended meeting instances. If `true`, only return meeting instances which have polls; if `false`, only return meeting instances which have no polls; if not specified, all meeting instances will be returned.
- Flag identifying meetings with Q&A. Only applies to ended meeting instances. If `true`, only return meeting instances which have Q&A; if `false`, only return meeting instances which have no Q&A; if not specified, all meeting instances will be returned.
- Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where `meetingNumber` is specified and the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series.
- Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API returns meetings as if the user calling the API were the user of `hostEmail` themself, and the meetings returned by the API include the meetings where the user of `hostEmail` is the meeting host and those where they are an invitee.
- URL of the Webex site which the API lists meetings from. If not specified, the API lists meetings from user's all sites. All available Webex sites of the user can be retrieved by `Get Site List` API.
- External key created by an integration application. This parameter is used by the integration application to query meetings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.
{
"items": [
{
"id": "870f51ff287b41be84648412901e0402_20191101T120000Z",
"meetingSeriesId": "870f51ff287b41be84648412901e0402",
"meetingNumber": "123456789",
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"password": "BgJep@43",
"phoneAndVideoSystemPassword": "12345678",
"meetingType": "scheduledMeeting",
"state": "ready",
"hostDidJoin": true,
"attendeeDidJoin": true,
"isModified": false,
"timezone": "UTC",
"start": "2019-11-01T12:00:00Z",
"end": "2019-11-01T13:00:00Z",
"hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"hostKey": "123456",
"siteUrl": "site4-example.webex.com",
"webLink": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e",
"sipAddress": "123456789@site4-example.webex.com",
"dialInIpAddress": "192.168.100.100",
"enabledAutoRecordMeeting": false,
"allowAnyUserToBeCoHost": false,
"enabledJoinBeforeHost": false,
"enableConnectAudioBeforeHost": false,
"joinBeforeHostMinutes": 0,
"excludePassword": false,
"publicMeeting": false,
"reminderTime": 10,
"unlockedMeetingJoinSecurity": "allowJoin",
"sessionTypeId": 3,
"enableAutomaticLock": false,
"automaticLockMinutes": 0,
"allowFirstUserToBeCoHost": false,
"allowAuthenticatedDevices": false,
"telephony": {
"accessCode": "1234567890",
"callInNumbers": [
{
"label": "US Toll",
"callInNumber": "123456789",
"tollType": "toll"
}
],
"links": [
{
"rel": "globalCallinNumbers",
"href": "/api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers",
"method": "GET"
}
]
},
"meetingOptions": {
"enabledChat": true,
"enabledVideo": true,
"enabledPolling": false,
"enabledNote": true,
"noteType": "allowAll",
"enabledFileTransfer": false,
"enabledUCFRichMedia": false
},
"attendeePrivileges": {
"enabledShareContent": true,
"enabledSaveDocument": false,
"enabledPrintDocument": false,
"enabledAnnotate": false,
"enabledViewParticipantList": true,
"enabledViewThumbnails": false,
"enabledRemoteControl": true,
"enabledViewAnyDocument": false,
"enabledViewAnyPage": false,
"enabledContactOperatorPrivately": false,
"enabledChatHost": true,
"enabledChatPresenter": true,
"enabledChatOtherParticipants": true
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"scheduledType": "meeting",
"enabledBreakoutSessions": true,
"links": [
{
"rel": "breakoutSessions",
"href":"/v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions",
"method": "GET"
}
],
"trackingCodes": [
{
"name": "Department",
"value": "Engineering"
},
{
"name": "Division",
"value": "Full-time"
}
],
"enabledAudioWatermark": true,
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 10,
"audioConnectionOptions": {
"audioConnectionType": "VoIP",
"enabledTollFreeCallIn": false,
"enabledGlobalCallIn": false,
"enabledAudienceCallBack": false,
"entryAndExitTone": "beep",
"allowHostToUnmuteParticipants": false,
"allowAttendeeToUnmuteSelf": true,
"muteAttendeeUponEntry": false
},
"enabledLiveStream": true,
"liveStream": {
"destination": "Youtube",
"rtmpUrl": "rtmps://example.com:1935/MediaLive/WebexStreaming",
"streamUrl": "https://example.com/Webex-Streaming/index_a.m3u8",
"layoutWithoutSharedContent": "grid",
"layoutWithSharedContent": "stack",
"allowChangeLayoutInMeeting": false,
"followStageLayoutWhenSynced": true,
"resolution": "1920x1080"
}
},
{
"id": "870f51ff287b41be84648412901e0402_I_167427437874906709",
"meetingSeriesId": "870f51ff287b41be84648412901e0402",
"scheduledMeetingId": "870f51ff287b41be84648412901e0402_20191101T120000Z",
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"meetingType": "meeting",
"excludePassword": false,
"publicMeeting": false,
"enableAutomaticLock": false,
"sessionTypeId": 3,
"state": "ended",
"timezone": "UTC",
"start": "2019-11-01T12:12:15Z",
"end": "2019-11-01T12:51:33Z",
"hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"webLink": "https://site4-example.webex.com/site4/j.php?MTID=870f51ff287b41be84648412901e0402_I_167427437874906709",
"hasChat": true,
"hasRecording": true,
"hasTranscription": true,
"hasClosedCaption": true,
"hasPolls": true,
"hasQA": true,
"meetingOptions": {
"enabledChat": true,
"enabledVideo": true,
"enabledPolling": false,
"enabledNote": true,
"noteType": "allowAll",
"enabledFileTransfer": false,
"enabledUCFRichMedia": false
},
"attendeePrivileges": {
"enabledShareContent": true,
"enabledSaveDocument": false,
"enabledPrintDocument": false,
"enabledAnnotate": false,
"enabledViewParticipantList": true,
"enabledViewThumbnails": false,
"enabledRemoteControl": true,
"enabledViewAnyDocument": false,
"enabledViewAnyPage": false,
"enabledContactOperatorPrivately": false,
"enabledChatHost": true,
"enabledChatPresenter": true,
"enabledChatOtherParticipants": true
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"scheduledType": "meeting",
"enabledBreakoutSessions": true,
"links": [
{
"rel": "breakoutSessions",
"href":"/v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions",
"method": "GET"
}
],
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 10,
"audioConnectionOptions": {
"audioConnectionType": "webexAudio",
"enabledTollFreeCallIn": true,
"enabledGlobalCallIn": true,
"enabledAudienceCallBack": false,
"entryAndExitTone": "beep",
"allowHostToUnmuteParticipants": false,
"allowAttendeeToUnmuteSelf": true,
"muteAttendeeUponEntry": false
},
"enabledLiveStream": true,
"liveStream": {
"destination": "Youtube",
"rtmpUrl": "rtmps://example.com:1935/MediaLive/WebexStreaming",
"streamUrl": "https://example.com/Webex-Streaming/index_a.m3u8",
"layoutWithoutSharedContent": "grid",
"layoutWithSharedContent": "stack",
"allowChangeLayoutInMeeting": false,
"followStageLayoutWhenSynced": true,
"resolution": "1920x1080"
}
},
{
"id": "870f51ff287b41be84648412901e0402_20191102T120000Z",
"meetingSeriesId": "870f51ff287b41be84648412901e0402",
"meetingNumber": "123456789",
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"password": "BgJep@43",
"phoneAndVideoSystemPassword": "12345678",
"meetingType": "scheduledMeeting",
"state": "scheduled",
"isModified": false,
"timezone": "UTC",
"start": "2019-11-02T12:00:00Z",
"end": "2019-11-02T13:00:00Z",
"hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"hostKey": "123456",
"siteUrl": "site4-example.webex.com",
"webLink": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e",
"sipAddress": "123456789@site4-example.webex.com",
"dialInIpAddress": "192.168.100.100",
"enabledAutoRecordMeeting": false,
"allowAnyUserToBeCoHost": false,
"enabledJoinBeforeHost": false,
"enableConnectAudioBeforeHost": false,
"joinBeforeHostMinutes": 0,
"excludePassword": false,
"publicMeeting": false,
"reminderTime": 10,
"unlockedMeetingJoinSecurity": "allowJoin",
"sessionTypeId": 3,
"enableAutomaticLock": false,
"automaticLockMinutes": 0,
"allowFirstUserToBeCoHost": false,
"allowAuthenticatedDevices": false,
"telephony": {
"accessCode": "1234567890",
"callInNumbers": [
{
"label": "US Toll",
"callInNumber": "123456789",
"tollType": "toll"
}
],
"links": [
{
"rel": "globalCallinNumbers",
"href": "/api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers",
"method": "GET"
}
]
},
"meetingOptions": {
"enabledChat": true,
"enabledVideo": true,
"enabledPolling": false,
"enabledNote": true,
"noteType": "allowAll",
"enabledFileTransfer": false,
"enabledUCFRichMedia": false
},
"attendeePrivileges": {
"enabledShareContent": true,
"enabledSaveDocument": false,
"enabledPrintDocument": false,
"enabledAnnotate": false,
"enabledViewParticipantList": true,
"enabledViewThumbnails": false,
"enabledRemoteControl": true,
"enabledViewAnyDocument": false,
"enabledViewAnyPage": false,
"enabledContactOperatorPrivately": false,
"enabledChatHost": true,
"enabledChatPresenter": true,
"enabledChatOtherParticipants": true
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"scheduledType": "meeting",
"enabledBreakoutSessions": true,
"links": [
{
"rel": "breakoutSessions",
"href":"/v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions",
"method": "GET"
}
],
"trackingCodes": [
{
"name": "Department",
"value": "Engineering"
},
{
"name": "Division",
"value": "Full-time"
}
],
"enabledAudioWatermark": false,
"enabledVisualWatermark": false,
"audioConnectionOptions": {
"audioConnectionType": "webexAudio",
"enabledTollFreeCallIn": true,
"enabledGlobalCallIn": true,
"enabledAudienceCallBack": false,
"entryAndExitTone": "beep",
"allowHostToUnmuteParticipants": false,
"allowAttendeeToUnmuteSelf": true,
"muteAttendeeUponEntry": false
},
"enabledLiveStream": true,
"liveStream": {
"destination": "Youtube",
"rtmpUrl": "rtmps://example.com:1935/MediaLive/WebexStreaming",
"streamUrl": "https://example.com/Webex-Streaming/index_a.m3u8",
"layoutWithoutSharedContent": "grid",
"layoutWithSharedContent": "stack",
"allowChangeLayoutInMeeting": false,
"followStageLayoutWhenSynced": true,
"resolution": "1920x1080"
}
},
{
"id": "870f51ff287b41be84648412901e0402_I_167549011372279170",
"meetingSeriesId": "870f51ff287b41be84648412901e0402",
"scheduledMeetingId": "870f51ff287b41be84648412901e0402_20191101T120000Z",
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"meetingType": "meeting",
"state": "ended",
"excludePassword": false,
"publicMeeting": false,
"sessionTypeId": 3,
"enableAutomaticLock": false,
"timezone": "UTC",
"start": "2019-11-02T12:07:30Z",
"end": "2019-11-02T12:58:53Z",
"hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"webLink": "https://site4-example.webex.com/site4/j.php?MTID=870f51ff287b41be84648412901e0402_I_167549011372279170",
"hasChat": true,
"hasRecording": true,
"hasTranscription": true,
"hasClosedCaption": true,
"hasPolls": true,
"hasQA": true,
"meetingOptions": {
"enabledChat": true,
"enabledVideo": true,
"enabledPolling": false,
"enabledNote": true,
"noteType": "allowAll",
"enabledFileTransfer": false,
"enabledUCFRichMedia": false
},
"attendeePrivileges": {
"enabledShareContent": true,
"enabledSaveDocument": false,
"enabledPrintDocument": false,
"enabledAnnotate": false,
"enabledViewParticipantList": true,
"enabledViewThumbnails": false,
"enabledRemoteControl": true,
"enabledViewAnyDocument": false,
"enabledViewAnyPage": false,
"enabledContactOperatorPrivately": false,
"enabledChatHost": true,
"enabledChatPresenter": true,
"enabledChatOtherParticipants": true
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"scheduledType": "meeting",
"enabledBreakoutSessions": true,
"links": [
{
"rel": "breakoutSessions",
"href":"/v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions",
"method": "GET"
}
],
"enabledAudioWatermark": false,
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 10,
"audioConnectionOptions": {
"audioConnectionType": "webexAudio",
"enabledTollFreeCallIn": true,
"enabledGlobalCallIn": true,
"enabledAudienceCallBack": false,
"entryAndExitTone": "beep",
"allowHostToUnmuteParticipants": false,
"allowAttendeeToUnmuteSelf": true,
"muteAttendeeUponEntry": false
},
"enabledLiveStream": true,
"liveStream": {
"destination": "Youtube",
"rtmpUrl": "rtmps://example.com:1935/MediaLive/WebexStreaming",
"streamUrl": "https://example.com/Webex-Streaming/index_a.m3u8",
"layoutWithoutSharedContent": "grid",
"layoutWithSharedContent": "stack",
"allowChangeLayoutInMeeting": false,
"followStageLayoutWhenSynced": true,
"resolution": "1920x1080"
}
}
]
}