DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationAccess the APIREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsUsing Webex Service Apps
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for Wholesale
Wholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Device SettingsWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWebex Calling Device SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksUsing Webex Service AppsWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and CardsUsing Webex Service Apps
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Device SettingsWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

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.

anchorWhat's possible with Webex for Wholesale Provisioning APIs
anchor

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
anchor

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
anchor

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
anchor

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

AttributeMandatory
addressLine1Yes
addressLine2No
cityYes
stateOrProvinceMandatory for some geographic locations.
zipOrPostalCodeMandatory for some geographic locations.
countryYes
anchorWhat's possible with Webex for Wholesale Provisioning Precheck APIs
anchor

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
anchor

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
anchor

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
anchor

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

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

Scope
Usage
spark-admin:wholesale_customers_write
Provision, Update or Remove a Customer as part of Webex Wholesale Solution.
spark-admin:wholesale_customers_read
Read or List Customers, provisioned as part of Webex Wholesale Solution.
spark-admin:wholesale_subscribers_write
Provision, Update or Remove a Subscriber as part of Webex Wholesale Solution.
spark-admin:wholesale_subscribers_read
Read or List Subscribers, provisioned as part of Webex Wholesale 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. 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
anchor

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
anchor

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
anchor

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
anchor

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.

  • What's possible with Webex for Wholesale Provisioning APIs
  • Using the Provisioning API
  • Methods and Content Types
  • Wholesale Customer Address Requirement
  • What's possible with Webex for Wholesale Provisioning Precheck APIs
  • Using the Precheck Provisioning API
  • Methods and Content Types
  • What's possible with Webex for Wholesale Billing Reports Public APIs
  • API Error Codes
  • Authentication
  • Asynchronous Provisioning Model
  • Subscriber Deletion
  • Organization Deletion
  • Webex Meetings Site Timezone

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.