DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale Customers
GETList Wholesale Customers
POSTProvision a Wholesale Customer
GETGet a Wholesale Customer
PUTUpdate a Wholesale Customer
DELETERemove a Wholesale Customer
POSTPrecheck a Wholesale Customer Provisioning
Wholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar 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 AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale Customers
GETList Wholesale Customers
POSTProvision a Wholesale Customer
GETGet a Wholesale Customer
PUTUpdate a Wholesale Customer
DELETERemove a Wholesale Customer
POSTPrecheck a Wholesale Customer Provisioning
Wholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

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.

GET/v1/wholesale/customers
Query Parameters
externalId
string

Customer external ID.

status
list

Customer API status.

offset
int

Offset value for implementing pagination.

max
int

The maximum number of customers returned in the response.

Response Properties
items
array[Customer]

An array of Customer objects.

id
string

A unique Cisco identifier for the customer. This value should be used for the customerId parameter in the Wholesale Customers and Wholesale Subscribers API.

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

Address Line 1.

addressLine2
string

Address Line 2.

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

Customer is fully provisioned on Cisco Webex.

provisioned_with_errors
string

Customer is provisioned with errors.

provisioning
string

Customer is provisioning.

updating
string

Customer is updating.

deleting
string

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

Webex Common Area Calling Package.

webex_calling
string

Webex Calling Package.

webex_meetings
string

Webex Meetings Package.

webex_suite
string

Webex Suite Package.

webex_voice
string

Webex Voice Package.

status
enum

The provisioning status of the a particular package.

provisioned
string

Customer is fully provisioned on Cisco Webex.

provisioning
string

Customer is provisioning.

deleting
string

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.
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
GET
/v1/wholesale/customers{?externalId,status,offset,max}
Log in to try the API.
Header
Query Parameters
  • Customer external ID.
  • Customer API status.
  • Offset value for implementing pagination.
  • The maximum number of customers returned in the response.
  • Request
  • Response
https://webexapis.com/v1/wholesale/customers?externalId=c1677a16-557a-4fb4-b48f-24adde57ec99&status=provisioned_with_errors&offset=10&max=10
200 / OK
{
  "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"
      ],
      "resourceDetails":{
        "packages":[
          {
            "name":"common_area_calling",
            "status":"provisioned"
          },
          {
            "name":"webex_calling",
            "status":"error",
            "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"
              }
            ]
          },
          {
            "name":"webex_meetings",
            "status":"provisioned"
          },
          {
            "name":"webex_suite",
            "status":"provisioned"
          },
          {
            "name":"webex_voice",
            "status":"provisioned"
          }
        ],
        "addOns":[
          {
            "name":"meetings_toll_dialin",
            "status":"provisioned"
          }
        ]
      }
    }
  ]
}

Connect

Support

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.