# Webex Broadworks Calling API

> Webex Broadworks Calling API on Apizie: 19 endpoints (List BroadWorks Billing Reports, Create a BroadWorks Billing Report, Get a BroadWorks Billing Report, Delete a BroadWorks Billing Report, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/communication:webex-webex-broadworks/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:webex-webex-broadworks`
- Category: Communication
- Status: byok
- Source: https://developer.webex.com/docs/api/getting-started
- Page: https://apizie.tech/api/communication/webex-webex-broadworks
- OpenAPI: https://apizie.tech/api/communication/webex-webex-broadworks/openapi.json

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,…

## Endpoints

### List BroadWorks Billing Reports
`GET https://apizie.tech/v1/communication:webex-webex-broadworks/list-broad-works-billing-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| before | string | no | Only include billing reports created before this date. |
| after | string | no | Only include billing reports created after this date. |
| sortBy | string | no | Sort the reports. + Members: + id + status + billingPeriod |

### Create a BroadWorks Billing Report
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/create-a-broad-works-billing-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a BroadWorks Billing Report
`GET https://apizie.tech/v1/communication:webex-webex-broadworks/get-a-broad-works-billing-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique identifier for the report in request. |

### Delete a BroadWorks Billing Report
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/delete-a-broad-works-billing-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique report ID that corresponds to a billing report. |

### List BroadWorks Enterprises
`GET https://apizie.tech/v1/communication:webex-webex-broadworks/list-broad-works-enterprises` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| spEnterpriseId | string | no | The Service Provider supplied unique identifier for the subscriber's enterprise. |
| startsWith | string | no | The starting string of the enterprise identifiers to match against. |
| max | number | no | Limit the number of enterprises returned in the search, up to 1000. |

### Get Directory Sync Status for an Enterprise
`GET https://apizie.tech/v1/communication:webex-webex-broadworks/get-directory-sync-status-for-an-enterprise` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique identifier for the enterprise in question. |

### Trigger Directory Sync for an Enterprise
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/trigger-directory-sync-for-an-enterprise` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique identifier for the enterprise in question. |
| body | object | no | JSON request body |

### Update Directory Sync for a BroadWorks Enterprise
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/update-directory-sync-for-a-broad-works-enterprise` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique identifier for the enterprise in question. |
| body | object | no | JSON request body |

### Trigger Directory Sync for a User
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/trigger-directory-sync-for-a-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique identifier for the enterprise in question. |
| body | object | no | JSON request body |

### List BroadWorks Subscribers
`GET https://apizie.tech/v1/communication:webex-webex-broadworks/list-broad-works-subscribers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | no | The user ID of the subscriber on BroadWorks. |
| personId | string | no | The Person ID of the Webex subscriber. |
| email | string | no | The email address of the subscriber. |
| provisioningId | string | no | The Provisioning ID associated with this subscriber. |
| spEnterpriseId | string | no | The Service Provider supplied unique identifier for the subscriber's enterprise. |
| lastStatusChange | string | no | Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601… |
| status | string | no | The provisioning status of the subscriber. This Parameter supports multiple comma separated values. For example :… |
| after | string | no | Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted. |
| selfActivated | boolean | no | Indicates if the subscriber was self activated, rather than provisioned via these APIs. |
| max | integer | no | Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the… |

### Provision a BroadWorks Subscriber
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/provision-a-broad-works-subscriber` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a BroadWorks Subscriber
`GET https://apizie.tech/v1/communication:webex-webex-broadworks/get-a-broad-works-subscriber` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriberId | string | yes | A unique identifier for the subscriber in question. |

### Update a BroadWorks Subscriber
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/update-a-broad-works-subscriber` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriberId | string | yes | A unique identifier for the subscriber in question. |
| body | object | no | JSON request body |

### Remove a BroadWorks Subscriber
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/remove-a-broad-works-subscriber` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriberId | string | yes | A unique identifier for the subscriber in question. |

### Precheck a Broadworks Subscriber Provisioning
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/precheck-a-broadworks-subscriber-provisioning` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Send Consent User Move Email to Pending Broadworks Subscribers
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/send-consent-user-move-email-to-pending-broadworks-subscribe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriberId | string | yes | A unique identifier for the subscriber in question. |

### Provision a BroadWorks Workspace
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/provision-broad-works-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update a Broadworks Workspace
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/update-broadworks-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | A unique Cisco identifier for the workspace. |
| body | object | no | JSON request body |

### Remove a BroadWorks Workspace
`POST https://apizie.tech/v1/communication:webex-webex-broadworks/remove-broad-works-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | A unique Cisco identifier for the workspace. |

## Example
```
curl "https://apizie.tech/v1/communication:webex-webex-broadworks/list-broad-works-billing-reports" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Webex Broadworks Calling API?
Create a free Apizie key, then send GET https://apizie.tech/v1/communication:webex-webex-broadworks/list-broad-works-billing-reports with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Webex Broadworks Calling API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Webex Broadworks Calling itself also needs your own key from webexapis.com.

### Can AI agents use the Webex Broadworks Calling API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:webex-webex-broadworks.

### What is the status of the Webex Broadworks Calling API?
Needs your own provider key (bring your own key)