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 SettingsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Webex for BroadWorksIntegrations and AuthorizationWebex for Wholesale
Reference
BroadWorks Device ProvisioningBroadWorks Enterprises
GETList BroadWorks Enterprises
PUTUpdate Directory Sync for a BroadWorks Enterprise
POSTTrigger Directory Sync for an Enterprise
GETGet Directory Sync Status for an Enterprise
POSTTrigger Directory Sync for a User
BroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWholesale 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 TranscriptsMeetingsPeopleRecording 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 Device ProvisioningBroadWorks Enterprises
GETList BroadWorks Enterprises
PUTUpdate Directory Sync for a BroadWorks Enterprise
POSTTrigger Directory Sync for an Enterprise
GETGet Directory Sync Status for an Enterprise
POSTTrigger Directory Sync for a User
BroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesOrganizationsPeoplePlacesRecording 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 CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJavaCommunity
Developer CommunityCertifications

BroadWorks Enterprises

Not supported for Webex for Government (FedRAMP)

These are a set of APIs that are specifically targeted at BroadWorks Service Providers who sign up to the Webex for BroadWorks solution. They enable Service Providers to provision Cisco Webex Services for their subscribers. Please note these APIs require a functional BroadWorks system configured for Webex for BroadWorks. Read more about using this API at https://www.cisco.com/go/WebexBroadworksAPI.

Viewing Webex for BroadWorks enterprise information requires an administrator auth token with spark-admin:broadworks_enterprises_read scope. Updating directory sync configuration or trigger directory sync for a Webex for BroadWorks enterprise require an administrator auth token with spark-admin:broadworks_enterprises_write scope.

Method
Description
GEThttps://webexapis.com/v1/broadworks/enterprises
List BroadWorks Enterprises
https://webexapis.com/v1/broadworks/enterprises
GETList BroadWorks Enterprises
PUThttps://webexapis.com/v1/broadworks/enterprises/{id}/broadworksDirectorySync
Update Directory Sync for a BroadWorks Enterprise
https://webexapis.com/v1/broadworks/enterprises/{id}/broadworksDirectorySync
PUTUpdate Directory Sync for a BroadWorks Enterprise
POSThttps://webexapis.com/v1/broadworks/enterprises/{id}/broadworksDirectorySync
Trigger Directory Sync for an Enterprise
https://webexapis.com/v1/broadworks/enterprises/{id}/broadworksDirectorySync
POSTTrigger Directory Sync for an Enterprise
GEThttps://webexapis.com/v1/broadworks/enterprises/{id}/broadworksDirectorySync
Get Directory Sync Status for an Enterprise
https://webexapis.com/v1/broadworks/enterprises/{id}/broadworksDirectorySync
GETGet Directory Sync Status for an Enterprise
POSThttps://webexapis.com/v1/broadworks/enterprises/{id}/broadworksDirectorySync/externalUser
Trigger Directory Sync for a User
https://webexapis.com/v1/broadworks/enterprises/{id}/broadworksDirectorySync/externalUser
POSTTrigger Directory Sync for a User