anchorWhat's possible with 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.

Wholesale Customer Provisioning APIs

• Provision a wholesale customer
• Update a wholesale customer
• View a wholesale customer
• View wholesale customers
• Delete a wholesale customer

Wholesale Subscriber Provisioning APIs

• Provision a wholesale subscriber
• Update a wholesale subscriber
• View a wholesale subscriber
• View wholesale subscribers
• Delete a wholesale subscriber

anchorUsing the Provisioning API

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

anchorMethods and Content Types

The Webex for Wholesale Provisioning Public API is RESTful. In REST, a base URL represents each resource. You use the HTTP methods GET, POST 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.

anchorWholesale Customer Address Requirement

The billing address and calling address of the customer should be provided per the below guidelines:

anchorWhat's possible with Webex for Wholesale Billing Reports Public 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.

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

anchorAPI Error Codes

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 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.

anchorBackward Compatibility and Versioning

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

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

anchorAsynchronous Provisioning Model

Wholesale 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.

anchorSubscriber Deletion

Webex for APIs supports both a soft and hard deletion model for subscribers. Soft Delete—The Webex for BroadWorks 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.

anchorOrganization Deletion

Follow the instructions below in order to delete an organization.

• Delete all the subscribers from the organization using the Delete a wholesale subscriber API.
• The removal of users may take some time depending on quantity of users.
• Delete all the workspace from the organization.
• The organization now can be deleted using Delete a wholesale customer API.

anchorWebex Meetings Site Timezone

If a specific Webex Meetings site timezone is required, please specify the meeting timezone parameter in the organization provisioning request for the following packages:
The wholesale organization provisioned for webex_suite package.
The wholesale organization provisioned for webex_meetings package.

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:

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: