Calling - Webex for BroadWorks | Webex for Developers

Webex for BroadWorks

Webex for BroadWorks is an offer that integrates BroadWorks Calling in Webex. Learn how to use the Webex for BroadWorks Provisioning APIs.

anchorWhat's possible with Webex for BroadWorks Provisioning APIs

anchor

The Webex for BroadWorks Provisioning API is for BroadWorks Service Providers (SPs) who sign up for Cisco Webex for BroadWorks. The API enables those SPs to provision, update, and remove Cisco Webex services for their subscribers.

anchorUsing the Provisioning API

anchor

anchorMethods and Content Types

anchor

The Webex for BroadWorks Provisioning API is RESTful. In REST, a base URL represents each resource. You use the HTTP methods GET, POST, PUT, and DELETE to request data and perform actions on those resources.

For methods that accept request parameters, the platform accepts only application/json content types.

anchorWhat's possible with Broadworks Billing Reports Public APIs

anchor

The Broadworks Billing Reports Public APIs are for Service Providers, who sign up for Cisco Webex for Broadworks. These APIs helps Service Provider to generate monthly billing reports with user billing data. Service Provider can use these reports to reconcile their monthly invoice.

The Broadworks Billing Reports APIs are RESTful. In REST, a base URL represents each resource .You use the HTTP methods GET, POST, PUT and DELETE to request data and perform actions on those resources.

For methods that accept request parameters, the platform accepts only application/json content types.

anchorAPI Error Codes

anchor

These APIs return standard HTTP status codes for request responses. For more information on standard HTTP status codes, please see Webex REST API Basics.

The following error codes may appear in API Error responses, or included in responses to subscriber Get/Search/List API requests.

In API Error responses, these are complementary to the overall HTTP Status codes and provide additional clarity on the reason for the error.

In Subscriber responses they indicate any errors that occurred during asynchronous or background subscriber provisioning.

Error Code	Detail	HTTP Status Code	Possible in Subscriber response?
1001	Null Parameter A mandatory parameter has not been specified in the API request. The `description` and `fieldName` attributes provide further detail on the missing parameter.	400	No
1002	Invalid Parameter Size A parameter in the API request is outside the bounds of expected size. The `description` and `fieldName` attributes provide further detail on the invalid parameter and the size restrictions that apply.	400	No
1003	Invalid Parameter Format A parameter in the API request is not correctly formatted. The `description` and `fieldName` attributes provide further detail on the invalid parameter. Common Causes: `email` or `userId` parameter in Provision Subscriber request are not in valid email address format. The specification of a valid email can be found in RFC 2822. `primaryPhoneNumber` parameter in Provision/Update Subscriber is not a valid BroadWorks phone number. `mobilePhoneNumber` parameter in Provision/Update Subscriber is not a valid mobile phone number `language` parameter in Provision Subscriber request is not in ISO 639-1 format. The package type specified in the Provision/Update Subscriber request is not one of `softphone`, `basic`, `standard` or `premium`.	400	No
1004	Invalid Query Parameter The query parameter specified in Subscriber or Enterprise Search/List API request is invalid. Common Causes: The `email` query parameter is not in valid email address format. The specification of a valid email can be found in RFC 2822. The `personId` query parameter is not valid.	400	No
1005	Invalid or Bad HTTP request The HTTP request message specified is either bad or invalid. Common Causes: The HTTP request message has a typographical error The HTTP request message is missing a required header e.g. `Content-Length` Refer to RFC 2616 Hypertext Transfer Protocol for more details.	400	No
2001	Subscriber Not Found The `subscriberId` specified in an API Request to Get, Update, Delete a Subscriber could not be found. Common Causes: The subscriber in question was previously deleted. The `subscriberId` specified is invalid.	404	No
2002	Subscriber pre-exists in another Cisco Webex organization Webex for BroadWorks has previously mapped the subscriber's Broadworks enterprise to a new or existing Webex organization. However, the email address associated with this subscriber has been found in a different Webex organization. Cisco cannot automatically move this subscriber to the desired organization and so provisioning fails. Common Causes: The subscriber in question already has free or paid Webex services using this email address in another Webex organization. The email address supplied is incorrect Possible Solutions: Validate that the supplied email is correct. Confirm with the customer/subscriber that their Broadworks enterprise has been mapped to the correct Webex organization. Work with the customer/subscriber to close their existing Cisco Webex account or change the email address associated with that account. Supply an alternate email address for the subscriber.	409¹	Yes¹
2003	Subscriber Update Not Allowed The subscriber update operation is not allowed because of the current provisioning status of the subscriber. Common Causes: Subscriber Provisioning/Update is currently in progress - subscriber status is `provisioning` or `updating`. Subscriber provisioning had previously failed and the subscriber status is `error`. Possible Solutions: Check current Subscriber Status. If Subscriber Provisioning is in progress, wait until status transitions to a final status of (`provisioned` or `error`) before proceeding with appropriate next step. If subscriber is in `error` status, you will need to send a new Provision Subscriber API request instead to re-provision the subscriber.	403	No
2004	Webex Organization Mismatch The subscriber Update API request failed as the subscriber is unexpectedly associated with a different Webex Organization to the one in which they were originally provisioned. Common Causes: Another Organization has claimed the subscriber, triggering an automated move of the subscriber into a new Webex organization. Possible Solutions: If the subscriber has been claimed by another organization, then they can no longer obtain Webex for BroadWorks services as part of their existing BroadWorks enterprise. Perform a Delete Subscriber operation to clean up Webex for BroadWorks provisioning for the subscriber. Then work with the customer/subscriber in question to determine next steps.	409	No
2005	Package Type Not Supported The package type specified in the Provision/Update Subscriber request is not supported. Note: This only applies where the associated Customer Template is configured with Automatically Create New Organizations in Control Hub disabled. Cause: The package type specified is syntactically valid (one of `softphone`, `basic`, `standard` or `premium`), however that specific package type is not currently supported in this mode of operation. Solution: Perform the API request again with a supported package type.	400	No
2006	Insufficient Privileges You do not have sufficient privileges to perform update/delete operations on this subscriber. Cause: The Partner Organization associated with the access token specified in the API request does not match the Partner Organization with which the subscriber was originally provisioned. Solution: Check to ensure the application making this API request has been authorized by a full administrator within the correct Partner Organization.	403	No
2007	Broadworks Enterprise not mapped to Webex Organization The Provision Subscriber API request could not be processed as the associated Broadworks Enterprise is not mapped to a pre-existing Webex Organization. Note: This only applies where the associated Customer Template is configured with Automatically Create New Organizations in Control Hub disabled. Causes: The target Webex Organization has not been created and pre-existing in Control Hub. The target Webex Organization has not been manually mapped to their Broadworks Enterprise by the Partner Administrator. Solution: If Webex organization does not exist, you must place an order for the customer via Cisco Commerce for agreed Product SKUs to trigger the organization creation. On Control Hub, map the customer organization to their Broadworks enterprise as required.	404	No
2008	Subscriber Provisioning Request Already Being Processed A Subscriber Provision or Update API request for the same subscriber is already in being processed by Cisco Webex. Cause: Two Subscriber Provision or Update API requests have been sent concurrently for the same subscriber. Cisco Webex will reject any subsequent Provision/Update requests until it has responded to the initial request. Solution: Wait until you have received a response to the initial API request before performing another operation for the same subscriber.	400	No
2009	BroadWorks UserId Already Exists A subscriber with the same BroadWorks UserId and from the same BroadWorks Cluster already exists. Cause: The request has been rejected as BroadWorks UserID is unique to a BroadWorks Cluster and a subscriber with this `userID` from this BroadWorks Cluster already exists in the Cisco Webex database. Possible Solutions: Validate the `userId` & `provisioningId` supplied in this request are correct. The `provisioningId` identifies the Customer Template and associated BroadWorks cluster. If necessary, remove the existing subscriber with the same BroadWorks UserId.	409	Yes
2010	Email Address Already In Use The `email` specified in the request to provision this subscriber is already being used by another provisioned BroadWorks subscriber Cause: A subscriber has previously been provisioned using the same email address. Note that this existing subscriber may have been provisioned by a different BroadWorks Service Provider Possible Solutions: Validate the correct email address has been specified in this attempt to provision a new subscriber. If so, use the subscriber search API to query your list of subscribers using the email address as a query parameter. If you find a match, you can determine whether or not the existing subscriber has been provisioned incorrectly. If no result is found, then the subscriber associated with the email address is likely managed by an alternate BroadWorks Service Provider; You will need to work with the subscriber and customer in question to determine next steps.	409	Yes
2011	No Organization Administrator The Subscriber Provision/Update operation could not be processed as the target customer organization on Cisco Webex does not have an administrator with Full Administrator role. Cause: All Customer Organizations on Cisco Webex should have an administrator with Full Administrator role. However, that was not the case for the customer organization associated with this BroadWorks subscriber. The administrator may be been deleted prior to this operation being performed. Possible Solutions: Assign the Full Administrator role to an existing user in this organization before trying again. If there are no users in the organization, manually create a new user via Control Hub and apply the Full Administrator role.	409	Yes
2012	Subscriber is already entitled to Webex Calling The subscriber cannot be provisioned for Webex for BroadWorks because they are already entitled to Webex Calling. Possible Solutions: Remove the conflicting entitlement before provisioning the affected subscriber (the subscriber will use BroadWorks calling, instead of their previous option). Provision the subscriber with a different email address (the subscriber will have two distinct Webex user IDs).	409	No
2013	Unknown Provisioning ID The supplied provisioning ID does not map to any of your configured Customer Templates Cause: The provisioning ID is an identifier for a specific Customer Template you have configured on Partner Hub. The Provisioning ID specified in this request does not map to any of your configured Customer Templates. Possible Solutions: Check that your expected customer template exists in Partner Hub. Check that the provisioning ID displayed for that template matches what you used in the request.	404	No
2014	Provisioning ID Mismatch The Provisioning ID specified in this request does not match the expected Provisioning ID for this subscriber’s enterprise. Cause: All subscribers within an enterprise must be provisioned with the same provisioning ID. The provisioning ID specified in this request does not match the provisioning ID used to provision previous subscribers in this enterprise. Solution: Ensure the Provisioning ID in your request matches the expected Provisioning ID for this enterprise. You can determine this by performing a GET /enterprises request for the enterprise in question. You may also determine this by performing a GET /subscribers request, supplying the BroadWorks userID of a previously provisioned subscriber from that enterprise. Alternatively, you may manually determine this via Partner Hub & Control Hub by performing the following steps: As a Sales Full Administrator within your Partner organization, sign into Partner Hub and find the associated Customer in your Customers list. Click on the Customer and select "View Customer" to open the Customer's Control Hub view. From the Customer's Control Hub Overview page, click on "..." on the "Webex Services" card and select "Manage Services". On the "Services" page you should see a "BroadWorks Calling" card, where the Template name is listed. Return to Partner Hub and view the specified Customer Template to find the associated Provisioning ID.	400	No
2015	Enterprise ID Conflict The `spEnterpriseId` specified in this request conflicts with a Service Provider or Enterprise already provisioned from this BroadWorks Cluster. Common Causes: This API enforces uniqueness validation for any BroadWorks Enterprise ID or Service Provider ID values specified in the `spEnterpriseId` parameter. This is to align with more general BroadWorks uniqueness constraints: On the BroadWorks cluster, there cannot be a Service Provider ID and Enterprise ID with the same value. Therefore Webex will reject a Subscriber Provisioning request with this error code if: An Enterprise ID specified in `spEnterpriseId` matches a Service Provider ID included in a previous request from that BroadWorks Cluster. A Service Provider ID specified in `spEnterpriseId` matches a Enterprise ID included in a previous request from that Cluster. If you encounter this error, it is an indication of issue with how you have generated the `spEnterpriseId` in (this or previous) Subscriber Provision requests for this BroadWorks cluster: You may have incorrectly included the subscriber's Group ID where the enterprise is configured as an Enterprise on BroadWorks. You may have incorrectly omitted the subscriber's Group ID where the enterprise is configured as an Group under a Service Provider on BroadWorks. See the Enterprise ID section below for more information on how to generate spEnterpriseId parameter. The key point is that even though you encounter the error on this request, the root cause be be a misconfigured `spEnterpriseId` on a previous request from this cluster. Possible Solutions: Perform the following steps to identify and fix the issue: Ensure you have specified the correct `spEnterpriseId` in this request per the Enterprise ID rules defined below. If the `spEnterpriseId` in this request is correct, then it is likely that previous subscriber provisioning request(s) specified an invalid spEnterpriseId. You will need to review all provisioned/pending subscribers and their associated spEnterpriseId. If a misconfigured `spEnterpriseId` is found then a series of steps are required to clean up the subscribers/enterprises configured in error: Deprovision all subscribers with misconfigured `spEnterpriseId` using DELETE /broadworks/subscribers/{subscriberId}. For each misconfigured `spEnterpriseId`, use the Enterprise Search API (GET /broadworks/enterprises) to retrieve any associated orgId. For each associated orgId, you have two options to clean up those organizations: Permanently delete the organization from Webex using DELETE /organizations/{orgId} API. This requires you to first fully delete all users from the organization using the DELETE /people/{personId}. This option should only be used if this organization was newly created as part of provisioning the subscriber with an incorrect spEnterpriseId. For organizations that pre-existed on Webex, proceed to the alternate option below. Manually clear any mapping between the organization and the misconfigured `spEnterpriseId` from Control Hub using the following steps. As a Sales Full Administrator within your Partner organization, sign into Partner Hub and find the associated Customer in your Customers list. Click on the Customer and select "View Customer" to open the Customer's Control Hub view. From the Customer's Control Hub Overview page, click on "..." on the "Webex Services" card and select "Manage Services". On the "Services" page you should see a "BroadWorks Calling" card. Click on the "Clear Configuration" button (This button only appears once all subscribers have been deprovisioned above). Once these deprovisioning steps have been completed, all subscribers can now be reprovisioned using the correct spEnterpriseId. If you cannot identify the cause of the conflict, please raise a Support ticket.	409	No
2016	Customer and Partner Org Region Mismatch Causes: Partner is trying to on-board a pre-existing user or a new user using an email domain which is claimed by a Webex Organization in a different region. Solution: Ensure the user and partner are in the same region (for example: a user in the EU cannot be provisioned into US region or vice versa).	409	No
2017	Unable to provision Subscriber into an Existing Webex Organization The Subscriber Provision API request was rejected as an existing Webex Organization has been discovered either with subscriber’s exact matching email or domain of the the email, but automatic subscriber provisioning into this Webex Organization is forbidden. Cause: This should only be encountered when provisioning the initial Subscriber in an Enterprise. In that case, provisioning of the Subscriber into an existing Webex Organization is forbidden where there is no pre-existing relationship on Webex between the Partner and discovered Organization plus at least one of the following scenarios is true: The discovered Organization has more than 100 users. The Organization was discovered based on claimed domain only (i.e., the subscriber's email address was not found in the Organization, but the Organization has claimed the subscriber's email domain). Possible Solutions: Ensure that the email supplied for this subscriber is valid.	409	No
2018	Webex Organization managed by a different Partner The Subscriber Provision API request failed as the Webex Organization associated with this subscriber already has Webex for BroadWorks services with a different Partner. Common Causes: The email address supplied is incorrect. The subscriber had been previously provisioned under a different Partner Organization. Possible Solutions: Ensure that the supplied email in the request is correct. If the supplied email in the request is correct, then it is likely that the customer organization associated with this BroadWorks subscriber was already created under a different Partner Organization. Then work with the customer/subscriber in question to determine next steps.	409	No
2019	Domain In Email Address Claimed by a different Webex Organization The Subscriber Provision API request was rejected as the email specified in the request uses a domain which is already claimed by a different Webex Organization. Cause: You are trying to provision a subscriber into an existing Webex Organization, associated with the spEnterpriseId parameter in the request. However the subscriber's email address has a domain claimed by an alternate Webex Organization. As that alternate Webex Organization has claimed this domain, this subscriber cannot be provisioned - with that email address - into your chosen Organization. Possible Solutions: Ensure that the correct email address is provided in the request. Ensure you have specified the expected spEnterpriseId in this request.	409	No

2027	User Migration is Pending User migration from trial account is pending, please wait until the user takes appropriate action to get provisioned. Common Causes: Partner admin trying to re-onboard user from trial account who is already present and is pending user migration. Existing pending user was attempted to be onboarded by different partner. Existing pending user was attempted to be onboarded with different userId Or spEnterpriseId. Possible Solutions: Once user from trial (consumer/self-signup) organization is deleted then user would be onboarded automatically. Please use Get a BroadWorks Subscriber API to check user status. If there is any change needed for user, please use Update a BroadWorks Subscriber API once user is successfully provisioned. If email has not been sent to the user to take appropriate action, please use the Resend Email option from the user status board in PartnerHub.	409	No

2032	User Does Not Exist In Directory Sync Organization User to be added does not currently exist in organization with Directory Sync enabled. Causes: When active directory is enabled, a user creation request cannot be made before this user is added to the active directory first. Solution: The user must first be added to the organization's active directory.	N/A	N/A
2033	User Information Differs from Organization Directory Record First Name, Last Name or Display Name is different from the organization’s active directory record. Causes: When trying to onboard a user, the given information is not the same as the information added in the active directory. Solution: Fetch the correct First Name, Last Name or Display Name from Common Identity and try onboarding the user again.	N/A	N/A


2539	Country Code Not Permitted The customer country code is not supported for provisioning.	400	Yes
3001	Missing Required Licenses The target Webex Organization does not have the required licenses ordered to allow this subscriber to be provisioned or updated with this package. Note: This only applies where the associated Customer Template is configured with Automatically Create New Organizations in Control Hub disabled. Causes: Subscription(s) have not been established via Cisco Commerce to ensure the target Webex Organization has the necessary licenses in place. Pre-existing Subscription(s) were established with the appropriate licenses for the Organization - but have since been suspended or cancelled. Solution: Check status of any existing active subscriptions for the Organization from Control Hub. Establish new subscription(s) as required via Cisco Commerce to meet the licensing requirements - using agreed Product SKUs.	400	No
4001	Invalid Service Provider Email Address The Service Provider Email Address originally configured in the Customer Template is no longer owned by an existing administrator within the Partner Organization. Possible Causes: The Original Service Provider Admin in the Partner Organization has since lost administrative privileges and is no longer an Admin. The Service Provider Admin in question has changed their email address on Cisco Webex. The Service Provider Admin in question has left or been deleted from the organization. Solution: Reconfigure the Customer Template on Control Hub with a new Service Provider email address.	Not Applicable²	Yes
5001	Internal Server Error An unexpected error has occurred while processing the API request or during subsequent subscriber provisioning in the background. The `description` will provide additional details. Solution: Please raise a Support Ticket if the issue persists.	500	Yes
5002	INVALID_PARTNER_IDP_ENTITY_ID Cause: Invalid Partner IDP Entity ID in template. Possible Solution: Update the template with a valid Partner IDP Entity ID.	400	Yes
6001	BroadWorks Directory Sync Aborted BroadWorks External Directory User Sync is aborted. Cause: BroadWorks External Directory User Sync has been aborted due to sync time out. Possible Solutions: Trigger the BroadWorks Directory sync again via Sync-now API. Trigger the BroadWorks Directory sync again by using the list of customers sync status through the partner template on Control Hub.	Not Applicable	N/A
6002	BroadWorks Directory Sync In Progress Another BroadWorks External Directory User Sync is in progress, try again later. Cause: Another Customer sync in the BroadWorks cluster is in progress or all the execution threads are busy. Possible Solutions: Wait for some time before triggering the BroadWorks Directory sync-now API. Wait for some time before triggering the BroadWorks Directory sync again by using the list of customers sync status through the partner template on Control Hub.	503 or 429	N/A
6003	BroadWorks Cluster CTI Failure BroadWorks External Directory User Sync failed while trying to connect to BroadWorks cluster. Cause: The BroadWorks cluster is not configured correctly or the BroadWorks cluster connection timed out. Possible Solutions: Verify the BroadWorks cluster settings. Verify the CTI URL and CTI Port used and test the connection.	Not Applicable	N/A
6004	Enterprise Directory Sync Not Enabled BroadWorks External Directory User Sync is not enabled for the enterprise. Cause: Admin is trying to sync an enterprise for which Directory sync is disabled. Possible Solutions: Enable Broadworks directory sync for the enterprise using the Directory sync configuration API. Enable Broadworks directory sync for the enterprise by using the list of customers sync status through the partner template on Control Hub.	400	N/A
6005	Hybrid Directory Sync Already Enabled for Enterprise BroadWorks External Directory User Sync cannot be run as the Hybrid Directory sync is already enabled for the enterprise. Cause: Admin has enabled the Hybrid Directory sync. Possible Solutions: Disable the Hybrid directory sync. Enable the Broadworks directory sync using the Directory sync configuration API. Trigger Broadworks Directory sync-now API.	409	N/A
6006	Enterprise Not Found The enterprise does not exist in the Partner Org. Cause: The enterprise is not present in the database. The enterprise is not managed by the specified Partner. Possible Solutions: Verify if that enterprise really exists by executing the List BroadWorks Enterprises public API with the enterprise name. If the enterprise exists, verify that you have the correct enterprise ID. If it doesn’t exist, please make sure the correct spEnterpriseID was provided.	404	N/A
6007	Enterprise Directory Sync Can Not be Disabled BroadWorks External Directory User Sync cannot be disabled as sync is in progress for the enterprise. Cause: Admin is trying to disable directory sync for an Enterprise for which sync is in-progress. Possible Solutions: Verify the sync status of the enterprise is not in IN-PROGRESS by executing the Get Directory Sync Status for an Enterprise public API with correct enterprise ID. If the sync status is IN-PROGRESS wait for the sync to complete.	409	N/A

6013	Enterprise Does Not Have A Provisioned User BroadWorks External Directory User Sync failed since the enterprise has no provisioned user. Cause: This happens when the enterprise does not have any fully provisioned user Possible Solutions: Make sure that the enterprise has a fully provisioned subscriber.	Not Applicable	N/A

Notes:

Where Trusted Email addresses are being used, Error Code 2002 will be returned early in a 409 Conflict response. For Untrusted Email or Self Activation based Customer Templates however, this check happens in the during background subscriber provisioning once a valid email address has been obtained. In that case, the provisioning attempt will fail and the subscriber representation will show Error Code 2002 as the reason for the failure.
Error Code 4001 is only generated during asynchronous subscriber provisioning. As such, It will not be returned during API request handling and never be associated with an HTTP status code.

anchorBackward Compatibility and Versioning

anchor

Our APIs change over time as we build new functionality. However, we are aware that API users need their applications to continue working as expected when the APIs change.

For that reason, our APIs follow a backward-compatibility and versioning strategy as follows:

When we add new API endpoints, new query parameters to existing endpoints, new optional fields in request bodies, and new data in response bodies, we do not necessarily create a new version of the API. Those kinds of changes should not affect the compatibility of the API with existing calls to the API, and we expect your applications to be robust to those kinds of improvements to the API.

When we need to change the API outside of the scope described above, we create a new version of the API. For example, if we added a new required field to the request body, your application would not be aware of that requirement. If we changed the original version, your application would experience an unexpected failure.

When we create a new version of an API, we continue to support the original version of the API for a reasonable period of time. This enables your application to continue working while you adapt it to using the new version of the API.

We have an API framework team that works across the Cisco collaboration portfolio to approve any API changes before they are rolled out, ensuring that our backwards compatibility requirements are met and avoiding unpleasant surprises for our developer community.

anchorAuthentication

anchor

When registering your application as an Integration, enable the following scopes to access all Webex for BroadWorks Provisioning:

Scope

Usage

spark-admin:places_write

Create, update and delete any place and place service in your organization

spark-admin:broadworks_enterprises_read

Read or List BroadWorks Enterprise, provisioned as part of Webex for BroadWorks Solution.

spark-admin:broadworks_subscribers_read

Read or List BroadWorks Subscribers, provisioned as part of Webex for BroadWorks Solution.

spark-admin:broadworks_subscribers_write

Provision, Update or Remove a BroadWorks Subscriber as part of Webex for BroadWorks Solution.

spark-admin:broadworks_enterprises_write

Change BroadWorks Enterprise configuration, provisioned as part of Webex for BroadWorks Solution.

If a Refresh Token expires, then the application can no longer generate the necessary access tokens for this API. A Service Provider admin needs to reauthorize the application to gain access to the APIs again. So, it's important that your application maintains an active Refresh Token. Generating a new access token automatically renews the lifetime of your Refresh Token. An application that is regularly generating new access tokens will also be renewing it's Refresh Token lifetime.However, if the application becomes inactive for a long period of time (Refresh token expiry is 90 days) then it runs the risk of allowing the Refresh Token to expire.Therefore, it is recommended that your application runs a scheduled task/job that generates a new access token using the Refresh Token. This ensures the Refresh Token will not expire, even during periods of inactivity.

Handling 403s when creating and deleting users and organizations

If you attempt to delete an object that you have created less than 24 hours ago via the /people or /organizations API endpoints, the DELETE may return a 403.

The recommendation in this scenario is to refresh the access token on receiving the 403 error response and retry the DELETE operation.

anchorAsynchronous Provisioning Model

anchor

Subscriber provisioning on Cisco Webex can take considerable time. Therefore, the Webex for BroadWorks provisioning APIs don’t wait or block until subscriber is fully provisioned. Instead, the API responds quickly while initiating subscriber provisioning as a background task.

You can design your application to query the subscriber later to determine its provisioning status. All representations of the subscriber through the APIs include a “status” attribute to indicate the subscriber’s provisioning status:

On successful completion, the subscriber status changes to “provisioned”.If any error occurs during provisioning, the user status transitions to “error”. The subscriber representation through these APIs also includes specific error codes and the reasons behind the provisioning error.

anchorEnterprise ID

anchor

When provisioning a BroadWorks subscriber for Webex for BroadWorks, one of the required parameters is the spEnterpriseId. This parameter defines a unique identifier for subscriber's enterprise on BroadWorks.

This table defines how to supply the spEnterpriseId value for your model:

Enterprise Configuration Model	Logic	Description	Example enterpriseID
Enterprise Model	Individual customers are configured as Enterprises on BroadWorks.	The spEnterpriseId must be an exact match of the Enterprise ID on BroadWorks: `"<Enterprise ID>"`	“Acme”
Service Provider Model	Individual customers are configured as Groups under a Service Provider on BroadWorks.	The spEnterpriseId must be a concatenation of Service Provider ID and Group ID on BroadWorks, separated by a plus, as follows: `"<Service Provider ID>" + "+" + "<Group ID>"`	“SP1+Acme"

anchorSubscriber Deletion

anchor

Webex for APIs supports both a soft and hard deletion model for subscribers. Soft Delete—The Webex for BroadWorks Subscriber Delete API removes all entitlements and capabilities from when the subscriber was first provisioned for Webex for BroadWorks. But, the subscriber remains provisioned within their Customer organization on Cisco Webex. The subscriber may continue to use Webex in line with their remaining capabilities. Hard Delete—If you wish to remove the subscriber completely from Cisco Webex, perform a DELETE with the People APIs.

For more information about Webex for BroadWorks, please see the Webex for BroadWorks Solution Guide.

anchorOrganization Deletion

anchor

Follow the instructions below in order to delete an organization that has BroadWorks Directory Synchronization related users:

anchorWebex Meetings Site Timezone

anchor

If a specific Webex Meetings site timezone is required, please specify the timezone parameter in the provisioning request for:

the first subscriber provisioned for Standard package in the organization.the first subscriber provisioned for Premium package in the organization.

The first subscriber for each package dictates the timezone for the Webex Meetings site for that package.

If no timezone is specified in the provisioning request for the first user of each package, the Webex Meetings site timezone for that package is set to a default based on the country assigned to the organization. In the case that a new organization is being created, the timezone is based on the country selected in the Customer Template referenced in the provisioning request.

Here are the default cities/timezones for each country:

Country	City [Timezones]
Afghanistan	Kabul [Asia/Kabul]
Albania	Amsterdam [Europe/Amsterdam]
Algeria	West Africa [Africa/Douala, Africa/Lagos]
Andorra	Amsterdam [Europe/Amsterdam]
Angola	West Africa [Africa/Douala, Africa/Lagos]
Anguilla	Halifax [America/Puerto_Rico, America/Halifax]
Antigua and Barbuda	Halifax [America/Puerto_Rico, America/Halifax]
Argentina	Buenos Aires [America/Argentina/La_Rioja, America/Argentina/Jujuy, America/Argentina/San_Luis, America/Argentina/Catamarca, America/Argentina/Santiago_del_Estero, America/Argentina/Ushuaia, America/Buenos_Aires, America/Argentina/Cordoba, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/Tucuman, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Buenos_Aires]
Armenia	Yerevan [Asia/Yerevan]
Aruba	Halifax [America/Puerto_Rico, America/Halifax]
Australia	Sydney [Australia/Sydney]
Austria	Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich]
Azerbaijan	Baku [Asia/Baku]
Bahamas	Indiana [America/Indianapolis, America/Fort_Wayne]
Bahrain	Riyadh [Asia/Riyadh]
Bangladesh	Mumbai [Asia/Kolkata]
Barbados	Halifax [America/Puerto_Rico, America/Halifax]
Belarus	Moscow [Europe/Moscow]
Belgium	Brussels [Europe/Brussels]
Belize	Chicago [America/Chicago, America/Costa_Rica]
Benin	West Africa [Africa/Douala, Africa/Lagos]
Bermuda	Halifax [America/Puerto_Rico, America/Halifax]
Bhutan	Almaty [Asia/Almaty]
Bolivia	La Paz [America/La_Paz]
Bonaire, Saint Eustatius and Saba	Halifax [America/Puerto_Rico, America/Halifax]
Bosnia and Herzegovina	Amsterdam [Europe/Amsterdam]
Botswana	Windhoek [Africa/Windhoek]
Brazil	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
Brunei Darussalam	Kuala Lumpur [Asia/Kuala_Lumpur]
Bulgaria	Helsinki [Europe/Helsinki]
Burundi	Windhoek [Africa/Windhoek]
Cambodia	Bangkok [Asia/Bangkok, Asia/Saigon]
Cameroon	West Africa [Africa/Douala, Africa/Lagos]
Canada	Toronto [America/Montreal, America/Toronto]
Cape Verde	Cape Verde [Atlantic/Cape_Verde]
Cayman Islands	Panama [America/Panama]
Chile	Santiago [America/Santiago, America/Punta_Arenas, Pacific/Easter]
China	Beijing [Asia/Hong_Kong, Asia/Shanghai]
Colombia	Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos]
Comoros	Nairobi [Africa/Nairobi]
Costa Rica	Chicago [America/Chicago, America/Costa_Rica]
Cote d'Ivoire	London [Europe/London, Europe/Dublin]
Croatia	Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen]
Curacao	Caracas [America/Caracas]
Cyprus	Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius]
Czech Republic	Prague [Europe/Ljubljana, Europe/Budapest, Europe/Zagreb, Europe/Prague]
Denmark	Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen]
Dominican Republic	Caracas [America/Caracas]
Ecuador	Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos]
Egypt	Cairo [Africa/Cairo]
El Salvador	Chicago [America/Chicago, America/Costa_Rica]
Estonia	Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius]
Ethiopia	Nairobi [Africa/Nairobi]
Faroe Islands	London [Europe/London, Europe/Dublin]
Fiji	Fiji [Pacific/Fiji]
Finland	Helsinki [Europe/Helsinki]
France	Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen]
French Guiana	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
French Polynesia	Honolulu [Pacific/Honolulu]
Georgia	Istanbul [Europe/Istanbul]
Germany	Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich]
Ghana	London [Europe/London, Europe/Dublin]
Greece	Athens [Europe/Athens]
Greenland	Nuuk [America/Godthab]
Guadeloupe	Caracas [America/Caracas]
Guatemala	Mexico City [America/Mexico_City]
Honduras	Tegucigalpa [America/Tegucigalpa]
Hong Kong	Beijing [Asia/Hong_Kong, Asia/Shanghai]
Hungary	Prague [Europe/Ljubljana, Europe/Budapest, Europe/Zagreb, Europe/Prague]
Iceland	Reykjavik [Atlantic/Reykjavik]
India	Colombo [Asia/Colombo]
Indonesia	Jakarta [Asia/Jakarta]
Iraq	Riyadh [Asia/Riyadh]
Ireland	London [Europe/London, Europe/Dublin]
Isle of Man	London [Europe/London, Europe/Dublin]
Israel	Tel Aviv [Asia/Tel_Aviv, Asia/Jerusalem]
Italy	Rome [America/Tunis, Europe/Malta, Europe/Rome]
Jamaica	Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos]
Japan	Tokyo [Asia/Tokyo]
Jersey	London [Europe/London, Europe/Dublin]
Jordan	Amman [Asia/Amman]
Kazakhstan	Almaty [Asia/Almaty]
Kenya	Nairobi [Africa/Nairobi]
Korea, Republic of	Seoul [Asia/Seoul]
Kuwait	Riyadh [Asia/Riyadh]
Kyrgyzstan	Almaty [Asia/Almaty]
Lao People's Democratic Republic	Bangkok [Asia/Bangkok, Asia/Saigon]
Latvia	Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius]
Lebanon	Windhoek [Africa/Windhoek]
Libyan Arab Jamahiriya	Windhoek [Africa/Windhoek]
Liechtenstein	Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich]
Lithuania	Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius]
Luxembourg	Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen]
Macao	Beijing [Asia/Hong_Kong, Asia/Shanghai]
Macedonia	Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich]
Madagascar	Nairobi [Africa/Nairobi]
Malawi	Windhoek [Africa/Windhoek]
Malaysia	Kuala Lumpur [Asia/Kuala_Lumpur]
Maldives	Yekaterinburg [Asia/Yekaterinburg]
Mali	London [Europe/London, Europe/Dublin]
Malta	Rome [America/Tunis, Europe/Malta, Europe/Rome]
Marshall Islands	Marshall Islands [Pacific/Majuro]
Martinique	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
Mauritius	Abu Dhabi, Muscat [Asia/Dubai]
Mayotte	Nairobi [Africa/Nairobi]
Mexico	Mexico City [America/Mexico_City]
Moldova, Republic of	Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen]
Monaco	Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen]
Mongolia	Beijing [Asia/Hong_Kong, Asia/Shanghai]
Montenegro	Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich]
Morocco	Casablanca [Africa/Casablanca]
Mozambique	Windhoek [Africa/Windhoek]
Namibia	Windhoek [Africa/Windhoek]
Nepal	Kathmandu [Asia/Kathmandu]
Netherlands	Amsterdam [Europe/Amsterdam]
New Caledonia	Solomon Is [Pacific/Guadalcanal]
New Zealand	Wellington [Pacific/Auckland]
Nicaragua	Tegucigalpa [America/Tegucigalpa]
Nigeria	West Africa [Africa/Douala, Africa/Lagos]
Norway	Oslo [Europe/Oslo]
Oman	Abu Dhabi, Muscat [Asia/Dubai]
Pakistan	Islamabad [Asia/Karachi]
Palestinian Territory	Tel Aviv [Asia/Tel_Aviv, Asia/Jerusalem]
Panama	Panama [America/Panama]
Papua New Guinea	Guam [Pacific/Guam]
Paraguay	Asuncion [America/Asuncion]
Peru	Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos]
Philippines	Beijing [Asia/Hong_Kong, Asia/Shanghai]
Poland	Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich]
Portugal	London [Europe/London, Europe/Dublin]
Puerto Rico	Halifax [America/Puerto_Rico, America/Halifax]
Qatar	Riyadh [Asia/Riyadh]
Reunion	Abu Dhabi, Muscat [Asia/Dubai]
Romania	Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius]
Russian Federation	Moscow [Europe/Moscow]
Rwanda	Windhoek [Africa/Windhoek]
Saint Kitts and Nevis	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
Saint Lucia	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
Saint Martin	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
Saint Vincent and the Grenadines	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
San Marino	Rome [America/Tunis, Europe/Malta, Europe/Rome]
Saudi Arabia	Riyadh [Asia/Riyadh]
Senegal	London [Europe/London, Europe/Dublin]
Serbia	Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen]
Seychelles	Abu Dhabi, Muscat [Asia/Dubai]
Singapore	Singapore [Asia/Singapore]
Sint Maarten	Caracas [America/Caracas]
Slovakia	Prague [Europe/Ljubljana, Europe/Budapest, Europe/Zagreb, Europe/Prague]
Slovenia	Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen]
South Africa	Pretoria [Africa/Johannesburg]
Spain	Madrid [Europe/Gibraltar, Europe/Madrid]
Sri Lanka	Colombo [Asia/Colombo]
Suriname	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
Sweden	Stockholm [Europe/Stockholm]
Switzerland	Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich]
Taiwan	Taipei [Asia/Taipei]
Tajikistan	Yekaterinburg [Asia/Yekaterinburg]
Tanzania, United Republic of	Nairobi [Africa/Nairobi]
Thailand	Bangkok [Asia/Bangkok, Asia/Saigon]
Timor-Leste	Seoul [Asia/Seoul]
Togo	London [Europe/London, Europe/Dublin]
Tonga	Tonga [Pacific/Tongatapu]
Trinidad and Tobago	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
Tunisia	West Africa [Africa/Douala, Africa/Lagos]
Turkey	Istanbul [Europe/Istanbul]
Turkmenistan	Yekaterinburg [Asia/Yekaterinburg]
Turks and Caicos Islands	Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos]
Uganda	Nairobi [Africa/Nairobi]
Ukraine	Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius]
United Arab Emirates	Abu Dhabi, Muscat [Asia/Dubai]
United Kingdom	London [Europe/London, Europe/Dublin]
United States	San Francisco [America/Los_Angeles]
United States Minor Outlying Islands	Honolulu [Pacific/Honolulu]
Uruguay	Montevideo [America/Montevideo]
Uzbekistan	Yekaterinburg [Asia/Yekaterinburg]
Venezuela	Caracas [America/Caracas]
Vietnam	Bangkok [Asia/Bangkok, Asia/Saigon]
Virgin Islands, U.S.	Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco]
Zambia	Cairo [Africa/Cairo]
Zimbabwe	Cairo [Africa/Cairo]

In the event of a problem with converting the country to a Webex Meetings Site Timezone, the following default per cluster value will be used:

Cluster	City [Timezones for this city]
US-A (ACHM)	New York [America/New_York]
US-B (AORE)	San Francisco [America/Los_Angeles]
EU (AFRA)	London [Europe/London, Europe/Dublin]