List Wholesale Subscribers
This API will allow a Service Provider to search for their associated subscribers. There are a number of filter options. These can be combined in a single request.
Query Parameters
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.
Specific Offset value.
Wholesale customerId.
The person id of the subscriber used in the /people API.
Customer external Id.
The email address of the subscriber.
The provisioning status of the subscriber.
Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
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.
Supported sortBy attributes are created, lastStatusChange. Default value is created
Sort by ASC or DESC
Response Properties
An array of Subscriber objects.
A unique Cisco identifier for the subscriber.
The person id of the subscriber used in the /people API. Only presented when status is provisioned.
The email address of the subscriber.
A unique identifier for the customer.
External Id of the Wholesale customer.
The Webex Wholesale Package assigned to the subscriber.
Calling Basic Package
Meetings Package
Suite Package
The provisioning status of the user.
The subscriber is fully provisioned on Cisco Webex.
An error occurred provisioning the subscriber on Cisco Webex.
The subscriber is provisioning.
The subscriber email validation is pending.
The subscriber email input is pending.
The subscriber is updating.
The subscriber user migration is pending.
The subscriber email verification is pending.
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.
An error code that identifies the reason for the error
A textual representation of the error code.
The date and time the subscriber was provisioned.
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. |
| 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
- 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).
- Specific Offset value.
- Wholesale customerId.
- The person id of the subscriber used in the /people API.
- Customer external Id.
- The email address of the subscriber.
- The provisioning status of the subscriber.
- Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
- 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.
- Supported sortBy attributes are created, lastStatusChange. Default value is created
- Sort by ASC or DESC
{
"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"
}
]
}