Webex

Webex Broadworks Calling

The Webex BroadWorks Calling APIs provide access to advanced calling features and user management for BroadWorks-powered Webex Calling deployments. These APIs…

Communication#openapi

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 BroadWorks Calling APIs provide access to advanced calling features and user management for BroadWorks-powered Webex Calling deployments. These APIs support provisioning of users and devices, call control, feature management, device inventory, and detailed reporting. Service providers and enterprises can automate onboarding, integrate with OSS/BSS systems, manage user entitlements, and monitor call quality. The APIs are designed for scalable, multi-tenant environments and support seamless integration with existing telephony infrastructure.

Endpoints 19

BroadWorks Workspaces

  • POSTProvision a BroadWorks Workspace/broadworks/workspacesProvision a new BroadWorks workspace for Cisco Webex services. This API allows a Service Provider to provision a workspace for an existing customer.
  • PUTUpdate a Broadworks Workspace/broadworks/workspaces/:workspaceIdUpdate certain details of a provisioned BroadWorks workspace on Cisco Webex.
  • DELETERemove a BroadWorks Workspace/broadworks/workspaces/:workspaceIdRemove the mapping between a BroadWorks workspace and Cisco Webex device.

BroadWorks Billing Reports

  • GETList BroadWorks Billing Reports/broadworks/billing/reportsSearch for reports. There are a number of filter options which can be combined in a single request.
  • POSTCreate a BroadWorks Billing Report/broadworks/billing/reportsGenerate a monthly reconciliation report. <div> <Callout type='info'> Partners who have moved to extended wholesale subscription model should generate reports…
  • GETGet a BroadWorks Billing Report/broadworks/billing/reports/:idRetrieve a specific billing reconciliation report.
  • DELETEDelete a BroadWorks Billing Report/broadworks/billing/reports/:idDelete a monthly reconciliation report using a report ID.

BroadWorks Enterprises

  • GETList BroadWorks Enterprises/broadworks/enterprisesList the provisioned enterprises for a Service Provider. This API also lets a Service Provider search for their provisioned enterprises on Webex. A search on…
  • GETGet Directory Sync Status for an Enterprise/broadworks/enterprises/:id/broadworksDirectorySyncThis API lets a Partner Admin get the most recent directory sync status for a customer's Broadworks enterprise on Webex.
  • PUTUpdate Directory Sync for a BroadWorks Enterprise/broadworks/enterprises/:id/broadworksDirectorySyncThis API lets a Partner Admin enable or disable directory sync for the customer's Broadworks enterprise on Webex.
  • POSTTrigger Directory Sync for an Enterprise/broadworks/enterprises/:id/broadworksDirectorySyncThis API lets a Partner Admin trigger a directory sync for the customer's Broadworks enterprise on Webex.
  • POSTTrigger Directory Sync for a User/broadworks/enterprises/:id/broadworksDirectorySync/externalUserThis API lets a Partner Admin trigger a directory sync for an external user (real or virtual user) on Broadworks enterprise with Webex.

BroadWorks Subscribers

  • GETList BroadWorks Subscribers/broadworks/subscribersThis API lets a Service Provider search for their associated subscribers. There are a number of filter options that can be combined in a single request.
  • POSTProvision a BroadWorks Subscriber/broadworks/subscribersProvision a new BroadWorks subscriber for Webex services. This API lets a Service Provider map a BroadWorks subscriber to a new or existing Webex user and…
  • GETGet a BroadWorks Subscriber/broadworks/subscribers/:subscriberIdThis API lets a Service Provider retrieve details of a provisioned BroadWorks subscriber on Webex.
  • PUTUpdate a BroadWorks Subscriber/broadworks/subscribers/:subscriberIdThis API lets a Service Provider update certain details of a provisioned BroadWorks subscriber on Webex. <div> <Callout type='info'>The updated items will not…
  • DELETERemove a BroadWorks Subscriber/broadworks/subscribers/:subscriberIdThis API will allow a Service Provider to remove the mapping between a BroadWorks Subscriber and Webex user.
  • POSTPrecheck a Broadworks Subscriber Provisioning/broadworks/subscribers/validateVerify the likely success of provisioning a broadworks subscriber. <div> <Callout type='info'> The Prerequisite for using this API is to have at least one…
  • POSTSend Consent User Move Email to Pending Broadworks Subscribers/subscribers/:subscriberId/emails/consentMoveAllows a Service Provider to send the user consent move email to a subscriber who is currently in pending_user_migration state.

API details

Authentication
A bearer token in the Authorization header
OAuth 2.0 (authorization code flow)
A bearer token in the Authorization header
Operations
19 operations on 11 pathsPOST 7GET 6PUT 3DELETE 3
Main resources
BroadWorks Subscribers 7BroadWorks Enterprises 5BroadWorks Billing Reports 4BroadWorks Workspaces 3
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0

How to test the Webex Broadworks Calling in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Webex Broadworks Calling collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Provision a BroadWorks Workspace” (POST /broadworks/workspaces), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Webex Broadworks Calling?

The Webex BroadWorks Calling APIs provide access to advanced calling features and user management for BroadWorks-powered Webex Calling deployments. These APIs… It is listed under Communication and has 19 endpoints.

Who publishes the Webex Broadworks Calling?

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 Broadworks Calling?

It accepts 3 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow); A bearer token in the Authorization header.

How many endpoints does the Webex Broadworks Calling have?

19 operations on 11 paths (7 POST, 6 GET, 3 PUT, 3 DELETE). The largest groups are BroadWorks Subscribers, BroadWorks Enterprises, BroadWorks Billing Reports, BroadWorks Workspaces.

Is forking the Webex Broadworks Calling free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.