List BroadWorks Subscribers
This 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.
Query Parameters
The user ID of the subscriber on BroadWorks.
The Person ID of the Webex subscriber.
The email address of the subscriber.
The Provisioning ID associated with this subscriber.
The Service Provider supplied unique identifier for the subscriber's enterprise.
Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
The provisioning status of the subscriber. This Parameter supports multiple comma separated values. For example : status=error,provisioned,provisioning.
Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
Indicates if the subscriber was self activated, rather than provisioned via these APIs.
Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the Pagination section of Webex REST API Basics.
Response Properties
An array of Subscriber objects.
A unique Cisco identifier for the subscriber.
The Person Id of the subscriber on Webex. To be used when referencing this subscriber on other Webex APIs. Only presented when status is provisioned.
The user ID of the subscriber on BroadWorks.
The Service Provider supplied unique identifier for the subscriber's enterprise.
The first name of the subscriber.
The last name of the subscriber.
The email address of the subscriber.
The primary phone number configured against the subscriber on BroadWorks.
The mobile phone number configured against the subscriber on BroadWorks.
The extension number configured against the subscriber on BroadWorks.
The Webex for BroadWorks Package assigned to the subscriber.
Softphone package.
Basic package.
Standard package.
Premium package.
The provisioning status of the user.
Subscriber Provisioning is paused, pending input of email address.
Subscriber Provisioning is paused. The subscriber has entered an email address but has yet to complete validation.
Subscriber Provisioning is paused. An automated email is sent to the subscriber, waiting for the subscriber's consent.
Subscriber provisioning is in progress.
The subscriber is fully provisioned on Webex.
An update is in progress for a provisioned subscriber.
An error occurred provisioning the subscriber on Webex.
List of errors that occurred during that last attempt to provision/update this subscriber.
Note:
This list captures errors that occurred during asynchronous or background provisioning of the subscriber, after the API has been accepted and 200 OK response returned.
Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code.
An error code that identifies the reason for the error.
A description of the error.
The date and time the subscriber was provisioned.
The date and time the provisioning status of the subscriber last changed.
This Provisioning ID associated with this subscriber.
Indicates if the subscriber was self activated, rather than provisioned via these APIs.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- The user ID of the subscriber on BroadWorks.
- The Person ID of the Webex subscriber.
- The email address of the subscriber.
- The Provisioning ID associated with this subscriber.
- The Service Provider supplied unique identifier for the subscriber's enterprise.
- Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
- The provisioning status of the subscriber. This Parameter supports multiple comma separated values. For example : status=error,provisioned,provisioning.
- Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
- Indicates if the subscriber was self activated, rather than provisioned via these APIs.
- Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/basics).
{
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"userId": "95547321@sp.com",
"spEnterpriseId": "SP1+acme",
"firstName": "John",
"lastName": "Andersen",
"email": "john.anderson@acme.com",
"primaryPhoneNumber": "+1-240-555-1212",
"mobilePhoneNumber": "+1-818-279-1234",
"extension": "1212",
"package": "standard",
"status": "error",
"errors": [
{
"errorCode": 10022,
"description": "The BroadWorks UserID is already associated with an existing user"
}
],
"created": "2019-10-18T14:26:16.000Z",
"lastStatusChange": "2020-03-18T16:05:34.000Z",
"provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
"selfActivated": "false"
}
]
}