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

Get a Wholesale Subscriber

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

GET/v1/wholesale/subscribers/{subscriberId}
URI Parameters
subscriberId
stringrequired

A unique identifier for the subscriber in question.

Response Properties
id
string

A unique Cisco identifier for the subscriber.

personId
string

The person id of the subscriber used in the /people API. Only presented when status is provisioned.

email
string

The email address of the subscriber.

customerId
string

A unique identifier for the customer.

externalCustomerId
string

External Id of the Wholesale customer.

package
enum

The Webex Wholesale Package assigned to the subscriber.

webex_calling
string

Calling Basic Package

webex_meetings
string

Meetings Package

webex_suite
string

Suite Package

status
enum

The provisioning status of the user.

provisioned
string

The subscriber is fully provisioned on Cisco Webex.

error
string

An error occurred provisioning the subscriber on Cisco Webex.

provisioning
string

The subscriber is provisioning.

pending_email_validation
string

The subscriber email validation is pending.

pending_email_input
string

The subscriber email input is pending.

updating
string

The subscriber is updating.

pending_user_migration
string

The subscriber user migration is pending.

pending_email_verified
string

The subscriber email verification is pending.

errors
array[Error]

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

Note:

  • This list captures errors that occurred during provisioning of the subscriber.

  • 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.

created
string

The date and time the subscriber was provisioned.

lastStatusChange
string

The date and time the provisioning status of the subscriber last changed.

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/subscribers/
Log in to try the API.
Header
https://webexapis.com/v1/wholesale/subscribers/Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
200 / OK
{
    "id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
    "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
    "email": "johnandersen@acme.com",
    "customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng",
    "externalCustomerId" : "c1677a16-557a-4fb4-b48f-24adde57ec99",
    "package": "webex_calling",
    "status": "provisioned",
    "lastStatusChange": "2021-08-06T02:05:41.791232Z",
    "created": "2021-08-06T02:03:00.062Z"
}