Webex Meetings
The Webex Meetings APIs enable developers to schedule, manage, and retrieve information about Webex meetings, webinars, and events. They provide endpoints for…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Webex Meetings APIs enable developers to schedule, manage, and retrieve information about Webex meetings, webinars, and events. They provide endpoints for meeting creation, participant management, recordings, transcripts, in-meeting features such as chat and closed captions, and post-meeting analytics. Common use cases include integrating meeting scheduling into calendar apps, automating follow-ups with recordings and transcripts, embedding meeting controls in custom portals, and extracting insights for compliance or productivity analysis. The APIs support both real-time and asynchronous workflows for seamless collaboration.
Endpoints 171
slidoSecurePremium
- GETList Compliance Events
/slido/compliance/events?sessionOrgId=a1111111-1a11-111a-1a11-1a1111a1111a&sessionId=abcdef0123456789abcdef0123456789_I_000000000000000000Lists events representing actions that occurred during a Slido Secure Premium session (creating a poll, modifying a poll, activating a poll, posting an…
Chats
- GETList Meeting Chats
/meetings/postMeetingChats?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044Lists the meeting chats of a finished meeting instance specified by meetingId. You can set a maximum number of chats to return. Use this operation to list the… - DELETEDelete Meeting Chats
/meetings/postMeetingChats?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044Deletes the meeting chats of a finished meeting instance specified by meetingId. Use this operation to delete the chats of a finished meeting instance when…
Closed Captions
- GETList Meeting Closed Captions
/meetingClosedCaptions?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044Lists closed captions of a finished meeting instance specified by meetingId. * Closed captions are ready 15 minutes after the meeting is finished. * Only… - GETList Meeting Closed Caption Snippets
/meetingClosedCaptions/:closedCaptionId/snippets?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044Lists snippets of a meeting closed caption specified by closedCaptionId. - GETDownload Meeting Closed Caption Snippets
/meetingClosedCaptions/:closedCaptionId/download?meetingId=870f51ff287b41be84648412901e0402_I_167427437874906709Download meeting closed caption snippets from the meeting closed caption specified by closedCaptionId formatted either as a Video Text Track (.vtt) file or…
Invitees
- GETList Meeting Invitees
/meetingInvitees?meetingId=870f51ff287b41be84648412901e0402Lists meeting invitees for a meeting with a specified meetingId. You can set a maximum number of invitees to return. This operation can be used for meeting… - POSTCreate a Meeting Invitee
/meetingInvitees* Invite a person to attend a meeting. * Identify the invitee in the request body, by email address. * The sendEmail parameter is true by default and the… - POSTCreate Meeting Invitees
/meetingInvitees/bulkInsert* Invite people to attend a meeting in bulk. * Identify each invitee by the email address of each item in the items of the request body. * Each invitee should… - GETGet a Meeting Invitee
/meetingInvitees/:meetingInviteeIdRetrieve details for a meeting invitee identified by a meetingInviteeId in the URI. - PUTUpdate a Meeting Invitee
/meetingInvitees/:meetingInviteeIdUpdate details for a meeting invitee identified by a meetingInviteeId in the URI. - DELETEDelete a Meeting Invitee
/meetingInvitees/:meetingInviteeIdRemoves a meeting invitee identified by a meetingInviteeId specified in the URI. The deleted meeting invitee cannot be recovered. If the meeting invitee is…
Messages
- DELETEDelete a Meeting Message
/meeting/messages/:meetingMessageIdDeletes a Meeting Message from the In Meeting Chat, using its ID. This ID can be retrieved by a Compliance Officer using the events API filtering on the…
Participants
- GETList Meeting Participants
/meetingParticipants?meetingId=560d7b784f5143e3be2fc3064a5c4999List all participants in an in-progress meeting or an ended meeting. The meetingId parameter is required, which is the unique identifier for the meeting. The… - POSTQuery Meeting Participants with Email
/meetingParticipants/query?meetingId=560d7b784f5143e3be2fc3064a5c4999Query participants in a live meeting, or after the meeting, using participant's email. The meetingId parameter is the unique identifier for the meeting and is… - GETGet Meeting Participant Details
/meetingParticipants/:participantIdGet a meeting participant details of a live or post meeting. The participantId is required to identify the meeting and the participant. The authenticated user… - PUTUpdate a Participant
/meetingParticipants/:participantIdMute, un-mute, expel, or admit a participant in a live meeting. The participantId is required to identify the meeting and the participant. Notes: * The owner… - POSTAdmit Participants
/meetingParticipants/admitTo admit participants into a live meeting or its breakout sessions in bulk. If breakoutSessionId is null for all the requested participants, they are admitted… - POSTCall Out a SIP Participant
/meetingParticipants/calloutInitiate a call to a SIP participant to join a meeting. If a user invoking the API is not a Service App, the user must join the meeting before invoking the… - POSTCancel Calling Out a SIP Participant
/meetingParticipants/cancelCalloutCancel the call to a SIP participant before the ringing on the invited SIP device stops. The ringing on the invited SIP device stops in 30 seconds if there is…
Meeting Polls
- GETList Meeting Polls
/meetings/polls?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044Lists all the polls and the poll questions in a meeting when ready. * Only meeting instances in state ended or inProgress are supported for meetingId. * No… - GETGet Meeting PollResults
/meetings/pollResults?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044List the meeting polls, the poll's questions, and answers from the meeting when ready. * Only meeting instances in state ended or inProgress are supported for… - GETList Respondents of a Question
/meetings/polls/:pollId/questions/:questionId/respondents?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044Lists the respondents to a specific questions in a poll. * Only meeting instances in state ended or inProgress are supported for meetingId. * Long result sets…
Preferences
- GETGet Meeting Preference Details
/meetingPreferencesRetrieves meeting preferences for the authenticated user. - GETGet Personal Meeting Room Options
/meetingPreferences/personalMeetingRoomRetrieves the Personal Meeting Room options for the authenticated user. - PUTUpdate Personal Meeting Room Options
/meetingPreferences/personalMeetingRoomUpdates Personal Meeting Room options for the authenticated user. - GETGet Audio Options
/meetingPreferences/audioRetrieves audio options for the authenticated user. - PUTUpdate Audio Options
/meetingPreferences/audioUpdates audio options for the authenticated user. - GETGet Video Options
/meetingPreferences/videoRetrieves video options for the authenticated user. - PUTUpdate Video Options
/meetingPreferences/videoUpdates video options for the authenticated user. - GETGet Scheduling Options
/meetingPreferences/schedulingOptionsRetrieves scheduling options for the authenticated user. - PUTUpdate Scheduling Options
/meetingPreferences/schedulingOptionsUpdates scheduling options for the authenticated user. * If delegateEmails is null or not specified, the user's delegate emails are not changed. If… - POSTInsert Delegate Emails
/meetingPreferences/schedulingOptions/delegateEmails/insertInsert delegate emails for the authenticated user. - POSTDelete Delegate Emails
/meetingPreferences/schedulingOptions/delegateEmails/deleteDelete delegate emails for the authenticated user. - GETGet Site List
/meetingPreferences/sitesRetrieves the list of Webex sites that the authenticated user is set up to use. When the admin tries to get the site list via userEmail, if siteUrl is not… - PUTUpdate Default Site
/meetingPreferences/sites?defaultSite=trueUpdates the default site for the authenticated user. - POSTBatch Refresh Personal Meeting Room ID
/admin/meetingPreferences/personalMeetingRoom/refreshIdRefreshes personal room IDs automatically according to the current personal room ID rule of the target site or by the values specified by the admin user. The…
Meeting Q and A
- GETList Meeting Q and A
/meetings/q_and_a?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044Lists questions and answers from a meeting, when ready. Notes: * Only meeting instances in state ended or inProgress are supported for meetingId. * Long… - GETList Answers of a Question
/meetings/q_and_a/:questionId/answers?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044Lists the answers to a specific question asked in a meeting. * Only meeting instance in state ended or inProgress are supported for meetingId. * Long result…
Meeting Qualities
- GETGet Meeting Qualities
/meeting/qualities?meetingId=e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470Get quality data for a meeting, by meetingId. Only organization administrators can retrieve meeting quality data.
Session Types
- GETList Site Session Types
/admin/meeting/config/sessionTypesList session types for a specific site. - GETList User Session Type
/admin/meeting/userconfig/sessionTypesList session types for a specific user. - PUTUpdate User Session Types
/admin/meeting/userconfig/sessionTypesAssign session types to specific users. * At least one of the following body parameters is required to update a specific user session type: personId, email.
Summaries
- GETGet Summary by Meeting ID
/meetingSummariesGet the summary of an ended meeting instance by the meeting ID. Please note that only meeting instances in state ended are supported, and currently the… - GETGet Summary For Compliance Officer
/admin/meetingSummariesLists available or deleted summaries of an ended meeting instance by meeting ID. This API can only be accessed by compliance officers. With this API, a… - DELETEDelete a Summary
/meetingSummaries/:summaryIdRemoves a summary with a specified summary ID. The deleted summary cannot be recovered. A deleted summary can not be accessed by regular users, i.e. host or…
Transcripts
- GETList Meeting Transcripts
/meetingTranscriptsLists available transcripts of an ended meeting instance. Use this operation to list transcripts of an ended meeting instance when they are ready. Please note… - GETList Meeting Transcripts For Compliance Officer
/admin/meetingTranscripts?siteUrl=example.webex.comLists available or deleted transcripts of an ended meeting instance for a specific site. The returned list is sorted in descending order by the date and time… - GETDownload a Meeting Transcript
/meetingTranscripts/:transcriptId/downloadDownload a meeting transcript from the meeting transcript specified by transcriptId. - GETList Snippets of a Meeting Transcript
/meetingTranscripts/:transcriptId/snippetsLists snippets of a meeting transcript specified by transcriptId. Use this operation to list snippets of a meeting transcript when they are ready. - GETGet a Transcript Snippet
/meetingTranscripts/:transcriptId/snippets/:snippetIdRetrieves details for a transcript snippet specified by snippetId from the meeting transcript specified by transcriptId. - PUTUpdate a Transcript Snippet
/meetingTranscripts/:transcriptId/snippets/:snippetIdUpdates details for a transcript snippet specified by snippetId from the meeting transcript specified by transcriptId. - DELETEDelete a Transcript
/meetingTranscripts/:transcriptIdRemoves a transcript with a specified transcript ID. The deleted transcript cannot be recovered. If a Compliance Officer deletes another user's transcript,…
Meetings Summary Report
- GETList Meeting Usage Reports
/meetingReports/usage?siteUrl=example.webex.comList meeting usage reports of all the users on the specified site by an admin. You can specify a date range and the maximum number of meeting usage reports to… - GETList Meeting Attendee Reports
/meetingReports/attendees?siteUrl=example.webex.comLists of meeting attendee reports by a date range, the maximum number of meeting attendee reports, a meeting ID, a meeting number or a meeting title. If the…
Meetings
- GETGet a Meeting By an Admin
/admin/meetings/:meetingIdRetrieves details for a meeting with a specified meeting ID by an admin. The following sensitive attributes are hidden from the response: agenda, hostKey,… - GETList Meetings By an Admin
/admin/meetingsRetrieves details for meetings by an admin with a specified meeting number or web link. Please note that there are various products in the Webex Suite such as… - GETList Group Meetings
/group/meetingsList group meetings with a specified meeting number or web link by a service app which has group meeting access. You can specify the personId parameter or… - PATCHPatch a Group Meeting
/group/meetings/:meetingIdPatches details for a group meeting with a specified meeting ID by a service app which has group meeting access. This operation applies to meeting series and… - POSTUpdate Group Meeting Control Status
/group/meetings/controlsUpdate meeting recording control status by a service app which has group meeting access. The service app can use this API to start, stop, pause, or resume… - GETList Meetings
/meetings<div><Callout type="info">The previous List Meetings of a Meeting Series API is merged into the List Meetings API.</Callout></div> Retrieves details for… - POSTCreate a Meeting
/meetingsCreates a new meeting. Regular users can schedule up to 100 meetings in 24 hours and admin users up to 3000 overall or 800 for a single user. Please note that… - GETGet a Meeting
/meetings/:meetingIdRetrieves 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… - PUTUpdate a Meeting
/meetings/:meetingId<div> <Callout type="warning">The PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method… - DELETEDelete a Meeting
/meetings/:meetingId<div> <Callout type="warning">If only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains inProgress… - PATCHPatch a Meeting
/meetings/:meetingId<div> <Callout type="warning">If only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains inProgress… - POSTJoin a Meeting
/meetings/joinRetrieves links for a meeting with a specified meetingId, meetingNumber, or webLink that allow users to start or join the meeting directly without logging in… - GETList Meeting Templates
/meetings/templatesRetrieves the list of meeting templates that is available for the authenticated user. There are separate lists of meeting templates for different… - GETGet a Meeting Template
/meetings/templates/:templateIdRetrieves details for a meeting template with a specified meeting template ID. Request Header * timezone: Time zone for time stamps in response body, defined… - GETGet Meeting Control Status
/meetings/controls?meetingId=560d7b784f5143e3be2fc3064a5c4999Get the meeting control of a live meeting, which is consisted of meeting control status on "locked" and "recording" to reflect whether the meeting is… - PUTUpdate Meeting Control Status
/meetings/controls?meetingId=560d7b784f5143e3be2fc3064a5c4999To start, pause, resume, or stop a meeting recording; To lock or unlock an on-going meeting. - GETList Meeting Session Types
/meetings/sessionTypesList all the meeting session types enabled for a given user. - GETGet a Meeting Session Type
/meetings/sessionTypes/:sessionTypeIdRetrieves details for a meeting session type with a specified session type ID. - GETGet registration form for a meeting
/meetings/:meetingId/registrationGet a meeting's registration form to understand which fields are required. - PUTUpdate Meeting Registration Form
/meetings/:meetingId/registrationEnable or update a registration form for a meeting. - DELETEDelete Meeting Registration Form
/meetings/:meetingId/registrationDisable the registration form for a meeting. - GETList Meeting Registrants
/meetings/:meetingId/registrantsMeeting's host and cohost can retrieve the list of registrants for a meeting with a specified meeting Id. - POSTRegister a Meeting Registrant
/meetings/:meetingId/registrantsRegister a new registrant for a meeting. When a meeting or webinar is created, this API can only be used if Registration is checked on the page or the… - POSTBatch register Meeting Registrants
/meetings/:meetingId/registrants/bulkInsertBulk register new registrants for a meeting. When a meeting or webinar is created, this API can only be used if Registration is checked on the page or the… - GETGet Detailed Information for a Meeting Registrant
/meetings/:meetingId/registrants/:registrantIdRetrieves details for a meeting registrant with a specified registrant Id. - DELETEDelete a Meeting Registrant
/meetings/:meetingId/registrants/:registrantIdMeeting's host or cohost can delete a registrant with a specified registrant ID. - POSTQuery Meeting Registrants
/meetings/:meetingId/registrants/queryMeeting's host and cohost can query the list of registrants for a meeting with a specified meeting ID and registrants email. - POSTBatch Approve Meeting Registrants
/meetings/:meetingId/registrants/approveBatch approve a set of registrants for a meeting by the meeting host or cohost. - POSTBatch Reject Meeting Registrants
/meetings/:meetingId/registrants/rejectBatch reject a set of registrants for a meeting by the meeting host or cohost. - POSTBatch Cancel Meeting Registrants
/meetings/:meetingId/registrants/cancelBatch cancel a set of registrants for a meeting by the meeting host or cohost. - POSTBatch Delete Meeting Registrants
/meetings/:meetingId/registrants/bulkDeleteBatch delete a set of registrants for a meeting by the meeting host or cohost. - PUTUpdate Meeting Simultaneous interpretation
/meetings/:meetingId/simultaneousInterpretationUpdates simultaneous interpretation options of a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It… - GETList Meeting Interpreters
/meetings/:meetingId/interpretersLists meeting interpreters for a meeting with a specified meetingId. This operation can be used for meeting series, scheduled meeting and ended or ongoing… - POSTCreate a Meeting Interpreter
/meetings/:meetingId/interpretersAssign an interpreter to a bi-directional simultaneous interpretation language channel for a meeting. - GETGet a Meeting Interpreter
/meetings/:meetingId/interpreters/:interpreterIdRetrieves details for a meeting interpreter identified by meetingId and interpreterId in the URI. - PUTUpdate a Meeting Interpreter
/meetings/:meetingId/interpreters/:interpreterIdUpdates details for a meeting interpreter identified by meetingId and interpreterId in the URI. - DELETEDelete a Meeting Interpreter
/meetings/:meetingId/interpreters/:interpreterIdRemoves a meeting interpreter identified by meetingId and interpreterId in the URI. The deleted meeting interpreter cannot be recovered. - GETList Meeting Breakout Sessions
/meetings/:meetingId/breakoutSessionsLists meeting breakout sessions for a meeting with a specified meetingId. This operation can be used for meeting series, scheduled meeting and ended or… - PUTUpdate Meeting Breakout Sessions
/meetings/:meetingId/breakoutSessionsUpdates breakout sessions of a meeting with a specified meeting ID in the pre-meeting state. This operation applies to meeting series and scheduled meetings. - DELETEDelete Meeting Breakout Sessions
/meetings/:meetingId/breakoutSessionsDeletes breakout sessions with a specified meeting ID. The deleted breakout sessions cannot be recovered. The value of enabledBreakoutSessions attribute is… - GETGet a Meeting Survey
/meetings/:meetingId/surveyRetrieves details for a meeting survey identified by meetingId. Request Header * hostEmail: Email address for the meeting host. This parameter is only used if… - GETList Meeting Survey Results
/meetings/:meetingId/surveyResultsRetrieves results for a meeting survey identified by meetingId. Request Header * timezone: Time zone for time stamps in response body, defined in conformance… - POSTGet Meeting Survey Links
/meetings/:meetingId/surveyLinksGet survey links of a meeting for different users. Request Header * timezone: Time zone for the meetingStartTimeFrom and meetingStartTimeTo parameters and… - GETList Invitation Sources
/meetings/:meetingId/invitationSourcesLists invitation sources for a meeting. Request Header * hostEmail: Email address for the meeting host. This parameter is only used if the user or application… - POSTCreate Invitation Sources
/meetings/:meetingId/invitationSourcesCreates one or more invitation sources for a meeting. - GETList Meeting Tracking Codes
/meetings/trackingCodes?service=MeetingCenterLists tracking codes on a site by a meeting host. The result indicates which tracking codes and what options can be used to create or update a meeting on the… - POSTReassign Meetings to a New Host
/meetings/reassignHostReassigns a list of meetings to a new host by an admin user. All the meetings of meetingIds should belong to the same site, which is the siteUrl in the… - POSTEnd a Meeting
/meetings/:meetingId/endEnds a meeting with a specified meeting ID. This operation applies to meeting series, scheduled meetings, and in-progress meetings. Only the meeting host,…
Tracking Codes
- GETList Tracking Codes
/admin/meeting/config/trackingCodesLists tracking codes on a site by an admin user. * If siteUrl is specified, tracking codes of the specified site will be listed; otherwise, tracking codes of… - POSTCreate a Tracking Code
/admin/meeting/config/trackingCodesCreate a new tracking code by an admin user. * The siteUrl is required. The operation creates a tracking code for the specified site. All or a user's… - GETGet a Tracking Code
/admin/meeting/config/trackingCodes/:trackingCodeIdRetrieves details for a tracking code by an admin user. * If siteUrl is specified, the tracking code is retrieved from the specified site; otherwise, the… - PUTUpdate a Tracking Code
/admin/meeting/config/trackingCodes/:trackingCodeIdUpdates details for a tracking code by an admin user. * The siteUrl is required. The operation updates a tracking code for the specified site. All of a user's… - DELETEDelete a Tracking Code
/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=example.webex.comDeletes a tracking code by an admin user. * The siteUrl is required. The operation deletes a tracking code for the specified site. All of a user's available… - GETGet User Tracking Codes
/admin/meeting/userconfig/trackingCodesLists user's tracking codes by an admin user. * At least one parameter, either personId, or email is required. personId must come before email if both are… - PUTUpdate User Tracking Codes
/admin/meeting/userconfig/trackingCodesUpdates tracking codes for a specified user by an admin user. * The siteUrl is required. The operation updates a user's tracking code on the specified site.…
People
- GETList People
/peopleList people in your organization. For most users, either the email or displayName parameter is required. Admin users can omit these fields and list all users… - POSTCreate a Person
/peopleCreate a new user account for a given organization. Only an admin can create a new user account. At least one of the following body parameters is required to… - GETGet Person Details
/people/:personIdShows details for a person, by ID. Response properties associated with a user's presence status, such as status or lastActivity, will only be displayed for… - PUTUpdate a Person
/people/:personIdUpdate details for a person, by ID. Specify the person ID in the personId parameter in the URI. Only an admin can update a person details. Include all details… - DELETEDelete a Person
/people/:personIdRemove a person from the system. Required Administrator Roles: The following administrators have permission to use this API: Customer Organization: Full… - GETGet My Own Details
/people/meGet profile details for the authenticated user. This is the same as GET /people/{personId} using the Person ID associated with your Auth token. Admin users…
Recording Report
- GETList of Recording Audit Report Summaries
/recordingReport/accessSummaryLists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return. Only recording… - GETGet Recording Audit Report Details
/recordingReport/accessDetail?recordingId=4f914b1dfe3c4d11a61730f18c0f5387Retrieves details for a recording audit report with a specified recording ID. Only recording audit report details of meetings hosted by or shared with the… - GETList Meeting Archive Summaries
/recordingReport/meetingArchiveSummariesLists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return. Meeting archive summaries are… - GETGet Meeting Archive Details
/recordingReport/meetingArchives/:archiveIdRetrieves details for a meeting archive report with a specified archive ID, which contains recording metadata. Meeting archive details are only available to…
Recordings
- GETList Recordings
/recordings<div><Callout type="warning">This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for… - POSTQuery Recordings
/recordings/queryQueries recordings with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and… - GETList Recordings For an Admin or Compliance Officer
/admin/recordings<div><Callout type="warning">This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for… - POSTQuery Recordings For an Admin or Compliance Officer
/admin/recordings/queryQueries recordings for an admin or compliance officer with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number… - DELETEDelete a Recording By an Admin
/admin/recordings/:recordingIdRemoves a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host,… - GETGet Recording Details
/recordings/:recordingIdRetrieves details for a recording with a specified recording ID. Only recordings of meetings hosted by or shared with the authenticated user may be retrieved.… - DELETEDelete a Recording
/recordings/:recordingIdRemoves a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the… - POSTMove Recordings into the Recycle Bin
/recordings/softDeleteMove recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by Restore Recordings from Recycle Bin API. If you'd… - POSTRestore Recordings from Recycle Bin
/recordings/restoreRestore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin. * If… - POSTPurge Recordings from Recycle Bin
/recordings/purgePurge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin. Only recordings of meetings hosted by the… - POSTShare a Recording
/recordings/:recordingId/accessListShare or unshare a recording with other users by recording ID and email addresses. - POSTShare a Recording Link
/recordings/accessListShare or unshare a recording with other users by recording link and email addresses. - GETList Group Recordings
/group/recordingsList group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and… - GETGet Group Recording Details
/group/recordings/:recordingIdRetrieves details for a group recording for a service app which has group recording access. * Only recordings which are in the available status and not shared…
Site
- GETGet Meeting Common Settings Configuration
/admin/meeting/config/commonSettingsSite administrators can use this API to get a list of functions, options, and privileges that are configured for their Webex service sites. * If siteUrl is… - PATCHUpdate Meeting Common Settings Configuration
/admin/meeting/config/commonSettingsSite administrators can use this API to update the option of features, options and privileges that are configured for their WebEx service sites.
Video Mesh
- GETList Clusters Availability
/videoMesh/clusters/availability?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQReturns the availability details for all Video Mesh clusters in an organization. - GETGet Cluster Availability
/videoMesh/clusters/availability/:clusterId?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00ZReturns the availability details of a single Video Mesh cluster in an organization. - GETList Node Availability
/videoMesh/nodes/availability?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTgReturns the availability details of all nodes in a Video Mesh cluster. - GETGet Node Availability
/videoMesh/nodes/availability/:nodeId?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00ZReturns the availability details of a single node in a Video Mesh cluster. - GETList Media Health Monitoring Tool Test results V2
/videoMesh/testResults/mediaHealthMonitorTest?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Media Health Monitoring Tool tests for an organization. <br/> Changes in V2: <br/> On-demand test results can be obtained… - GETGet Media Health Monitoring Tool Test results for clusters V2
/videoMesh/testResults/mediaHealthMonitorTest/clusters?clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Media Health Monitoring Tool tests for a single Video Mesh cluster. <br/> Changes in V2: <br/> On-demand test results can be… - GETGet Media Health Monitoring Tool Test results for node V2
/videoMesh/testResults/mediaHealthMonitorTest/nodes?nodeId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOm1mX21nbXRAMTU2ZGY3ODljODU1NGQ1NWEyNzVkZjk5NzhmOTkwMmQ=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Media Health Monitoring Tool tests for a single Video Mesh node. <br/> Changes in V2: <br/> On-demand test results can be… - GETList Overflow to Cloud details
/videoMesh/cloudOverflow?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQReturns details of overflows to the cloud in an organization. - GETList Cluster Redirect details
/videoMesh/callRedirects?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQReturns the redirect details of all Video Mesh clusters in an organization. - GETGet Cluster Redirect details
/videoMesh/clusters/callRedirects?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjIReturns details of cluster redirects for a single Video Mesh cluster. - GETList Clusters Utilization
/videoMesh/utilization?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQReturns the utilization details of all Video Mesh clusters in an organization. - GETGet Cluster Utilization details
/videoMesh/clusters/utilization?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjIReturns the utilization details for a single Video Mesh cluster. - GETList Reachability Test results V2
/videoMesh/testResults/reachabilityTest?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Reachability tests for an organization. <br/> Changes in V2: <br/> 1. On-demand test results can be obtained along with the… - GETGet Reachability Test results for cluster V2
/videoMesh/testResults/reachabilityTest/clusters?clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Reachability tests for a single Video Mesh cluster. <br/> Changes in V2: <br/> 1. On-demand test results can be obtained along… - GETGet Reachability Test results for node V2
/videoMesh/testResults/reachabilityTest/nodes?nodeId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOm1mX21nbXRAMTU2ZGY3ODljODU1NGQ1NWEyNzVkZjk5NzhmOTkwMmQ=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Reachability tests for a single Video Mesh node. <br/> Changes in V2: <br/> 1. On-demand test results can be obtained along… - GETList Cluster Details
/videoMesh/clusters?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQReturns the cluster details of all Video Mesh clusters in an organization. - GETGet Cluster Details
/videoMesh/clusters/:clusterIdReturns the cluster details for a single Video Mesh cluster. - POSTTrigger on-demand test for cluster
/videoMesh/triggerTest/clusters/:clusterIdTriggers an on-demand test for a cluster. The test is run on a maximum of 10 nodes present in the cluster, chosen at random, or based on input from the user. - POSTTrigger on-demand test for node
/videoMesh/triggerTest/nodes/:nodeIdTriggers an on-demand test for a node. - GETGet Triggered test status
/videoMesh/testStatus?commandId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjIReturns the status of the test triggered using the Trigger on-demand test API. - GETGet Triggered test results
/videoMesh/testResults?commandId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzUReturns the results of the test triggered using the command ID.<br/> <b>NOTE:</b> The response format depends on the type of test triggered and it is the same… - GETList Network Test results
/videoMesh/testResults/networkTest?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Network tests triggered for an organization. The tests listed below are run as a part of the Network Test execution on the… - GETGet Network Test results for cluster
/videoMesh/testResults/networkTest/clusters?clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Network tests triggered for a single Video Mesh cluster. The tests listed below are run as a part of the Network Test… - GETGet Network Test results for node
/videoMesh/testResults/networkTest/nodes?nodeId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOm1mX21nbXRAMTU2ZGY3ODljODU1NGQ1NWEyNzVkZjk5NzhmOTkwMmQ=&triggerType=OnDemand&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00ZReturns the test results of the Network tests triggered for a single Video Mesh node. The tests listed below are run as a part of the Network Test execution… - GETList Cluster Client Type Distribution details
/videoMesh/clientTypeDistribution?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00Z&deviceType=webexDevices,webexAppVdiReturns the client type distribution details for all Video Mesh clusters in an organization. - GETGet Cluster Client Type Distribution details
/videoMesh/clientTypeDistribution/clusters?clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00Z&deviceType=webexDevices,webexAppVdiReturns the client type distribution details for a single Video Mesh cluster. - GETList Event Threshold Configuration
/videoMesh/eventThresholdsReturns the event threshold configurations for orgId or clusterId, with optional filters eventName and eventScope. - PATCHUpdate Event Threshold Configuration
/videoMesh/eventThresholdsUpdates an existing event threshold configuration for given Event Threshold IDs. - GETGet Event Threshold Configuration
/videoMesh/eventThresholds/:eventThresholdIdReturns the event threshold configurations for eventThresholdId. - POSTReset Event Threshold Configuration
/videoMesh/eventThresholds/resetResets the existing event threshold configuration for given Event Threshold IDs to default value. To stop receiving webhook events, use the Webhooks API to…
Webhooks
- GETList Webhooks
/webhooksList all of your webhooks. - POSTCreate a Webhook
/webhooksCreates a webhook. To learn more about how to create and use webhooks, see The Webhooks Guide. - GETGet Webhook Details
/webhooks/:webhookIdShows details for a webhook, by ID. Specify the webhook ID in the webhookId parameter in the URI. - PUTUpdate a Webhook
/webhooks/:webhookIdUpdates a webhook, by ID. You cannot use this call to deactivate a webhook, only to activate a webhook that was auto deactivated. The fields that can be… - DELETEDelete a Webhook
/webhooks/:webhookIdDeletes a webhook, by ID. Specify the webhook ID in the webhookId parameter in the URI.
API details
- Authentication
- A bearer token in the Authorization header
OAuth 2.0 (authorization code flow) - Operations
- 171 operations on 131 pathsGET 96POST 37PUT 19DELETE 15PATCH 4
- Main resources
- Meetings 48Video Mesh 30Preferences 14Recordings 14Participants 7Tracking Codes 7Transcripts 7Invitees 6People 6Webhooks 5
- Response formats
application/json;charset=utf-8application/jsontext/plaintext/vtt- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Webex's published OpenAPI description (webex/webex-openapi-specs) (CC-BY-4.0)
How to test the Webex Meetings in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Webex Meetings collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Compliance Events” (GET /slido/compliance/events?sessionOrgId=a1111111-1a11-111a-1a11-1a1111a1111a&sessionId=abcdef0123456789abcdef0123456789_I_000000000000000000), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Webex Meetings?
The Webex Meetings APIs enable developers to schedule, manage, and retrieve information about Webex meetings, webinars, and events. They provide endpoints for… It is listed under Communication and has 171 endpoints.
Who publishes the Webex Meetings?
It is listed from Webex's public API description (an OpenAPI document), not published by Webex on Swastik Codes. Anyone who controls webex.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Webex Meetings?
It accepts 2 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow).
How many endpoints does the Webex Meetings have?
171 operations on 131 paths (96 GET, 37 POST, 19 PUT, 15 DELETE, 4 PATCH). The largest groups are Meetings, Video Mesh, Preferences, Recordings.
Is forking the Webex Meetings free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.