DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebarSidebar on Mobile
API Reference
BotsButtons and CardsIntegrationsBYODSService AppsService App GuestsService Apps G2GGuest IssuerWidgetsWebex ConnectLogin with WebexInstant ConnectInstant Connect Meeting LinksDeveloper SandboxBeta ProgramSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsCompliance
Webex APIs
Reference
Data Sources
Admin
OverviewAdmin APIsHybrid ServicesAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner Reports/TemplatesPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSettingsSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and AuthorizationMetadata and Samples
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsMetadata and SamplesBackground Images
Reference
Call ControlsCall RoutingCall Settings For MeCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsDevice Call SettingsDevicesEmergency Services SettingsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Operating ModesFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPartner Reports/TemplatesPeopleRecording ReportReportsReports: Detailed Call HistorySend Activation EmailUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for Wholesale
Overview
Guides
Developer's Guide
Reference
Wholesale Billing ReportsWholesale Provisioning
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Reference
Data Sources
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Directory Services
Reference
Domain ManagementIdentity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetings
POSTCreate a Meeting
GETGet a Meeting
GETList Meetings
PATCHPatch a Meeting
PUTUpdate a Meeting
DELETEDelete a Meeting
POSTJoin a Meeting
GETList Meeting Templates
GETGet a Meeting Template
GETGet Meeting Control Status
PUTUpdate Meeting Control Status
GETList Meeting Session Types
GETGet a Meeting Session Type
GETGet registration form for a meeting
PUTUpdate Meeting Registration Form
DELETEDelete Meeting Registration Form
POSTRegister a Meeting Registrant
POSTBatch register Meeting Registrants
GETGet Detailed Information for a Meeting Registrant
GETList Meeting Registrants
POSTQuery Meeting Registrants
POSTBatch Update Meeting Registrants status
DELETEDelete a Meeting Registrant
PUTUpdate Meeting Simultaneous interpretation
POSTCreate a Meeting Interpreter
GETGet a Meeting Interpreter
GETList Meeting Interpreters
PUTUpdate a Meeting Interpreter
DELETEDelete a Meeting Interpreter
GETList Meeting Breakout Sessions
PUTUpdate Meeting Breakout Sessions
DELETEDelete Meeting Breakout Sessions
GETGet a Meeting Survey
GETList Meeting Survey Results
POSTGet Meeting Survey Links
POSTCreate Invitation Sources
GETList Invitation Sources
GETList Meeting Tracking Codes
POSTReassign Meetings to a New Host
Meetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCall Settings For MeCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsData SourcesDevice Call SettingsDevice ConfigurationsDevicesDomain ManagementEmergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Operating ModesFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsIdentity OrganizationIssuesLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetings
POSTCreate a Meeting
GETGet a Meeting
GETList Meetings
PATCHPatch a Meeting
PUTUpdate a Meeting
DELETEDelete a Meeting
POSTJoin a Meeting
GETList Meeting Templates
GETGet a Meeting Template
GETGet Meeting Control Status
PUTUpdate Meeting Control Status
GETList Meeting Session Types
GETGet a Meeting Session Type
GETGet registration form for a meeting
PUTUpdate Meeting Registration Form
DELETEDelete Meeting Registration Form
POSTRegister a Meeting Registrant
POSTBatch register Meeting Registrants
GETGet Detailed Information for a Meeting Registrant
GETList Meeting Registrants
POSTQuery Meeting Registrants
POSTBatch Update Meeting Registrants status
DELETEDelete a Meeting Registrant
PUTUpdate Meeting Simultaneous interpretation
POSTCreate a Meeting Interpreter
GETGet a Meeting Interpreter
GETList Meeting Interpreters
PUTUpdate a Meeting Interpreter
DELETEDelete a Meeting Interpreter
GETList Meeting Breakout Sessions
PUTUpdate Meeting Breakout Sessions
DELETEDelete Meeting Breakout Sessions
GETGet a Meeting Survey
GETList Meeting Survey Results
POSTGet Meeting Survey Links
POSTCreate Invitation Sources
GETList Invitation Sources
GETList Meeting Tracking Codes
POSTReassign Meetings to a New Host
Meetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPSTNPartner ManagementPartner Reports/TemplatesPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSend Activation EmailSession TypesSettingsSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
Space Meetings Migration
Calling
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationCore ConceptsCalls
Advanced Features
Call SettingsContactsSupplementary ServicesVoicemailBackground Noise Reduction
Kitchen Sink
Meetings
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationJoin a MeetingMigration To Improved MeetingsPasswords & CaptchasUnified Space Meetings
Advanced Features
Advanced ControlsDialing In and OutStreams & EffectsVideo Resolution
Multistream
Multistream Comprehensive GuideMultistream Quickstart
Migrating SDK V2 to V3
iOSAndroidBrowserNode.jsClick to Call
Developer CommunityCertifications

Get a Meeting

Retrieves details for a meeting with a specified meeting ID.

  • If the meetingId value specified is for a meeting series and current is true, the operation returns details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series.

  • If the meetingId value specified is for a meeting series and current is false or current is not specified, the operation returns details for the entire meeting series.

  • If the meetingId value specified is for a scheduled meeting from a meeting series, the operation returns details for that scheduled meeting.

  • If the meetingId value specified is for a meeting instance which is happening or has happened, the operation returns details for that meeting instance.

  • trackingCodes is not supported for ended meeting instances.

  • 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 is UTC if not specified.

GET/v1/meetings/{meetingId}
URI Parameters
meetingId
stringrequired

Unique identifier for the meeting being requested.

Query Parameters
current
boolean

Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's true, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's false or not specified, return details for the entire meeting series. This parameter only applies to meeting series.

Default: false
hostEmail
string

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 will return details for a meeting that is hosted by that user.

Response Properties
id
string

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.

meetingNumber
string

Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.

title
string

Meeting title. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

agenda
string

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.

password
string

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.

phoneAndVideoSystemPassword
string

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.

meetingType
enum

Meeting type.

meetingSeries
string

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.

scheduledMeeting
string

Instance from a primary meeting series.

meeting
string

Meeting instance that is in progress or has completed.

state
enum

Meeting state.

active
string

Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.

scheduled
string

Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.

ready
string

Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.

lobby
string

Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.

inProgress
string

Applies to meeting series and meeting instances. For a meeting series, indicates that an instance of this series is happening now. For a meeting instance, indicates that the meeting has been joined and unlocked.

ended
string

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.

missed
string

This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.

expired
string

This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.

hostDidJoin
boolean

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.

attendeeDidJoin
boolean

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.

adhoc
boolean

If true, the meeting is ad-hoc.

timezone
string

Time zone of start and end, conforming with the IANA time zone database.

start
string

Start time for meeting in ISO 8601 compliant format. If the meetingType of this meeting is meetingSeries, and current is not specified or is false, start is the scheduled start time of the first occurrence of this series. If the meetingType of this meeting is meetingSeries, and current is not specified or is false, start is the scheduled start time of the first occurrence of this series. If the meetingType of this meeting is meetingSeries, and current is true, start is the scheduled start time of the ongoing or upcoming occurrence in this series. If the meetingType of this meeting is scheduledMeeting, start is the scheduled start time of this occurrence. If the meetingType of this meeting is meeting, start is the actual start time of this meeting instance. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

end
string

End time for a meeting in ISO 8601 compliant format. If the meeting is a meeting series, end is the date and time the first meeting of the series ends. If the meetingType of this meeting is meetingSeries, and current is not specified or is false, end is the scheduled end time of the first occurrence of this series. If the meetingType of this meeting is meetingSeries, and current is true, end is the scheduled end time of the ongoing or upcoming occurrence in this series. If the meetingType of this meeting is scheduledMeeting, end is the scheduled end time of this occurrence. If the meetingType of this meeting is meeting, end is the actual end time of this meeting instance. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

recurrence
string

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

hostUserId
string

Unique identifier for the meeting host.

hostDisplayName
string

Display name for the meeting host.

hostEmail
string

Email address for the meeting host.

hostKey
string

Key for joining the meeting as host.

siteUrl
string

Site URL for the meeting.

webLink
string

Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.

sipAddress
string

SIP address for callback from a video system.

dialInIpAddress
string

IP address for callback from a video system.

roomId
string

Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings.

enabledAutoRecordMeeting
boolean

Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

allowAnyUserToBeCoHost
boolean

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.

enabledJoinBeforeHost
boolean

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.

enableConnectAudioBeforeHost
boolean

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.

joinBeforeHostMinutes
number

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.

excludePassword
boolean

Whether or not to exclude the meeting password from the email invitation.

publicMeeting
boolean

Whether or not to allow the meeting to be listed on the public calendar.

reminderTime
number

The number of minutes before the meeting begins, that an email reminder is sent to the host.

unlockedMeetingJoinSecurity
enum

Specifies how the people who aren't on the invite can join the unlocked meeting.

allowJoin
string

If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.

allowJoinWithLobby
string

If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.

blockFromJoin
string

If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.

sessionTypeId
number

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.

scheduledType
enum

Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's personal room.

meeting
string

If the value of scheduledType attribute is meeting, it is a regular meeting.

webinar
string

If the value of scheduledType attribute is webinar, it is a webinar meeting.

personalRoomMeeting
string

If the value of scheduledType attribute is personalRoomMeeting, it is a meeting scheduled in the user's personal room.

enabledWebcastView
boolean

Whether or not webcast view is enabled.

panelistPassword
string

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.

phoneAndVideoSystemPanelistPassword
string

8-digit numeric panelist password to join a webinar meeting from audio and video devices.

enableAutomaticLock
boolean

Whether or not to automatically lock the meeting after it starts.

automaticLockMinutes
number

The number of minutes after the meeting begins, for automatically locking it.

allowFirstUserToBeCoHost
boolean

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.

allowAuthenticatedDevices
boolean

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.

hasChat
boolean

Whether or not this meeting instance has chat.

hasRecording
boolean

Whether or not this meeting instance has been recorded. true if the meeting instance has been recorded even if the recording has been deleted.

hasTranscription
boolean

Whether or not this meeting instance has a transcription.

hasClosedCaption
boolean

Whether or not this meeting instance has closed captions.

hasPolls
boolean

Whether or not this meeting instance has polls.

hasQA
boolean

Whether or not this meeting instance has Q&A.

hasRegistration
boolean

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.

hasRegistrants
boolean

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.

hasPostEventSurvey
boolean

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.

telephony
object

Information for callbacks from a meeting to phone or for joining a teleconference using a phone.

accessCode
string

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.

callInNumbers
array[object]

Array of call-in numbers for joining a teleconference from a phone.

label
string

Label for the call-in number.

Possible values: Call-in toll-free number (US/Canada)
callInNumber
string

Call-in number to join the teleconference from a phone.

Possible values: 123456789
tollType
enum

Type of toll for the call-in number.

toll
string
tollFree
string
links
object

HATEOAS information of global call-in numbers for joining a teleconference from a phone.

rel
string

Link relation describing how the target resource is related to the current context (conforming with RFC5998).

href
string

Target resource URI (conforming with RFC5998).

method
string

Target resource method (conforming with RFC5998).

meetingOptions
object

Meeting options.

enabledChat
boolean

Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.

enabledVideo
boolean

Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.

enabledPolling
boolean

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.

enabledNote
boolean

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.

noteType
enum

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.

allowAll
string

If the value of noteType attribute is allowAll, all participants can take notes.

allowOne
string

If the value of noteType attribute is allowOne, only a single note taker is allowed.

enabledFileTransfer
boolean

Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.

enabledUCFRichMedia
boolean

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.

attendeePrivileges
object

Attendee Privileges. This attribute is not supported for a webinar.

enabledShareContent
boolean

Whether or not to allow any attendee to share content in the meeting.

enabledSaveDocument
boolean

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.

enabledPrintDocument
boolean

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.

enabledAnnotate
boolean

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.

enabledViewParticipantList
boolean

Whether or not to allow any attendee to view participants.

enabledViewThumbnails
boolean

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.

enabledRemoteControl
boolean

Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.

enabledViewAnyDocument
boolean

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.

enabledViewAnyPage
boolean

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.

enabledContactOperatorPrivately
boolean

Whether or not to allow any attendee to contact the operator privately.

enabledChatHost
boolean

Whether or not to allow any attendee to chat with the host in private.

enabledChatPresenter
boolean

Whether or not to allow any attendee to chat with the presenter in private.

enabledChatOtherParticipants
boolean

Whether or not to allow any attendee to chat with other participants in private.

registration
object

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 the Join Before Host option is enabled for the meeting. See Register for a Meeting in Cisco Webex Meetings for details.

autoAcceptRequest
boolean

Whether or not meeting registration requests are accepted automatically.

requireFirstName
boolean

Whether or not a registrant's first name is required for meeting registration.

requireLastName
boolean

Whether or not a registrant's last name is required for meeting registration.

requireEmail
boolean

Whether or not a registrant's email is required for meeting registration.

requireJobTitle
boolean

Whether or not a registrant's job title is required for meeting registration.

requireCompanyName
boolean

Whether or not a registrant's company name is required for meeting registration.

requireAddress1
boolean

Whether or not a registrant's first address field is required for meeting registration.

requireAddress2
boolean

Whether or not a registrant's second address field is required for meeting registration.

requireCity
boolean

Whether or not a registrant's city is required for meeting registration.

requireState
boolean

Whether or not a registrant's state is required for meeting registration.

requireZipCode
boolean

Whether or not a registrant's postal code is required for meeting registration.

requireCountryRegion
boolean

Whether or not a registrant's country or region is required for meeting registration.

requireWorkPhone
boolean

Whether or not a registrant's work phone number is required for meeting registration.

requireFax
boolean

Whether or not a registrant's fax number is required for meeting registration.

maxRegisterNum
number

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.

enabledRegistrationId
boolean

If true, generate random ID authentication for each registrant. Webinars only.

integrationTags
array[string]

External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc.

simultaneousInterpretation
object

Simultaneous interpretation information for the meeting.

enabled
boolean

Whether or not simultaneous interpretation is enabled.

interpreters
array[InterpreterObjectForSimultaneousInterpretationOfGetOrListMeeting]

Interpreters for meeting.

id
string

Unique identifier for meeting interpreter.

languageCode1
string

Forms a set of simultaneous interpretation channels together with languageCode2. Standard language format from ISO 639-1 code. Read ISO 639-1 for details.

languageCode2
string

Forms a set of simultaneous interpretation channels together with languageCode1. Standard language format from ISO 639-1 code. Read ISO 639-1 for details.

email
string

Email address of meeting interpreter.

displayName
string

Display name of meeting interpreter.

trackingCodes
array[TrackingCodeItemForGetMeetingObject]

Tracking codes information.

name
string

Name for the tracking code.

value
string

Value for the tracking code.

enabledAudioWatermark
boolean

Whether or not the audio watermark is enabled.

enabledVisualWatermark
boolean

Whether or not the visual watermark is enabled.

visualWatermarkOpacity
number

Opacity level for visual watermark.

audioConnectionOptions
object

Audio connection options.

audioConnectionType
enum

Choose how meeting attendees join the audio portion of the meeting.

webexAudio
string

Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.

VoIP
string

Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.

other
string

Other teleconference services.

none
string

The way of attendees join the audio portion of the meeting is the default value.

enabledTollFreeCallIn
boolean

Whether or not to show toll-free call-in numbers.

enabledGlobalCallIn
boolean

Whether or not to show global call-in numbers to attendees.

enabledAudienceCallBack
boolean

Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.

entryAndExitTone
enum

Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.

beep
string

All call-in users joining the meeting will hear the beep.

announceName
string

All call-in users joining the meeting will hear their names.

noTone
string

Turn off beeps and name announcements.

allowHostToUnmuteParticipants
boolean

Whether or not to allow the host to unmute participants.

allowAttendeeToUnmuteSelf
boolean

Whether or not to allow attendees to unmute themselves.

muteAttendeeUponEntry
boolean

Whether or not to auto-mute attendees when attendees enter meetings.

requireAttendeeLogin
boolean

Require attendees to sign in before joining the webinar.

restrictToInvitees
boolean

Restrict webinar to invited attendees only.

enabledLiveStream
boolean

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.

liveStream
LiveStreamObject

Live streaming settings. Applies when enabledLiveStream is true.

destination
string

A descriptive text to describe the destination of the live streaming.

rtmpUrl
string

Live streaming RTMP URL.

streamUrl
string

The URL to view the live streaming, i.e. the playback URL.

layoutWithoutSharedContent
enum

Live streaming layout when there's no shared content.

grid
string

The video layout that allows you to see multiple participants in a meeting in grids.

stack
string

The video layout that displays the active speaker on the stage and up to six participants in thumbnails across the top.

focus
string

The video layout that only displays the active speaker.

layoutWithSharedContent
enum

Live streaming layout when there's shared content.

stack
string

The video layout that displays the shared content on the stage and up to six participants in thumbnails across the top.

focusedContentWithActiveSpeaker
string

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.

focusedContent
string

The layout that only displays the shared content in the main part of the screen and does not display the participants.

allowChangeLayoutInMeeting
boolean

Whether or not to allow change the live streaming layout in the meeitng.

followStageLayoutWhenSynced
boolean

Whether or not to follow the stage layout when it's being synchronized.

resolution
string

Resolution of the live streaming.

Response Codes

The list below describes the common success and error responses you should expect from the API:

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
GET
/v1/meetings/{?current,hostEmail}
Log in to try the API.
Header
Query Parameters
  • Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to 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 will return details for a meeting that is hosted by that user.
  • Request
  • Response
https://webexapis.com/v1/meetings/25bbf831-5be9-4c25-b4b0-9b592c8a086b?current=false&hostEmail=john.andersen@example.com
200 / OK
{
    "id": "870f51ff287b41be84648412901e0402",
    "meetingNumber": "123456789",
    "title": "Example Daily Meeting",
    "agenda": "Example Agenda",
    "password": "BgJep@43",
    "phoneAndVideoSystemPassword": "12345678",
    "meetingType": "meetingSeries",
    "state": "active",
    "timezone": "UTC",
    "start": "2019-11-01T12:00:00Z",
    "end": "2019-11-01T13:00:00Z",
    "recurrence": "FREQ=DAILY;COUNT=10;INTERVAL=1",
    "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",
    "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
    },
    "registration": {
        "autoAcceptRequest": false,
        "requireFirstName": true,
        "requireLastName": true,
        "requireEmail": true,
        "requireJobTitle": false,
        "requireCompanyName": true,
        "requireAddress1": false,
        "requireAddress2": false,
        "requireCity": false,
        "requireState": false,
        "requireZipCode": false,
        "requireCountryRegion": true,
        "requireWorkPhone": true,
        "requireFax": false,
        "enabledRegistrationId": false,
        "customizedQuestions": [
            {
                "id": "3386787",
                "question": "What color do you like?",
                "required": true,
                "type": "checkbox",
                "options": [
                    {
                        "id": "1",
                        "value": "green"
                    },
                    {
                        "id": "2",
                        "value": "black"
                    },
                    {
                        "id": "3",
                        "value": "yellow"
                    },
                    {
                        "id": "4",
                        "value": "red"
                    }
                ],
                "rules": [
                    {
                        "condition": "notEquals",
                        "value": "red",
                        "result": "reject",
                        "matchCase": true,
                        "order": 2
                    }
                ]
            },
            {
                "id": "3386792",
                "question": "Project Team",
                "required": false,
                "type": "singleLineTextBox",
                "maxLength": 120
            },
            {
                "id": "3386797",
                "question": "How are you",
                "required": false,
                "type": "multiLineTextBox",
                "maxLength": 999
            },
            {
                "id": "3386802",
                "question": "Dropdownlist Q",
                "required": false,
                "type": "dropdownList",
                "options": [
                    {
                        "id": "1",
                        "value": "A1"
                    },
                    {
                        "id": "2",
                        "value": "A2"
                    }
                ]
            },
            {
                "question": "weather",
                "required": false,
                "type": "radioButtons",
                "maxLength": 120,
                "options": [
                    {
                        "id": "1",
                        "value": "sunny"
                    },
                    {
                        "id": "2",
                        "value": "rain"
                    }
                ]
            }
        ],
        "rules": [
            {
                "question": "lastName",
                "condition": "endsWith",
                "value": "tom",
                "result": "reject",
                "matchCase": false,
                "order": 1
            }
        ]
    },
    "integrationTags": [
        "dbaeceebea5c4a63ac9d5ef1edfe36b9",
        "85e1d6319aa94c0583a6891280e3437d",
        "27226d1311b947f3a68d6bdf8e4e19a1"
    ],
    "scheduledType": "meeting",
    "simultaneousInterpretation": {
        "enabled": true,
        "interpreters": [
            {
                "id": "OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM",
                "languageCode1": "en",
                "languageCode2": "de",
                "email": "marcus.hoffmann@example.com",
                "displayName": "Hoffmann"
            },
            {
                "id": "3GQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MAJiZDBjNWVlNDC4YjgxMTZlMjU4Zjg2NWIzZmM",
                "languageCode1": "en",
                "languageCode2": "fr",
                "email": "antoine.martin@example.com",
                "displayName": "Martin"
            }
        ]
    },
    "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"
    }
}

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2025 Cisco and/or its affiliates. All rights reserved.