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 ConnectDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML 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 SettingsDECT Devices SettingsDevice Call SettingsDevicesFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupLocation 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
Devices
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 SettingsDECT Devices SettingsDevice Call SettingsDevice ConfigurationsDevicesEventsFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupGroupsHistorical 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

Provision a Wholesale Customer

Provision a Wholesale customer for Cisco Webex services.

This API will allow a Service Provider to map the Wholesale customer and assign the required licenses and entitlements for Webex, Calling and Meetings.

The Wholesale customer provisioning is asynchronous and thus a background task is created when this endpoint is invoked.

After successful invocation of this endpoint a URL will be returned in the Location header, which will point to the Get a Wholesale Customer endpoint for this customer.

POST/v1/wholesale/customers
Body Parameters
provisioningId
stringrequired

This Provisioning ID defines how this customer is to be provisioned for Webex Services.

Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Webex Control Hub.

packages
array[string]required

The complete list of Webex Wholesale packages to be assigned to the customer.

Possible values: common_area_calling, webex_calling, webex_meetings, webex_suite, webex_voice
orgId
string

The Organization ID of the enterprise on Webex. Mandatory for existing customer.

externalId
stringrequired

External ID of the Wholesale customer.

address
objectrequired

Billing Address of the customer.

addressLine1
stringrequired

Address Line 1.

addressLine2
string

Address Line 2.

city
stringrequired

City of the customer.

stateOrProvince
string

State or Province of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information.

zipOrPostalCode
string

Postal/Zip code of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information.

country
stringrequired

ISO2 country code of the customer size = 2. This attribute is used to determine the default Dial In number for the Webex Meeting Sites. Refer to the Address section of help page for more information.

customerInfo
object

Mandatory for new customer. Optional if Organization ID is provided.

name
stringrequired

The name of the Wholesale customer.

primaryEmail
stringrequired

The primary email address of the customer.

language
string

The {ISO-639-1}_{ISO-3166} or {ISO-639-1} locale or language code used as preferred language for organization and Webex Meeting Sites. Refer to the help page for more information.

provisioningParameters
object
calling
object
location
objectrequired
name
stringrequired

Name of the wholesale customer office.

address
objectrequired

Address of the wholesale customer.

addressLine1
stringrequired
addressLine2
string
city
stringrequired
stateOrProvince
string

State or Province of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information.

zipOrPostalCode
string

Postal/Zip code of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information.

country
stringrequired
timezone
stringrequired

Customer timezone for calling package.

language
stringrequired

Determine language for all generated emails and voice announcements.

emergencyLocationIdentifier
string

SIP Header for any emergency calls from this location.

meetings
object
timezone
string

Customer timezone for meetings package.

Response Properties
url
string

A URL which points to the Get a Wholesale Customer endpoint for the provisioned customer.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
POST
/v1/wholesale/customers
Log in to try the API.
Header
Body
  • This Provisioning ID defines how this customer is to be provisioned for Webex Services. Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on [Webex Control Hub](https://admin.webex.com).
  • The complete list of Webex Wholesale packages to be assigned to the customer.
  • The Organization ID of the enterprise on Webex. Mandatory for existing customer.
  • External ID of the Wholesale customer.
  • Billing Address of the customer.
  • Mandatory for new customer. Optional if Organization ID is provided.
  • Request
  • Response
{
  "provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
  "packages": [
    "common_area_calling",
    "webex_calling",
    "webex_meetings",
    "webex_suite",
    "webex_voice"
  ],
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg",
  "externalId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
  "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",
    "language": "'en'"
  },
  "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"
      }
    },
    "meetings": {
      "timezone": "America/Los_Angeles"
    }
  }
}
202 / Accepted
{
    "url": "https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4"
}

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.