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
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsLogin with WebexGuest IssuerWidgetsWebex 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 AppsProvisioning APIsAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and Authorization
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsWebex for Wholesale
Reference
Call ControlsCall RoutingCalling Service SettingsDevice Call SettingsDevicesFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Receptionist ClientLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPeopleRecording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWholesale Billing ReportsWholesale Provisioning
GETList Wholesale Customers
POSTProvision a Wholesale Customer
GETGet a Wholesale Customer
PUTUpdate a Wholesale Customer
DELETERemove a Wholesale Customer
POSTPrecheck a Wholesale Customer Provisioning
GETList Wholesale Sub-partners
GETList Wholesale Subscribers
POSTProvision a Wholesale Subscriber
GETGet a Wholesale Subscriber
PUTUpdate a Wholesale Subscriber
DELETERemove a Wholesale Subscriber
POSTPrecheck a Wholesale Subscriber Provisioning
Workspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationWholesale and Broadworks Common GuideDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace 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 AuthorizationWebhooksUsing Webex Service AppsButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
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 EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsDevice Call SettingsDevice ConfigurationsDevicesEventsFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Receptionist ClientGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale Provisioning
GETList Wholesale Customers
POSTProvision a Wholesale Customer
GETGet a Wholesale Customer
PUTUpdate a Wholesale Customer
DELETERemove a Wholesale Customer
POSTPrecheck a Wholesale Customer Provisioning
GETList Wholesale Sub-partners
GETList Wholesale Subscribers
POSTProvision a Wholesale Subscriber
GETGet a Wholesale Subscriber
PUTUpdate a Wholesale Subscriber
DELETERemove a Wholesale Subscriber
POSTPrecheck a Wholesale Subscriber Provisioning
Workspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Wholesale Provisioning

These are a set of APIs that are specifically targeted at Service Providers who sign up for Webex Wholesale. They enable Service Providers to provision Webex Services for their Customers.

Viewing Webex Wholesale customer information requires an administrator API access token with spark-admin:wholesale_customers_read scope. Provisioning, updating, and removing customers requires an administrator API token with the spark-admin:wholesale_customers_write scope.

Additional information codes are given for all success cases. To learn more about the error and info codes used in Wholesale Customer Provisioning Precheck APIs, see the Provisioning Precheck API Error Codes guide.

Each Webex Developer Sandbox for Webex Wholesale use is limited to a maximum of 10 account users for validation and test purposes only. Cisco may from time to time audit Webex Developer Sandbox accounts and reserves the right to remove users in excess of 10 account users, or terminate the Webex Developer Sandbox environment for any Developer resource misuse.

Method
Description
GEThttps://webexapis.com/v1/wholesale/customers
List Wholesale Customers
https://webexapis.com/v1/wholesale/customers
GETList Wholesale Customers
POSThttps://webexapis.com/v1/wholesale/customers
Provision a Wholesale Customer
https://webexapis.com/v1/wholesale/customers
POSTProvision a Wholesale Customer
GEThttps://webexapis.com/v1/wholesale/customers/{customerId}
Get a Wholesale Customer
https://webexapis.com/v1/wholesale/customers/{customerId}
GETGet a Wholesale Customer
PUThttps://webexapis.com/v1/wholesale/customers/{customerId}
Update a Wholesale Customer
https://webexapis.com/v1/wholesale/customers/{customerId}
PUTUpdate a Wholesale Customer
DELETEhttps://webexapis.com/v1/wholesale/customers/{customerId}
Remove a Wholesale Customer
https://webexapis.com/v1/wholesale/customers/{customerId}
DELETERemove a Wholesale Customer
POSThttps://webexapis.com/v1/wholesale/customers/validate
Precheck a Wholesale Customer Provisioning
https://webexapis.com/v1/wholesale/customers/validate
POSTPrecheck a Wholesale Customer Provisioning
GEThttps://webexapis.com/v1/wholesale/subPartners
List Wholesale Sub-partners
https://webexapis.com/v1/wholesale/subPartners
GETList Wholesale Sub-partners
GEThttps://webexapis.com/v1/wholesale/subscribers
List Wholesale Subscribers
https://webexapis.com/v1/wholesale/subscribers
GETList Wholesale Subscribers
POSThttps://webexapis.com/v1/wholesale/subscribers
Provision a Wholesale Subscriber
https://webexapis.com/v1/wholesale/subscribers
POSTProvision a Wholesale Subscriber
GEThttps://webexapis.com/v1/wholesale/subscribers/{subscriberId}
Get a Wholesale Subscriber
https://webexapis.com/v1/wholesale/subscribers/{subscriberId}
GETGet a Wholesale Subscriber
PUThttps://webexapis.com/v1/wholesale/subscribers/{subscriberId}
Update a Wholesale Subscriber
https://webexapis.com/v1/wholesale/subscribers/{subscriberId}
PUTUpdate a Wholesale Subscriber
DELETEhttps://webexapis.com/v1/wholesale/subscribers/{subscriberId}
Remove a Wholesale Subscriber
https://webexapis.com/v1/wholesale/subscribers/{subscriberId}
DELETERemove a Wholesale Subscriber
POSThttps://webexapis.com/v1/wholesale/subscribers/validate
Precheck a Wholesale Subscriber Provisioning
https://webexapis.com/v1/wholesale/subscribers/validate
POSTPrecheck a Wholesale Subscriber Provisioning

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.