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

Get a Wholesale Customer

This API will allow a Service Provider to retrieve details of a provisioned Wholesale customer on Cisco Webex.

GET/v1/wholesale/customers/{customerId}
URI Parameters
customerId
stringrequired

A unique identifier for the customer in question.

Response Properties
id
string

A unique Cisco identifier for the customer.

orgId
string

The Organization ID of the enterprise on Cisco Webex, to be used when referencing this customer on other Cisco Webex APIs. Only presented when status is provisioned.

externalId
string

External Id of the Customer.

address
Address
addressLine1
string

addressLine1

addressLine2
string

addressLine2

city
string

City of the customer

stateOrProvince
string

State or Province of the customer

zipOrPostalCode
string

Postal/Zip code of the customer

country
string

ISO2 country code of the customer size = 2

status
enum

The provisioning status of the customer.

provisioned
string

The customer is fully provisioned on Cisco Webex.

provisioned_with_errors
string

The customer is provisioned with errors.

provisioning
string

The customer is provisioning.

updating
string

The customer is updating.

deleting
string

The customer is being deleted.

error
string

An error occurred provisioning the customer on Cisco Webex.

packages
array[string]

List of package names provisioned

resourceDetails
ResourceDetails
packages
array[Package]
name
enum

The Webex Wholesale Packages assigned to the customer.

common_area_calling
string

The Webex Common Area Calling Package

webex_calling
string

The Webex Calling Package

webex_meetings
string

The Webex Meetings Package

webex_suite
string

The Webex Suite Package

status
enum

The provisioning status of the a particular package.

provisioned
string

The customer is fully provisioned on Cisco Webex.

provisioning
string

The customer is provisioning.

deleting
string

The customer is being deleted.

error
string

An error occurred provisioning the customer on Cisco Webex.

warnings
array[Error]

List of warnings that occurred during that last attempt to provision/update this customer.

Note:

  • This list captures errors that occurred during asynchronous or background provisioning of the customer, after the API has been accepted and 202 response returned.

  • Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code.

errorCode
number

An error code that identifies the reason for the error

description
string

A textual representation of the error code.

errors
array[Error]

List of errors that occurred during that last attempt to provision/update this customer.

Note:

  • This list captures errors that occurred during asynchronous or background provisioning of the customer, after the API has been accepted and 202 response returned.

  • Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code.

errorCode
number

An error code that identifies the reason for the error

description
string

A textual representation of the error code.

errors
array[Error]

List of errors that occurred during that last attempt to provision/update this customer.

Note:

  • This list captures errors that occurred during asynchronous or background provisioning of the customer, after the API has been accepted and 202 response returned.

  • Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code.

errorCode
number

An error code that identifies the reason for the error

description
string

A textual representation of the error code.

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.
GET
/v1/wholesale/customers/
Log in to try the API.
Header
https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4
200 / OK
{
  "id": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
  "orgId": "Y2lzY29zcGFyazovL3VzL09yZ2FuaXphdGlvbi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDk",
  "externalId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
  "address" :{
    "addressLine1": "771 Alder Drive",
    "addressLine2": "Cisco Site 5",
    "city": "Milpitas",
    "stateOrProvince": "CA",
    "zipOrPostalCode": "95035",
    "country": "US"
    },
  "status": "provisioned",
  "packages": [
    "webex_calling"
    ],
  "resourceDetails":
    {
      "packages": [
        {
          "name": "webex_calling",
          "status": "provisioned",
          "warnings": [
            {
                "errorCode": 2526,
                "description": "The requested operation did not successfully provision numbers for the Webex Calling Location"
            },
            {
                "errorCode": 2527,
                "description": "The requested operation did not successfully assign a main number to the Webex Calling Location"
            }
        ]
        }
    ]
    }
}