Webex for Wholesale
Cisco Webex for Wholesale is an offer that allows Partners to use the Webex Suite as a Package based Utility Model. Learn how to use the Webex for Wholesale Provisioning APIs.
The Webex for Wholesale Provisioning API is for the Service Providers (SPs) who sign up for Cisco Webex for Wholesale. The API enables those SPs to provision, update, and remove wholesale customer/subscribers.
For more information about Webex for Wholesale, please see the Webex for Wholesale Route-to-Market Solution Guide.
Provisioning Precheck APIs
The Webex for Wholesale Provisioning Precheck APIs are for Partner Sales team to determine the likely success of a customer or subscriber provisioning. The info codes used by the Provisioning Precheck APIs are defined in the Provisioning Precheck API Info Codes section. For more information, see Using the Provisioning Precheck API.
Provisioning APIs
The Webex for Wholesale Provisioning API is for the Service Providers (SPs) who sign up for Cisco Webex for Wholesale. The API enables those SPs to provision, update, and remove wholesale customer/subscribers. Error codes used by the Provisioning API are defined in the API Error Codes section.
Wholesale Customer Provisioning APIs
- View Wholesale Customers
- Provision a Wholesale Customer
- View a Wholesale Customer
- Update a Wholesale Customer
- Delete a Wholesale Customer
Wholesale Subscriber Provisioning APIs
- View Wholesale Subscribers
- Provision a Wholesale Subscriber
- View a Wholesale Subscriber
- Update a Wholesale Subscriber
- Delete a Wholesale Subscriber
Billing Reports APIs
The Wholesale Billing Reports Public APIs are a set of APIs that are targeted at Service Providers who sign up to the Webex for Wholesale solution. These APIs provides partner, customer and user breakdown reports to the Service Providers or Partners. Service Providers can use these reports to reconcile their monthly invoice.
If partner has sub-partner relationships created, then partner can use an additional parameter subPartnerOrgId
in Create a Wholesale Billing Report to generate individual sub-partner reports to reconcile their monthly invoice.
anchorAPI Backward Compatibility
anchorThe APIs defined in this guide change over time as functionality is added, deprecated, or changed. The strategy defined below is followed for any changes, to minimise disruption to users and applications that implement the API.
- Any significant change to an API is announced in the API Changelog. This applies for breaking changes as well as new functionality and backward compatible changes.
- New API endpoints, new query parameters on existing endpoints, new optional fields in request bodies, and new data in response bodies should not affect the compatibility of the API with existing calls to the API. Applications that use the API should be robust to these improvements.
- When the API needs to change outside of the scope described above, a Breaking Change will be announced in the API Changelog, with details of the change and an expected implementation date.
anchorAuthentication
anchorWhen registering your application as an Integration, enable the following scopes to access all Webex for Wholesale APIs:
spark-admin:wholesale_customers_write
spark-admin:wholesale_customers_read
spark-admin:wholesale_subscribers_write
spark-admin:wholesale_subscribers_read
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. Therefore, it's important that your application maintain 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 its 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 run a scheduled task or job that generates a new access token using the Refresh Token. This ensures the Refresh Token will not expire, even during periods of inactivity.
anchorAsynchronous Provisioning Model
anchorWholesale organization provisioning on Cisco Webex can take considerable time. Therefore, the Webex for Wholesale organization provisioning APIs don’t wait or block until organization is fully provisioned. Instead, the API responds quickly while initiating organization provisioning as a background task.
You can design your application to query the wholesale organization later to determine its provisioning status. All representations of the organization through the APIs include a “status” attribute to indicate the organization’s provisioning status:
On successful completion, the organization status changes to “provisioned”. If any error occurs during provisioning, the organization status transitions to “error”. The organization representation through these APIs also includes specific error codes and the reasons behind the provisioning error.
anchorUsing the Provisioning Precheck API
anchorThe Webex for Wholesale Provisioning Precheck APIs are for Partner Sales team to determine the likely success of a customer or subscriber provisioning who sign up for Cisco Webex for Wholesale. The Precheck APIs supports two variants of Wholesale Customer Provisioning Precheck Requests and three variants of Wholesale Subscriber Provisioning Precheck Requests.
Wholesale Customer Provisioning Precheck API
Sample partial provisioning request with customerInfo.primaryEmail
and address
parameters:
{
"customerInfo" : {
"primaryEmail" : "john.anderson@acme.com"
},
"address": {
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
}
}
Sample full provisioning request with provisioningId
, packages
, orgId
, externalId
, address
, customerInfo
and provisioningParameters
parameters:
{
"provisioningId": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
"packages": [
"common_area_calling",
"webex_calling",
"webex_meetings",
"webex_suite"
],
"orgId": "Y2lzY29zcGFyazovL3VzL09SRtR",
"externalId": "c1677a16-557a-…",
"address": {
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
},
"customerInfo": {
"name": "John's Pizza",
"primaryEmail": "john.anderson@acme.com"
},
"provisioningParameters": {
"calling": {
"location": {
"name": "Head Office",
"address": {
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
},
"timezone": "America/Los_Angeles",
"language": "en_us",
"emergencyLocationIdentifier": "95547321"
}
},
"meetings": {
"timezone": "America/Los_Angeles"
}
}
}
Wholesale Subscriber Provisioning Precheck API
Sample partial provisioning request with customerInfo.primaryEmail
and email
parameters:
{
"customerInfo" : {
"primaryEmail" : "john.anderson@acme.com"
},
"email": "alice.anderson@acme.com"
}
Sample partial provisioning request with customerId
and email
parameters:
{
"customerId": "Y2lzY29zcGFyazovL3VzL09vL3VzL0VOVEVSUFJJU0UvNTJSRtR"
"email": "alice.anderson@acme.com"
}
Sample full provisioning request with customerId
, provisioningId
, email
, package
, provisioningParameters
parameters:
{
"customerId" : "Y2lzY29zcGFyazovL3VzL09vL3VzL0VOVEVSUFJJU0UvNTJSRtR",
“provisioningId” : “Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4”,
“email” : “john.anderson@acme.com”,
"package" : "webex_suite",
“provisioningParameters” : {
"firstName" : "John",
"lastName" : "Anderson",
"primaryPhoneNumber" : "+ 1-240-555-1212",
"extension" : "51212",
"locationId" : "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtIyMmMtNDY3YzUxNTkxOTA4"
}
}
Sample full provisioning request with customerId
, provisioningId
, email
, packages
, provisioningParameters
parameters:
{
"customerId" : "Y2lzY29zcGFyazovL3VzL09vL3VzL0VOVEVSUFJJU0UvNTJSRtR",
“provisioningId” : “Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4”,
“email” : “john.anderson@acme.com”,
"packages" : [
"webex_suite",
],
“provisioningParameters” : {
"firstName" : "John",
"lastName" : "Anderson",
"primaryPhoneNumber" : "+ 1-240-555-1212",
"extension" : "51212",
"locationId" : "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtIyMmMtNDY3YzUxNTkxOTA4"
}
}
anchorWholesale Customer Identities
anchorWholesale Customers are referenced by different identities across the Webex platform. This section describes these identities and how integrations should transition between each identity depending on what Webex API you are integrating with.
Common Identity Organization ID
This is the identifier for the Customer on core internal services such as Common Identity. This is a Universal Unique Identifier (UUID). It is leveraged primarily by Identity specific APIs.
Webex Organization ID
This is the public identifier for all Webex Customer Organizations. It is used across the majority of Webex APIs.
It is a base64Url encoding of the following string: ciscospark://us/ORGANIZATION/{IdentityOrgUUID}
where IdentityOrgUUID
represents the Common Identity Organization ID.
A sample string to be encoded would look as follows: ciscospark//us/ORGANIZATION/03b4d559-9bfd-4066-a692-d1faefd0c599
.
Wholesale Customer ID
Wholesale Customers can exist and be referenced via Wholesale APIs prior to full provisioning on the Webex Platform. As such a distinct identifier is needed to represent such customers. The Wholesale Customer ID represents that distinct identifier.
Once the customer is fully provisioned, their associated Webex Organization ID is returned in response to any Wholesale Customer API.
Transition between Wholesale Customer ID and Webex Organization ID
Wholesale Customer API payload includes both the Wholesale Customer ID and the Webex Organization ID.
See sample response from GET /wholesale/customers/{id}
below, with Wholesale Customer ID id
and Webex Organization ID orgId
.
{
"id": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
"orgId": "Y2lzY29zcGFyay8vdXMvT1JHQU5JWkFUSU9OLzAzYjRkNTU5LTliZmQtNDA2Ni1hNjkyLWQxZmFlZmQwYzU5OQ==",
"externalId": "c100012",
"address" :{
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
},
"status": "provisioned",
"packages": [
"webex_calling"
],
"resourceDetails": {
"packages": [{
"name": "webex_calling",
"status": "provisioned"
}]
}
}
The orgId
attribute is included as soon as the customer has been provisioned on the Webex platform. As required, this attribute can be used directly as customer org identifier to for the majority of other Webex APIs.
Additionally, the Wholesale Customer List/Search API allows searching by orgId: GET /wholesale/customers?orgId=xxxxx
. This allows developers to discover the associated Wholesale Customer and transition back to Wholesale Customer ID as needed.
Transition between Webex Organization ID and Common Identity Organization ID
The Webex Organization ID is a base64-encoded string that includes the underlying Common Identity Organization ID. It is straightforward to transition between either format as required. Below are high level steps needed to perform the transitions.
Retrieve the Common Identity Organization ID from the Webex Organization ID:
- Base64Url decode the Webex Organization ID. The decoded string will be formatted as follows:
ciscospark://us/ORGANIZATION/{IdentityOrgUUID}
. - Remove the
ciscospark://us/ORGANIZATION/
prefix from the decoded string to leave the Common Identity Org UUID.
Generate a Webex Organization ID from Common Identity Organization ID:
- Concatenate the
ciscospark://us/ORGANIZATION/
prefix plus the Common Identity Organization ID into a single string:ciscospark//us/ORGANIZATION/{IdentityOrgUUID}
. - Base64Url encode this string to generate the Webex Organization ID.
For example:
- Common Identity Organization ID:
03b4d559-9bfd-4066-a692-d1faefd0c599
. - Concatenated String:
ciscospark://us/ORGANIZATION/03b4d559-9bfd-4066-a692-d1faefd0c599
. - Base64Url Encoded Webex Organization ID:
Y2lzY29zcGFyay8vdXMvT1JHQU5JWkFUSU9OLzAzYjRkNTU5LTliZmQtNDA2Ni1hNjkyLWQxZmFlZmQwYzU5OQ==
.
anchorManaging your customer organizations
anchorOnce your Wholesale customer has been provisioned, you may then use the broader set of administrative APIs documented on this portal to manage services for your customer.
spark-admin:wholesale_customers_write
spark-admin:wholesale_customers_read
spark-admin:wholesale_subscribers_write
spark-admin:wholesale_subscribers_read
In order to manage service for a specific customer, you must first request management access by calling the GET Organizations Details API. This will grant you temporary access to the customer organization. You may then proceed to manage the customer via the desired API.
If you find any attempt to manage your customer via API set returns a 403 Forbidden response, it may be that your temporary access to the customer has expired. In such cases, call the GET Organizations Details API again to re-establish the desired access before proceeding with your management operation.
Note: You can expect a short delay (5 seconds) after the above request before management access to the customer organization is fully established.
anchorImplementation Notes
anchorWholesale Customer Address Requirement
The billing address and calling address of the customer should be provided per the below guidelines:
Attribute | Mandatory |
---|---|
addressLine1 | Yes |
addressLine2 | No |
city | Yes |
stateOrProvince | Mandatory for some geographic locations. |
zipOrPostalCode | Mandatory for some geographic locations. |
country | Yes |
Subscriber Deletion
Webex for Wholesale APIs supports both a soft and hard deletion model for subscribers.
- Soft Delete: The Webex for Wholesale Delete a Wholesale Subscriber removes all entitlements and capabilities from when the subscriber was first provisioned for Webex for Wholesale. 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.
Organization Deletion
Follow the instructions below in order to delete an organization.
- Delete all subscribers from the organization using the Delete a Person API.
- The removal of users may take some time depending on quantity of users.
- Delete all workspace from the organization.
- Soft Delete—The Webex for Wholesale Delete a wholesale customer removes entitlements and Webex calling capabilities from the organization from when the customer was first provisioned for Webex for Wholesale. But, the customer remains provisioned within their Partner organization on Cisco Webex.
- Hard Delete—If you wish to remove the Organization completely from Cisco Webex, perform a DELETE with the Delete Organization.
- Using Delete a wholesale customer API.
- The organization now can be deleted using the Delete Organization API.
anchorWebex Meetings Site Timezone
anchorIf a specific Webex Meetings site timezone is required, please specify the meeting timezone parameter in the organization provisioning request for packages webex_suite
, webex_meetings
, webex_calling
.
If no timezone is specified in the provisioning request, 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 specified 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] |
anchorProvisioning Precheck API Info Codes
anchorThis table defines the Info codes used by the Wholesale Provisioning Precheck APIs.
Info Code | Description |
---|---|
100 | Provisioning preCheck validation successful. |
101 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. |
102 | Provisioning will succeed, user specified in the request will be automatically moved from the Consumer/Self Sign-up organization to a new Webex organization. |
103 | Provisioning will succeed, user specified by 'email' will be automatically moved from the Consumer/Self Sign-up organization to the same organization as the user specified by primaryEmail' or other customer identifier. |
104 | Provisioning will succeed, user specified by 'email' will be moved with their consent from the Consumer/Self Sign-up organization to the same organization as the user specified by 'primaryEmail' or other customer identifier. |
105 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. User specified by 'email' will be automatically moved from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. |
106 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. User specified by 'email' will be moved with their consent from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. |
107 | Provisioning will succeed, user/customer specified in the request already has a Webex Organization, the provisioned package will be attached to this organization. |
108 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. Both the user specified by 'primaryEmail' and the user specified by 'email' will be automatically moved from the Consumer/Self Sign-up organization to a new Webex organization. |
109 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. The user specified by 'primaryEmail' will be automatically moved from the Consumer/Self Sign-up organization to a new Webex organization. The user specified by 'email' will be moved with their consent from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. |
110 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first, this user/customer already has a Webex Organization, any provisioned package will be attached to this user/organization. The user specified by 'email' will be added to the same organization as the user/customer specified by 'primaryEmail'. |
111 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. The user specified by 'primaryEmail' will be automatically moved from the Consumer/Self Sign-up organization to a new Webex organization. The user specified by 'email' will be added to the same organization as the user/customer specified by 'primaryEmail'. |
112 | Provisioning will succeed, user/customer specified by 'primaryEmail' and user specified by 'email' already have the same existing Webex Organization. The user/customer specified by 'primaryEmail' must be provisioned first, any provisioned package will be attached to these users and their organization. |
113 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first, this user/customer already has a Webex Organization, any provisioned package will be attached to this user/organization. The user specified by 'email' will be automatically moved from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. |
114 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first, this user/customer already has a Webex Organization, any provisioned package will be attached to this user/organization. The user specified by 'email' will be moved with their consent from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. |
115 | Provisioning will succeed, the user specified by 'email' in the request is already a part of the requested Webex Organization, the provisioned package will be attached to this user. |
116 | Provisioning will succeed, user/customer specified by 'primaryEmail' or other customer identifier already has a Webex Organization, any provisioned package will be attached to this user/organization. |
anchorAPI Error Codes
anchorThese 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 Wholesale Get/Create/List API requests. These are complementary to the overall HTTP Status codes and provide additional clarity on the reason for the error.
Note: This list of error codes is shared between Webex for Wholesale and Webex for BroadWorks; it contains codes common to both offerings, as well as offering-specific codes.
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. Common Cause:
| 400 | No |
1004 | Invalid Query Parameter The query parameter specified in Subscriber or Customer Search/List API request is invalid. Common Cause:
| 400 | No |
1005 | Invalid or Bad HTTP request The HTTP request message specified is either bad or invalid. Common Cause:
| 400 | No |
2001 | Subscriber Not Found The subscriberId specified in an API Request to Get, Update, Delete a Subscriber could not be foundCommon Cause:
| 404 | No |
2002 | Subscriber pre-exists in another Cisco Webex Organization The subscriber has previously mapped 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 Cause:
Possible Solutions:
| 409 | Yes |
2003 | Subscriber Update Not Allowed User Not Found The subscriber update operation is not allowed because the corresponding user cannot be found. Common Cause:
Possible Solutions:
| 404 | 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 Cause: 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.
| 409 | No |
2005 | Package Type Not Supported The package type specified in the Provision/Update request is not supported. Note: This only applies where the associated Customer Template is configured with Automatically Create New Organizations in Control Hub disabled. Common Cause:
Possible Solution:
| 400 | No |
2006 | Insufficient Privileges You do not have sufficient privileges to perform update/delete operations on this subscriber. Common Cause:
Possible Solution:
| 403 | No |
2007 | Broadworks Enterprise not mapped to Cisco 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. Common Cause:
| 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. Common Cause:
Possible Solution:
| 400 | No |
2009 | BroadWorks User ID Already Exists A subscriber with the same BroadWorks userId and from the same BroadWorks Cluster already exists.Common 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:
| 409 | Yes |
2010 | Email Address Already In Use The email specified in the request is already being used by another provisioned BroadWorks subscriber.Common Cause:
| 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. Common Cause:
| 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:
| 409 | No |
2013 | Unknown Provisioning ID The supplied provisioningId does not map to any of your configured Customer Templates.Common Cause:
Possible Solutions:
| 404 | No |
2014 | Provisioning ID Mismatch The provisioningId specified in this request does not match the expected Provisioning ID for this subscriber’s enterprise.Common 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. Possible Solution: Ensure the Provisioning ID in your request matches the expected Provisioning ID for this enterprise.
| 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 Cause: 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:
spEnterpriseId in (this or previous) Subscriber Provision requests for this BroadWorks cluster:
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:
If you cannot identify the cause of the conflict, please raise a Support ticket. | 409 | No |
2016 | Customer and Partner Org Region Mismatch Common Cause: 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. Possible 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. Common Cause:
Possible Solutions:
| 409 | No |
2018 | Webex Organization managed by a different Partner Webex for Broadworks 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 Cause:
Webex for Wholesale The Customer Provision API request failed as the Webex Organization associated with this customer already has Webex for Wholesale services with a different Partner. Common Cause:
| 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. Common Cause:
| 409 | No |
2020 | Subscriber Update Not Allowed Due To Conflicting Current Status The subscriber update operation is not allowed because of the current provisioning status of the subscriber. Common Cause:
Possible Solutions:
| 409 | No |
2023 | Requested Billing Period is Invalid Create Broadworks Billing Reports failed since the requested billing period is invalid. Possible Solution:
| 400 | No |
2024 | Billing Reports not Found The Get / Delete Billing Reports API request failed because the requested billing report is not found. Common Cause:
| 404 | No |
2025 | Billing Reports generation is In Progress The request was rejected because the billing report generation is currently in progress. Common Cause:
| 409 | No |
2026 | Billing Report Already Exists Occurs when a partner tries to generate a report of a billingStartDate and billingEndDate for which the report was already generated.Possible Solutions:
| 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 Cause:
| 409 | No |
2028 | Invalid Billing Period The Billing Period provided in the request is invalid. Common Cause:
| 400 | No |
2029 | Billing Reports Forbidden Access Insufficient privileges to access the Billing reports APIs. Common Cause:
Possible Solutions:
| 403 | No |
2030 | Billing Reports Server Busy The request failed since the server is currently busy performing other billing report creation operations. Possible Solution:
| 503 | No |
2031 | Invalid sortBy value Invalid value provided for the sortBy request parameter. Common Cause:
Possible Solution:
| 400 | No |
2032 | User Does Not Exist In Directory Sync Organization User to be added does not currently exist in organization with Directory Sync enabled. Common Cause: When active directory is enabled, a user creation request cannot be made before this user is added to the active directory first. Possible Solution:
| N/A | No |
2033 | User Information Differs from Organization Directory Record First Name, Last Name or Display Name is different from the organization’s active directory record. Common Cause: When trying to onboard a user, the given information is not the same as the information added in the active directory. Possible Solution:
| N/A | No |
2034 | Organization not yet fully provisioned The organization must be fully provisioned in Webex before the requested operation can be performed. Common Cause:
| 403 | No |
2039 | Workspace not found Workspace Not Found. Common Cause:
| 404 | No |
2040 | Workspace name already in use This workspace name is already used by another workspace. Possible Solution:
| 409 | No |
2042 | Required Feature Toggle Not Enabled Access to the requested feature is not permitted. Common Cause:
| 403 | No |
2043 | Broadworks Cluster not provisioned The Partner organization does not have any BroadWorks clusters configured Common Cause:
Possible Solution:
| 403 | Yes |
2045 | Precheck Broadworks User already exists The specified subscriber is already onboarded with a package into this customer organization Common Cause:
| 400 | Yes |
2046 | Broadworks Precheck Hybrid Flow not supported The Precheck API does not support hybrid flow provisioning precheck validations. | 400 | Yes |
2047 | Block usage of Webex for Wholesale API for Webex for BroadWorks customer Unable to perform action on Webex for Wholesale package for a customer/subscriber that is an existing Webex For BroadWorks customer. Possible Solution: Retry the request using the equivalent Webex for BroadWorks API. | 409/404 | N/A |
2048 | Incompatible calling package already assigned Unable to onboard the user to Webex for BroadWorks since the user has the Calling in Webex (Unified CM) calling package. Possible Solution: The Webex Calling package should be removed from the user in Control Hub. | 409 | N/A |
2501 | Invalid Organization ID The organization specified in the request is not associated with any valid existing Webex organization. Common Cause
| 404 | No |
2502 | Wholesale customer is either in provisioning or updating or deleting status The requested operation cannot be processed because of a conflict in the current status of Customer provisioning. Common Cause
| 409 | No |
2503 | The wholesale customer already exist with different externalId The wholesale customer with the specified externalId is already associated with a different Webex organization. Common Cause:
| 409 | No |
2504 | The wholesale customer is not fully provisioned User onboarding failed as the customer organization has not been successfully provisioned. Common Cause:
| 409 | Yes |
2505 | The specified email does not match with broadworksUserId The email provided in the request does not match the expected email for the specified broadworksUserId. Common Cause:
| 409 | Yes |
2506 | The wholesale customer is not provisioned with requested package The customer organization does not have the requested package provisioned. Common Cause:
| 409 | Yes |
2507 | The subscriber already provisioned The specified user has already been onboarded. Common Cause:
| 409 | Yes |
2508 | The broadworksUserId parameter is required The requested operation cannot be processed because the broadworksUserId parameter is required when provisioning the subscriber with the Webex For Broadworks Service. Common Cause:
| 400 | Yes |
2509 | Invalid Billing Date provided for Wholesale Billing Reports Generation Invalid billingStartDate (or/and) billingEndDate request parameter provided in Wholesale Billing Reports API.Common Cause
| 400 | No |
2510 | Invalid sortBy value in Wholesale Billing Reports Invalid value provided for the sortBy request parameter in Wholesale Billing Reports API. Possible Solution:
| 400 | No |
2511 | Invalid Wholesale Billing Report Status in Wholesale Billing Reports Invalid value provided for Report Status request parameter in Wholesale Billing Reports API. Possible Solution:
| 400 | No |
2512 | Invalid Wholesale Billing Report Type Invalid value provided for Wholesale Report Type request parameter in Wholesale Billing Reports API. Possible Solution:
| 400 | No |
2513 | The wholesale customer has active workspace The wholesale customer with the specified customerId has active workspace in its Webex organization. Common Cause:
Possible Solution:
| 409 | No |
2514 | The wholesale customer has active user The wholesale customer with the specified customerId has active users in its Webex organization. Common Cause:
Possible Solution:
| 409 | No |
2515 | The partner organization does not have wholesale entitlements The Partner organization does not have the required entitlement for the specified provisioning package. Common Cause:
Possible Solution:
| 400 | No |
2516 | The partner organization does not have a wholesale subscription The Partner organization does not have the required subscription for the specified provisioning package. Common Cause:
Possible Solution:
| 400 | No |
2517 | Invalid Location ID The specified locationId parameter either does not exist or does not belong to the specified customer. Common Cause:
Possible Solution:
| 400 | Yes |
2518 | Automatic selection of the location failed Automatic selection of the location for the customer organization can not be performed. Common Cause:
Possible Solution:
| 400 | Yes |
2519 | Subscription identifier for wholesale customers is missing The customer template does not have a configured subscription identifier. Common Cause:
Possible Solution:
| 400 | Yes |
2520 | A package is assigned to a user or workspace Unable to remove packages that are currently assigned to users and/or workspaces. Common Cause:
Possible Solution:
| 409 | No |
2521 | Invalid billing address for the customer The requested operation cannot be performed as the customer address provided in the request is invalid. Common Cause:
Possible Solution:
| 400 | No |
2522 | Invalid phone number The phone number specified in the request is either invalid or does not belong to this customer. Common Cause:
Possible Solution:
| 400 | Yes |
2523 | Invalid extension number The extension number specified in the request is either invalid or already in use. Common Cause:
Possible Solution:
| 409 | Yes |
2524 | Invalid Cloud Connected PSTN provider ID The customer template does not have a Cloud Connected PSTN provider ID. Common Cause:
Possible Solution:
| 400 | No |
2528 | Invalid Country Code Invalid country code provided in the calling attributes. Possible Solution:
| 400 | No |
2529 | Invalid State or Province Code of the country Invalid state or province provided in the calling attributes for the given country code. Possible Solution:
| 400 | No |
2530 | The state or province code is empty State or Province provided in the calling attributes cannot be empty for the given country code. Possible Solution:
| 400 | No |
2531 | The zip or postal code is empty Zip or Postal code provided in the calling attributes cannot be empty for the given country code. Possible Solution:
| 400 | No |
2532 | Invalid timezone Invalid timezone provided in the calling attributes for the given country code. Possible Solution:
| 400 | No |
2533 | Invalid language Invalid language code provided in the calling attributes. Possible Solution:
| 400 | No |
2534 | Invalid Partner Wholesale Subscription ID The Partner Wholesale Subscription ID provided in the request is invalid. Possible Solution:
| 400 | No |
2535 | BroadWorks ID cannot be updated The BroadWorks ID cannot be updated as there are existing users associated with the customer template. | 400 | No |
2536 | Package is not in the correct state for update The package cannot be updated because it does not have the correct status. | 400 | No |
2539 | Country Code Not Permitted The customer country code is not supported for provisioning. | 400 | Yes |
2540 | Precheck customer conflict The customer primaryEmail provided in the request does not match the primaryEmail of the customer associated with the specified spEnterpriseId/customerId Common Cause:
Possible Solution:
| 409 | Yes |
2541 | Wholesale Customer Not Found The customerId specified in an API Request to Post a Subscriber could not be found.Common Cause:
| 404 | Yes |
2544 | Simultaneous addition and removal of packages is not allowed Simultaneous addition and removal of packages in the same update request is not supported Possible Solution: Split the update request into two separate update requests:
| 400 | N/A |
2546 | Customer Address Validation Failed For Country The country is invalid. Common Cause:
| 400 | No |
2547 | Customer Address Validation Failed For Zip / Postal Code The zip / postal code is invalid. Common Cause:
| 400 | No |
2548 | Customer Address Validation Failed Missing Mandatory Field Missing a mandatory field needed for validation Common Cause:
| 400 | No |
2549 | Customer Address Validation Failed The address is invalid. Common Cause:
| 400 | No |
2550 | Customer Address Validation Failed For City The city is invalid. Common Cause:
| 400 | No |
2551 | Customer Address Validation Failed For State / Province The state or province is invalid. Common Cause:
| 400 | No |
2552 | Block usage of Webex for Broadworks API for Webex for Wholesale customer Unable to perform action on Webex For BroadWorks package for a customer/subscriber that is an existing Webex for Wholesale customer. Possible Solution: Retry the request using the equivalent Webex for Wholesale API. | 409/404 | N/A |
2553 | Extension Number is Reserved The extension number provided in the request is a reserved extension Possible Solution: Retry the request with a different extension number which is not a reserved emergency or repair number. | 400 | N/A |
2555 | Dependent Package(s) not found Package cannot be provisioned because it requires one or more dependent packages that are not currently included. Possible Solution: Verify that all required dependent packages are included before provisioning any package that relies on them. | 400 | N/A |
2556 | Unsupported Country for Cisco Calling Plan Provisioning of Cisco Calling Plan package is not supported in the customers country. Possible Solution: Verify the customer's country to ensure it is eligible for the Cisco Calling Plan package. | 400 | N/A |
2560 | Required Webex Calling Provisioning Services Unavailable One or more Webex Calling services are unavailable due to maintenance, unable to start provisioning. Consult status.webex.com and retry later. | 503 | No |
2561 | Subscription without Active Licenses The Partner organization does not have any active licenses in the subscription provided by the customer template. | 400 | No |
2571 | Unable To Remove License The license could not be removed. Possible Solution: Try deleting the user again later. | 503 | No |
2572 | Invalid request param/value provided in wholesale subscriber request Invalid request param/value provided in wholesale subscriber request Possible Solution:
| 400 | No |
2573 | The primaryPhoneNumber provided in the subscriber request is not available The primaryPhoneNumber is not available. It is already assigned to a user or used in another location Possible Solution:
| 409 | Yes |
2574 | The extension provided in the subscriber request is not available The extension is not available. It is already assigned to a user Possible Solution:
| 409 | Yes |
2575 | The primaryPhoneNumber provided in the subscriber request is not available The primaryPhoneNumber is already assigned Possible Solution:
| 409 | Yes |
2576 | Invalid extension provided in the subscriber request Invalid extension. Possible Solution:
| 400 | Yes |
2577 | Toll Free Number provided in the subscriber request Toll Free Number assignment is not allowed Possible Solution:
| 400 | Yes |
2578 | OrgId was not provided in the customer request OrgId is a mandatory parameter when provisioning a pre-existing customer with Wholesale services Possible Solution:
| 400 | No |
2579 | Invalid request param/value provided in wholesale customer request Invalid request param/value provided in wholesale customer update request Possible Solution:
| 400 | No |
2584 | Mismatch between Calling Behavior template and User Calling Behavior The calling behavior template is not applicable for the user calling behavior. Possible Solution:
| 400 | Yes |
2586 | Cisco Calling Plan Package Removal Failure Cisco calling plan can only be removed in conjunction with its dependant package Possible Solution:
| 400 | No |
2587 | Unexpected removal of a user in Cisco Webex during the provisioning process Common Cause: The user may have been previously created and subsequently deleted. Possible Solution: Reprovision the user at a later time. | 409 | 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. Common Cause:
| 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. Common Cause:
Reconfigure the Customer Template on Control Hub with a new Service Provider email address. | Not Applicable2 | Yes |
5001 | Internal Server Error An unexpected error has occurred while processing the API request or during subsequent subscriber provisioning in the background. Possible Solution: Please raise a Support Ticket if the issue persists. If you repeatedly see the same value for the internalErrorCode attribute over a long period of time, you should mention this in the Support Ticket. | 500 | Yes |
5002 | Invalid Partner IDP Entity ID Common Cause: Invalid Partner IDP Entity ID in template. Possible Solution: Update the template with a valid Partner IDP Entity ID. | 400 | Yes |
5003 | Invalid provisioningId The provisioningId provided in the request can not be found. Possible Solution: Provide the valid provisioningId in the request. | 404 | No |
5004 | Unable to process invalid request An invalid request parameter or misconfiguration caused a processing error Possible Solution: Verify if request parameters and configuration are correct. Please raise a Support Ticket if the issue persists. | 400 | Yes |
6001 | BroadWorks Directory Sync Aborted BroadWorks External Directory User Sync is aborted. Common Cause: BroadWorks External Directory User Sync has been aborted due to sync time out. Possible Solutions:
| Not Applicable | N/A |
6002 | BroadWorks Directory Sync In Progress Another BroadWorks External Directory User Sync is in progress, try again later. Common Cause: Another Customer sync in the BroadWorks cluster is in progress or all the execution threads are busy. Possible Solutions:
| 503 or 429 | N/A |
6003 | BroadWorks Cluster CTI Failure BroadWorks External Directory User Sync failed while trying to connect to BroadWorks cluster. Common 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. Common Cause: Admin is trying to sync an enterprise for which Directory sync is disabled. Possible Solutions:
| 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. Common Cause: Admin has enabled the Hybrid Directory sync. Possible Solutions:
| 409 | N/A |
6006 | Enterprise Not Found The enterprise does not exist in the Partner Org. Common Cause:
| 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. Common 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. Common 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 |
6014 | User To Be Synced Has No Phone Number And Extension BroadWorks External Directory Single User Sync is not possible because phone number and extension are unavailable. Common Cause: This happens when the user in BroadWorks to be synced does not have a configured number and extension. Possible Solutions: Make sure that the user to be synced has its number or extension configured in BroadWorks. | 400 | N/A |
6015 | Customer Primary Key Revoked Or Deleted BroadWorks Phone List Sync failed because Customer Primary Key may have been revoked or deleted. Common Cause: This happens when the partner administrator revoked/deleted the Primary Key of the customer org. Possible Solutions: Make sure that the partner administrator has activated the Primary Key of the customer org. | 405 | N/A |