Put Location Intercept
Modifies the intercept location details for a customer location.
Intercept incoming or outgoing calls for users in your organization. If this is enabled, calls are either routed to a designated number the user chooses, or to the user's voicemail.
Modifying the intercept location details requires a full, user administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Modifies the intercept details for this location.
Query Parameters
Modifies the intercept location details for a customer location.
Body Parameters
Enable/disable location intercept. Enable this feature to override any location's Call Intercept settings that a person configures.
Inbound call details.
Select inbound call options.
Set to INTERCEPT_ALL to intercept all inbound calls.
Set to ALLOW_ALL to allow all inbound calls.
Set to true to route voice mail.
Announcements details.
Greeting type for location intercept.
Set to DEFAULT to play default greeting.
Set to CUSTOM to play custom greeting.
If set to CUSTOM for greeting, filename of previously uploaded file.
Details for new number.
Set to true to play new number announcement.
If enabled, set destination phone number.
Transfer number details.
Set to true to transfer to phone number.
Transfer phone number to be called when '0' is dialed.
Outbound Call details
Outbound call options.
Set to INTERCEPT_ALL to intercept all outbound calls.
Set to ALLOW_LOCAL_ONLY to allow local outbound calls.
Set to true to route all outbound calls to phone number.
If enabled, set valid outgoing destination phone number.
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. |
Header
Query Parameters
- Modifies the intercept location details for a customer location.
Body
- Enable/disable location intercept. Enable this feature to override any location's Call Intercept settings that a person configures.
- Inbound call details.
- Outbound Call details
{
"enabled": true,
"incoming": {
"type": "INTERCEPT_ALL",
"voicemailEnabled": false,
"announcements": {
"greeting": "DEFAULT",
"fileName": "audiofile.wav",
"newNumber": {
"enabled": true,
"destination": "2147691003"
},
"zeroTransfer": {
"enabled": true,
"destination": "2147691005"
}
}
},
"outgoing": {
"type": "ALLOW_LOCAL_ONLY",
"transferEnabled": true,
"destination": "2147691007"
}
}