DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Platform IntroductionBotsButtons and CardsIntegrationsWidgetsGuest IssuerDeveloper SandboxPromote your AppFAQs
Embedded Apps
OverviewDeveloper GuideDesign Guidelines for MeetingsDesign Guidelines for MessagingAPI ReferenceSubmission Checklist for Embedded Apps
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Webex for BroadWorksIntegrations and AuthorizationWebex for Wholesale
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Devices
Overview
Guides
Workspace Integrations Guide
Reference
Device ConfigurationsDevicesPlacesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Meeting Resource GuideEmbedded Apps GuideEmbedded Apps ReferenceIntegrations and AuthorizationEmbedded Apps Design and Experience GuidelinesWebhooksWebinar Guide
Reference
Meeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetings
POSTCreate a Meeting
GETGet a Meeting
GETList Meetings
GETList Meetings of a Meeting Series
PUTUpdate a Meeting
DELETEDelete 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
POSTRegister a Meeting Registrant
POSTBatch register Meeting Registrants
GETGet a meeting registrant's detail information
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
PeopleRecording ReportRecordingsWebhooks
Messaging
Overview
Guides
Embedded Apps GuideEmbedded Apps ReferenceBotsIntegrations and AuthorizationEmbedded Apps Design and Experience GuidelinesWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsWebhooks
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference Guide
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetings
POSTCreate a Meeting
GETGet a Meeting
GETList Meetings
GETList Meetings of a Meeting Series
PUTUpdate a Meeting
DELETEDelete 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
POSTRegister a Meeting Registrant
POSTBatch register Meeting Registrants
GETGet a meeting registrant's detail information
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
MembershipsMessagesOrganizationsPeoplePlacesRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJavaCommunity
Developer CommunityCertifications

Update Meeting Control Status

To start, pause, resume, or stop a meeting recording; To lock or unlock an on-going meeting.

PUT/v1/meetings/controls
Query Parameters
meetingId
stringrequired

Unique identifier for the meeting. Please note that currently meeting ID of a scheduled personal room meeting is not supported for this API.

Body Parameters
recordingStarted
boolean

The value can be true or false. true means to start the recording, false to end the recording.

recordingPaused
boolean

The value can be true or false, will be ignored if 'recordingStarted' sets to false, and true to resume the recording only if the recording is paused vise versa.

locked
boolean

The value is true or false.

Response Properties
locked
boolean

Whether the meeting is locked or not.

recordingStarted
boolean

The value can be true or false, it indicates the meeting recording started or not.

recordingPaused
boolean

The value can be true or false, it indicates the meeting recording paused or not.

Response Codes

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

CodeStatusDescription
200OKSuccessful request with body content.
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
PUT
/v1/meetings/controls{?meetingId}
Log in to try the API.
Header
Query Parameters
  • Unique identifier for the meeting. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.
Body
  • The value can be true or false. true means to start the recording, false to end the recording.
  • The value can be true or false, will be ignored if 'recordingStarted' sets to false, and true to resume the recording only if the recording is paused vise versa.
  • The value is true or false.
  • Request
  • Response
https://webexapis.com/v1/meetings/controls?meetingId=560d7b784f5143e3be2fc3064a5c4999
{
    "recordingStarted": true,
    "recordingPaused": true,
    "locked": true
}
200 / OK
{
  "locked": false,
  "recordingStarted": true,
  "recordingPaused": true
}

Connect

Support

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

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