Subscribers - List Wholesale Subscribers

List Wholesale Subscribers

This API allows a Service Provider to search for their associated subscribers. There are a number of filter options, which can be combined in a single request.

GET/v1/wholesale/subscribers

Query Parameters

max

integer

Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the Pagination section of Webex REST API Basics.

Default: 50

offset

integer

Offset value to implement pagination.

customerId

string

Wholesale customer ID.

personId

string

The person ID of the subscriber used in the /v1/people API.

externalCustomerId

string

Customer external ID.

string

The email address of the subscriber.

status

string

The provisioning status of the subscriber.

after

string

Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.

lastStatusChange

string

Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.

sortBy

string

Supported sortBy attributes are created and lastStatusChange. Default is created.

sortOrder

string

Sort by ASC (ascending) or DESC (descending).

Response Properties

items

array[Subscriber]

An array of Subscriber objects.

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.

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.

webex_voice

string

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

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.

GET

/v1/wholesale/subscribers{?max,offset,customerId,personId,externalCustomerId,email,status,after,lastStatusChange,sortBy,sortOrder}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

max
integer
Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/api/basics).
offset
integer
Offset value to implement [pagination](/docs/basics#pagination).
customerId
string
Wholesale customer ID.
personId
string
The person ID of the subscriber used in the [/v1/people API](/docs/api/v1/people).
externalCustomerId
string
Customer external ID.
email
string
The email address of the subscriber.
status
string
The provisioning status of the subscriber.
after
string
Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
lastStatusChange
string
Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
sortBy
string
Supported `sortBy` attributes are `created` and `lastStatusChange`. Default is `created`.
sortOrder
string
Sort by `ASC` (ascending) or `DESC` (descending).

https://webexapis.com/v1/wholesale/subscribers?max=10&offset=4&customerId=Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY&personId=Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY&externalCustomerId=c1677a16-557a-4fb4-b48f-24adde57ec99&email=john.anderson@acme.com&status=pending_email_input&after=1579046400245&lastStatusChange=1579046400245&sortBy=userCreationTimestamp&sortOrder=ASC

200 / OK

{
    "items": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
            "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
            "email": "johnandersen@acme.com",
            "package": "webex_calling",
            "customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng==",
            "externalCustomerId" : "c1677a16-557a-4fb4-b48f-24adde57ec99",
            "status": "provisioned",
            "lastStatusChange": "2021-08-06T02:05:41.791232Z",
            "created": "2021-08-06T02:03:00.062Z"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
            "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
            "email": "johnandersen@acme.com",
            "customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng==",
            "externalCustomerId" : "c1677a16-557a-4fb4-b48f-24adde57ec99",
            "package": "webex_meetings",
            "status": "provisioned",
            "lastStatusChange": "2021-08-06T02:05:41.791232Z",
            "created": "2021-08-06T02:03:00.062Z"
        }
    ]
}