DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsService App GuestsService Apps G2GGuest IssuerWidgetsWebex ConnectLogin with WebexInstant ConnectInstant Connect Meeting LinksDeveloper SandboxBeta ProgramSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsCompliance
Webex APIs
Reference
Data Sources
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksBYODSService Apps G2GReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSettingsSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and AuthorizationMetadata and Samples
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsMetadata and SamplesBackground Images
Reference
Call ControlsCall RoutingCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsDevice Call SettingsDevicesEmergency Services SettingsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPeopleRecording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for Wholesale
Overview
Guides
Developer's Guide
Reference
Wholesale 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
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Reference
Data Sources
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Directory Services
Reference
Identity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksBYODSService Apps G2GWebinar 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 AuthorizationWebhooksBYODSService Apps G2GButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsData SourcesDevice Call SettingsDevice ConfigurationsDevicesEmergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsIdentity OrganizationLicensesLocation 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 ContactsOrganizationsPSTNPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSession TypesSettingsSiteSpace 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
Space Meetings Migration
Calling
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationCore ConceptsCalls
Advanced Features
Call SettingsContactsSupplementary ServicesVoicemailBackground Noise Reduction
Kitchen Sink
Meetings
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationJoin a MeetingMigration To Improved MeetingsPasswords & CaptchasUnified Space Meetings
Advanced Features
Advanced ControlsDialing In and OutStreams & EffectsVideo Resolution
Multistream
Multistream Comprehensive GuideMultistream Quickstart
Migrating SDK V2 to V3
iOSAndroidBrowser
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.

Similarly, viewing Webex Wholesale subscriber information requires an administrator API access token with the spark-admin:wholesale_subscribers_read scope. Provisioning, updating, and removing subscribers requires an administrator API token with the spark-admin:wholesale_subscribers_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

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