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

Wholesale Customer Provisioning Precheck APIs

• Precheck a wholesale customer provisioning

Wholesale Subscriber Provisioning Precheck APIs

• Precheck a wholesale subscriber provisioning

Provisioning Precheck API Info Codes

Please refer Provisioning Precheck API Info Codes defines the Info codes used by Wholesale Provisioning Precheck APIs.

anchorUsing the Precheck Provisioning API

The 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 Prerequisite for using these APIs is to have wxc-wholesale entitlement or webex-wholesale-partner-testing setting enabled for the Partner Organization. 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

  • Partial Provisioning Request with following parameters:

    • CustomerInfo.primaryEmail
    • Address

    Please find a sample request

     {        
        "customerInfo" : {           
              "primaryEmail" : "john.anderson@acme.com"     
        },      
        "address": {
                   "addressLine1": "771 Alder Drive",
                   "addressLine2": "Cisco Site 5",
                   "city": "Milpitas",
                   "stateOrProvince": "CA",
                   "zipOrPostalCode": "95035",
                   "country": "US"
        },
     }
    

  • Full Provisioning Request with following parameters:

    • ProvisioningId
    • Packages
    • OrgId
    • ExternalId
    • Address
    • CustomerInfo
    • ProvisioningParameters

    Please find a sample request

       {
               “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”,
                           “numbers” : [`+17205557878`, `+17205557879`],
                           “mainNumber”: “+17205557878”
                   }
                 },
                 “meetings” : {
                      “timezone” : "America/Los_Angeles”
             }
          }
       }
    

• Wholesale Subscriber Provisioning Precheck API

  • Partial Provisioning Request with following parameters:

    • CustomerInfo.primaryEmail
    • Email

    Please find a sample request

     {        
        "customerInfo" : {           
              "primaryEmail" : "john.anderson@acme.com"     
        },      
        "email": "alice.anderson@acme.com"
     }
    

  • Partial Provisioning Request with following parameters:

    • CustomerId
    • Email

    Please find a sample request

      {
         "customerId": "Y2lzY29zcGFyazovL3VzL09vL3VzL0VOVEVSUFJJU0UvNTJSRtR"
         "email": "alice.anderson@acme.com"
       }
    

  • Full Provisioning Request with following parameters:

    • CustomerId
    • ProvisioningId
    • Email
    • Package
    • ProvisioningParameters

    Please find a sample request

       {
               "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"
          }
     }
    

anchorMethods and Content Types

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

For method which accept request parameters, the platform accepts only application/json content types.

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

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.

Wholesale Billing Reports Public APIs

• List Wholesale Billing Reports
• Get a Wholesale Billing Report
• Create a Wholesale Billing Report
• Delete a Wholesale Billing Report

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.

Please refer Webex API Error Codes.

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

anchorOrganization 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

If 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. For default cities/timezones for each country please refer Webex Meetings Site Timezone.