Validate a list of MAC address
Validate a list of MAC addresses.
Validating this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_write.
POST/v1/telephony/config/devices/actions/validateMacs/invoke
Query Parameters
orgId
string
Validate the mac address(es) for this organization.
Body Parameters
macs
array[string]required
MAC addresses to be validated.
Possible values: {["ab125678cdef", "00005E0053B4"]}
Response Properties
status
enum
Status of MAC address.
OK
string
ERRORS
string
macStatus
array[MacStatusObject]
Contains an array of all the MAC address provided and their statuses.
mac
string
MAC address.
state
enum
State of the MAC address.
AVAILABLE
string
The requested MAC address is available.
UNAVAILABLE
string
The requested MAC address is unavailable.
DUPLICATE_IN_LIST
string
The requested MAC address is duplicated.
INVALID
string
The requested MAC address is invalid.
errorCode
number
MAC address validation error code.
message
string
Provides a status message about the MAC address.
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/devices/actions/validateMacs/invoke{?orgId}
Log in to try the API.
Header
Query Parameters
- Validate the mac address(es) for this organization.
Body
- MAC addresses to be validated.
https://api-usgov.webex.com/v1/telephony/config/devices/actions/validateMacs/invoke?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
"macs": [
"ab125678cdef",
"00005E0053B4"
]
}
200 / OK
{
"status": "ERRORS",
"macStatus": [
{
"mac": "ab125678cdef",
"state": "AVAILABLE"
},
{
"mac": "00005E0053B4",
"state": "UNAVAILABLE",
"errorCode": 5675,
"message": "[Error 5675] MAC Address is in use."
}
]
}