List Wholesale Customers
This API allows a Service Provider to search for their customers. There are a number of filter options, which can be combined in a single request.
Query Parameters
Customer external ID.
The encoded Organization ID for the customer.
Customer API status.
Offset value for implementing pagination.
The maximum number of customers returned in the response.
The encoded organization ID for the sub partner.
Response Properties
An array of Customer objects.
A unique Cisco identifier for the customer. This value should be used for the customerId parameter in the Wholesale Customers and Wholesale Subscribers API.
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.
External ID of the Customer.
Address Line 1.
Address Line 2.
City of the customer.
State or Province of the customer.
Postal/Zip code of the customer.
ISO2 country code of the customer size = 2.
The provisioning status of the customer.
Customer is fully provisioned on Cisco Webex.
Customer is provisioned with errors.
Customer is provisioning.
Customer is updating.
Customer is being deleted.
An error occurred provisioning the customer on Cisco Webex.
The customer is pending a Denied Party List compliance check.
List of package names provisioned
The Webex Wholesale Packages assigned to the customer.
Webex Common Area Calling Package.
Webex Calling Package.
Webex Meetings Package.
Webex Suite Package.
Webex Voice Package.
Customer Experience Essentials Package.
Cisco Calling Plan Package.
The provisioning status of the a particular package.
Customer is fully provisioned on Cisco Webex.
Customer is provisioning.
Customer is being deleted.
An error occurred provisioning the customer on Cisco Webex.
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.
An error code that identifies the reason for the error.
A textual representation of the error code.
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.
An error code that identifies the reason for the error.
A textual representation of the error code.
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.
An error code that identifies the reason for the error.
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.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Customer external ID.
- The encoded Organization ID for the customer.
- Customer API status.
- Offset value for implementing pagination.
- The maximum number of customers returned in the response.
- The encoded organization ID for the sub partner.
{
"items":[
{
"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_with_errors",
"packages":[
"common_area_calling",
"webex_calling",
"webex_meetings",
"webex_suite",
"webex_voice",
"cx_essentials"
],
"resourceDetails":{
"packages":[
{
"name":"common_area_calling",
"status":"provisioned"
},
{
"name":"webex_calling",
"status":"error",
"warnings": [
{
"errorCode": 2560,
"description": "One or more Webex Calling services are unavailable due to maintenance, unable to start provisioning. Consult status.webex.com and retry later."
}
]
},
{
"name":"webex_meetings",
"status":"provisioned"
},
{
"name":"webex_suite",
"status":"provisioned"
},
{
"name":"webex_voice",
"status":"provisioned"
},
{
"name":"cx_essentials",
"status":"provisioned"
}
]
}
}
]
}