Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex. Please visit Webex for Developers to manage your apps.

List BroadWorks Subscribers

This API will allow a Service Provider to search for their associated subscribers. There are a number of filter options. These can be combined in a single request.

GET/v1/broadworks/subscribers
Query Parameters
userId
string

The userID of the subscriber on BroadWorks.

personId
string

The Person ID of the subscriber on Cisco Webex.

email
string

The email address of the subscriber.

provisioningId
string

The Provisioning ID associated with this subscriber.

spEnterpriseId
string

The Service Provider supplied unique identifier for the subscriber's enterprise.

lastStatusChange
string

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. This parameter must be used in conjunction with provisioningId and/or spEnterpriseId parameters.

status
string

The provisioning status of the subscriber. This parameter must be used in conjunction with provisioningId and/or spEnterpriseId parameters.

after
string

Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted. This parameter must be used in conjunction with provisioningId and/or spEnterpriseId parameters.

selfActivated
boolean

Indicates if the subscriber was self activated, rather than provisioned via these APIs.

max
integer

Limit on number of subscribers returned in the search, up to 100.

Default: 50
Response Properties
items
array

An array of Subscriber objects.

id
string

A unique Cisco identifier for the subscriber.

personId
string

The Person Id of the subscriber on Cisco Webex. To be used when referencing this subscriber on other Cisco Webex APIs. Only presented when status is provisioned.

userId
string

The userID of the subscriber on BroadWorks.

spEnterpriseId
string

The Service Provider supplied unique identifier for the subscriber's enterprise.

firstName
string

The first name of the subscriber.

lastName
string

The last name of the subscriber.

email
string

The email address of the subscriber.

primaryPhoneNumber
string

The primary phone number configured against the subscriber on BroadWorks.

language
string

The ISO 639-1 language code associated with the subscriber. Reserved for future use - any value returned should be ignored. Currently fixed to "en" in all responses.

package
enum

The Webex for BroadWorks Package assigned to the subscriber.

softphone
string

Softphone package

basic
string

Basic package

standard
string

Standard package

premium
string

Premium package

status
enum

The provisioning status of the user.

pending_email_input
string

Subscriber Provisioning is paused, pending input of email address.

pending_email_validation
string

Subscriber Provisioning is paused. The subscriber has entered an email address but has yet to complete validation.

provisioning
string

Subscriber provisioning is in progress.

provisioned
string

The subscriber is fully provisioned on Cisco Webex.

updating
string

An update is in progress for a provisioned subscriber.

error
string

An error occurred provisioning the subscriber on Cisco Webex.

errors
array

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.

errorCode
number

An error code that identifies the reason for the error

description
string

A textual representation of the error code.

created
string

The date and time the subscriber was provisioned.

lastStatusChange
string

The date and time the provisioning status of the subscriber last changed.

provisioningId
string

This Provisioning ID associated with this subscriber.

selfActivated
boolean

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.

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.
GET
/v1/broadworks/subscribers{?userId,personId,email,provisioningId,spEnterpriseId,status,after,selfActivated,max}
Log in to try the API.
Header
Query Parameters
  • The userID of the subscriber on BroadWorks.
  • The Person ID of the subscriber on Cisco Webex.
  • 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. This parameter must be used in conjunction with `provisioningId` and/or `spEnterpriseId` parameters.
  • The provisioning status of the subscriber. This parameter must be used in conjunction with `provisioningId` and/or `spEnterpriseId` parameters.
  • Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted. This parameter must be used in conjunction with `provisioningId` and/or `spEnterpriseId` parameters.
  • Indicates if the subscriber was self activated, rather than provisioned via these APIs.
  • Limit on number of subscribers returned in the search, up to 100.
https://webexapis.com/v1/broadworks/subscribers?userId=95547321@sp.com&personId=Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY&email=john.anderson@acme.com&provisioningId=ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ&spEnterpriseId=SP1+Acme&lastStatusChange=1579046400245&status=pending_email_input&after=1579046400245&selfActivated=false&max=10
200 / OK
{
    "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",
            "language": "en",
            "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"

        }
    ]
}