BroadWorks Subscribers - Provision a BroadWorks Subscriber

Provision a BroadWorks Subscriber

Provision 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 assign the required licenses and entitlements for Webex and Meetings.

POST/v1/broadworks/subscribers

Body Parameters

provisioningId

stringrequired

This Provisioning ID defines how this subscriber is to be provisioned for Webex Services.

Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Webex Partner Hub.

userId

stringrequired

The user ID of the subscriber on BroadWorks.

spEnterpriseId

stringrequired

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

firstName

stringrequired

The first name of the subscriber.

lastName

stringrequired

The last name of the subscriber.

package

enumrequired

The Webex for BroadWorks package to be assigned to the subscriber.

softphone

string

Softphone package

basic

string

Basic package

standard

string

Standard package

premium

string

Premium package

primaryPhoneNumber

string

The primary phone number configured against the subscriber on BroadWorks.

mobilePhoneNumber

string

The mobile phone number configured against the subscriber on BroadWorks. Any empty value on update will remove the already configured mobile phone number.

extension

string

The extension number configured against the subscriber on BroadWorks.

string

The email address of the subscriber (mandatory for the trusted email provisioning flow).

language

string

The {ISO-639-1}_{ISO-3166} or {ISO-639-1} locale or language code used as preferred language for organization and Webex Meeting Sites. Refer to the help page for more information.

timezone

string

The time zone associated with the subscriber. Refer to the Webex Meetings Site Timezone section of the Webex for BroadWorks guide for more information.

Response Properties

string

A unique Cisco identifier for the subscriber.

personId

string

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.

userId

string

The user ID 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.

string

The email address of the subscriber.

primaryPhoneNumber

string

The primary phone number configured against the subscriber on BroadWorks.

mobilePhoneNumber

string

The mobile phone number configured against the subscriber on BroadWorks.

extension

string

The extension number configured against the subscriber on BroadWorks.

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.

pending_user_migration

string

Subscriber Provisioning is paused. An automated email is sent to the subscriber, waiting for the subscriber's consent.

provisioning

string

Subscriber provisioning is in progress.

provisioned

string

The subscriber is fully provisioned on Webex.

updating

string

An update is in progress for a provisioned subscriber.

error

string

An error occurred provisioning the subscriber on Webex.

errors

array[Error]

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 description of the error.

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.

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.

POST

/v1/broadworks/subscribers

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Body

provisioningId
stringRequired
This Provisioning ID defines how this subscriber is to be provisioned for Webex Services. Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Webex Partner Hub.
userId
stringRequired
The user ID of the subscriber on BroadWorks.
spEnterpriseId
stringRequired
The Service Provider supplied unique identifier for the subscriber's enterprise.
firstName
stringRequired
The first name of the subscriber.
lastName
stringRequired
The last name of the subscriber.
package
enumRequired
The Webex for BroadWorks package to be assigned to the subscriber.
primaryPhoneNumber
string
The primary phone number configured against the subscriber on BroadWorks.
mobilePhoneNumber
string
The mobile phone number configured against the subscriber on BroadWorks. Any empty value on update will remove the already configured mobile phone number.
extension
string
The extension number configured against the subscriber on BroadWorks.
email
string
The email address of the subscriber (mandatory for the trusted email provisioning flow).
language
string
The {ISO-639-1}_{ISO-3166} or {ISO-639-1} locale or language code used as preferred language for organization and Webex Meeting Sites. Refer to the [help page](https://www.cisco.com/content/en/us/td/docs/voice_ip_comm/cloudCollaboration/wx4bwks/Solution_Guide/wbxbw_b_solution-guide/wbxbw_b_SolutionGuide-PDF_chapter_01.html#Cisco_Reference.dita_f10351e1-f775-418d-a700-ec8487e0a33b) for more information.
timezone
string
The time zone associated with the subscriber. Refer to the [Webex Meetings Site Timezone](/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) section of the [Webex for BroadWorks](/docs/api/guides/webex-for-broadworks-developers-guide) guide for more information.

{
  "provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
  "userId": "95547321@sp.com",
  "spEnterpriseId": "Reseller1+acme",
  "firstName": "John",
  "lastName": "Andersen",
  "package": "standard",
  "primaryPhoneNumber": "+1-240-555-1212",
  "mobilePhoneNumber": "+1-818-279-1234",
  "extension": "1212",
  "email": "john.anderson@acme.com",
  "language": "en",
  "timezone": "America/Los_Angeles"
}

200 / OK

{
    "id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
    "userId": "95547321@sp.com",
    "spEnterpriseId": "Reseller1+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": "provisioning",
    "created": "2019-10-18T14:26:16.000Z",
    "lastStatusChange": "2020-03-18T16:05:34.000Z",
    "provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
    "selfActivated": "false"
}