Webex Meetings REST API

The new Webex Meetings REST API enables seamless integration of Cisco Webex Meetings into your websites, apps, and services. Schedule meetings, invite meeting attendees, update preferences, and more.

Webex Meetings

Webex Meetings offers integrated audio, video, and content sharing with highly secure web meetings from the cloud. The Webex Meetings REST API allows developers to add basic Webex scheduling functionality to their custom applications or websites. You can:

More APIs are on the way! Watch our blog for announcements.

anchorCreating and Using Webex Apps
anchor

The base URL for the Webex REST API is https://webexapis.com/v1/. Detailed information about each API resource and endpoint can be found in the API Reference.

The Meetings-related APIs can be used with Webex Integrations. If you aren't familiar with integrations, check out the Integrations Guide for more information. To create a new integration, select My Webex Teams Apps from the menu under your avatar at the top of this page to get started.

To use the Webex REST API you'll need to be a Webex Meetings subscriber with a Webex account backed by Cisco Webex Common Identity (CI). If you currently use Webex Teams, your account is backed by Common Identity. If you're using only Webex Meetings, your site will need to be on Common Identity.

anchorUser Authentication and Scopes
anchor

Webex REST API authentication is described in detail in the Integrations Guide. The following scopes are required to use the Meetings-related API resources:

Scope
Usage
meeting:schedules_read
Retrieve your Webex meeting lists and details
meeting:schedules_write
Create, manage, or cancel your scheduled Webex meetings
meeting:recordings_read
Retrieve your Webex meeting recordings for playback
meeting:recordings_write
Manage or delete your meeting recordings for playback
meeting:preferences_read
Retrieve your Webex meeting preferences
meeting:preferences_write
Edit your Webex meeting preferences

Remember, when choosing scopes for your app, only select the scopes your application will need.

anchorMeeting Series, Scheduled Meetings, and Meeting Instances
anchor

When using the Meetings and Meeting Invitees API resources, it's important to understand the difference between "meeting series", "scheduled meetings", and "meetings" objects. Each of these objects may be sent to or received from the API. To differentiate them, the value of the meetingType attribute in the object will be one of:

  • meetingSeries – a container object that includes all of the scheduling information for a meeting
  • scheduledMeeting – an object that represents the information associated with the scheduling information associated with a single instance of a meeting; a scheduledMeeting object can be thought of as a “child” of a meetingSeries object
  • meeting – an object that represents a meeting that is currently happening or has happened in the past; this object is created only when a meeting starts

Both meeting series and scheduled meetings may be used with the API. For example, to invite an attendee to the series, use the ID of the meeting series with the Create a Meeting Invitee endpoint. Or, to invite someone to just one scheduled instance of a meeting, use the ID of the scheduled meeting instead.

anchorMeeting States
anchor

Different meeting states are available for each type of meeting object. See "Meeting Series, Scheduled Meetings, and Meeting Instances" above for more detail.

Meeting Series
  • active – one or more future scheduled meetings exists for this series
  • inProgress – an instance of this meeting series is happening now
  • expired – all scheduled instances of this meeting have passed
Scheduled Meeting
  • scheduled – this meeting is scheduled in the future
  • ready – this meeting is ready to start
  • ended – this meeting was started and is now over
  • missed – this meeting was scheduled in the past but never happened
Meeting
  • lobby – a locked meeting has been joined by participants, but no hosts have joined
  • inProgress – the meeting has been joined and unlocked
  • ended – a meeting has concluded