Subscribers - Precheck a Wholesale Subscriber Provisioning

Precheck a Wholesale Subscriber Provisioning

This API will allow the Partner sales team to verify likely success of provisioning a wholesale subscriber.

The Prerequisite for using this API is to have wxc-wholesale entitlement or webex-wholesale-partner-testing setting enabled for the Partner Organization. The Provisioning Precheck APIs supports three variants of Wholesale Subscriber Provisioning Precheck Requests. Please refer to Using the Provisioning Precheck API section in Webex for Wholesale guide for more information.

POST/v1/wholesale/subscribers/validate

Body Parameters

customerId

string

ID of the Provisioned Customer for Webex Wholesale.

stringrequired

The email address of the subscriber.

package

enum

The Webex Wholesale package to be assigned to the subscriber.

webex_calling

string

Calling Basic Package.

webex_meetings

string

Meetings Package.

webex_suite

string

Suite Package.

provisioningParameters

object

firstName

string

The first name of the subscriber.

lastName

string

The last name of the subscriber.

primaryPhoneNumber

string

The primary phone number configured for the subscriber.

extension

string

The extension configured for the subscriber. An extension, primary phone number or both must be supplied when creating a subscriber.

locationId

string

A unique identifier for the location. This ID should be retrieved via the Locations API - List Locations.

customerInfo

object

primaryEmail

stringrequired

The primary email address of the customer.

Response Properties

message

string

A textual representation of Precheck response message.

info

object

A list of ProvisioningPreCheckResponseInfo object.

infoCode

number

Provisioning Precheck infoCode.

description

string

A textual description of the infoCode.

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.

POST

/v1/wholesale/subscribers/validate

Header

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

Body

customerId
string
ID of the Provisioned Customer for Webex Wholesale.
email
stringRequired
The email address of the subscriber.
package
enum
The Webex Wholesale package to be assigned to the subscriber.
provisioningParameters
object
customerInfo
object

{
    {
        "customerId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
        "email": "alice.anderson@acme.com"
    }

}

200 / OK

{
    "message": "success",
    "info": [
        {
            "infoCode": 100,
            "description": "Provisioning preCheck validation successful."
        }
    ]
}