APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Calling
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
API Changelog

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 Teams, 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 Cisco Webex Services.

Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Cisco 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
orgId
string

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

externalId
stringrequired

External Id of the Wholesale customer.

address
objectrequired

Billing Address of the customer

addressLine1
stringrequired

AddressLine1

addressLine2
string

AddressLine2

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

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.

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.

numbers
array[string]

List of numbers to be assigned to the location

+17205557878
string
+17205557879
string
+17205557880
string
+17205557881
string
mainNumber
string

Main number of the Wholesale customer

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.
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.
POST
/v1/wholesale/customers
Log in to try the API.
Header
Body
  • This Provisioning ID defines how this customer is to be provisioned for Cisco Webex Services. Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Cisco Webex Control Hub.
  • The complete list of Webex Wholesale packages to be assigned to the customer.
  • The Organization ID of the enterprise on Cisco 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
{
  "provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
  "packages": [
    "common_area_calling",
    "webex_calling",
    "webex_meetings",
    "webex_suite"
  ],
  "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"
  },
  "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",
          "+17205557880",
          "+17205557881"
        ],
        "mainNumber": "+17205557878"
      }
    },
    "meetings": {
      "timezone": "America/Los_Angeles"
    }
  }
}
202 / Accepted
{
    "url": "https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
}