Validate Extensions
Validate extensions for a specific location.
Validating extensions requires a full administrator auth token with a scope of spark-admin:telephony_config_write.
POST/v1/telephony/config/locations/{locationId}/actions/validateExtensions/invoke
URI Parameters
locationId
stringrequired
Validate extensions for this location.
Query Parameters
orgId
string
Validate extensions for this organization.
Body Parameters
extensions
array[string]required
Array of extensions that will be validated.
Response Properties
status
enum
Status of the validated array of extensions.
OK
string
Indicates that all extensions were validated.
ERRORS
string
Indicates that not all extensions were validated.
extensionStatus
array[ExtensionStatusObject]
Array of extensions statuses.
extension
string
Unique extension which will be validated at the location level.
state
enum
State of the extension after it was validated.
VALID
string
Extension is valid.
DUPLICATE
string
Extension already assigned to another group.
DUPLICATE_IN_LIST
string
Extension already exists in the request body and was already verified.
INVALID
string
Extension is invalid.
errorCode
number
Error code of the state in case extension is not valid.
message
string
Message assigned to the error code.
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/telephony/config/locations//actions/validateExtensions/invoke{?orgId}
Log in to try the API.
Header
Query Parameters
- Validate extensions for this organization.
Body
- Array of extensions that will be validated.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1/actions/validateExtensions/invoke?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
"extensions": ["407721", "507721", "507721", "9111", "a234"]
}
200 / OK
{
"status":"ERRORS",
"extensionStatus":[
{
"extension":"407721",
"state":"DUPLICATE",
"errorCode":9495,
"message":"[Error 9495] The extension is not available. It is already assigned as a Call Park Extension: 407721."
},
{
"extension":"507721",
"state":"VALID"
},
{
"extension":"507721",
"state":"DUPLICATE_IN_LIST",
"errorCode":9498
},
{
"extension": "911",
"state": "INVALID",
"errorCode": 4911,
"message": "[Error 4911] Invalid extension. The extension cannot be an emergency number."
},
{
"extension":"a234",
"state":"INVALID",
"errorCode":4910,
"message":"[Error 4910] Invalid extension. The extension can only contain characters 0-9."
}
]
}