Configure Call Intercept Settings for a Person
Configures a person's Call Intercept settings.
The intercept feature gracefully takes a person's phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.
This API requires a full or user administrator auth token with the spark-admin:people_write scope.
URI Parameters
Unique identifier for the person.
Query Parameters
ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Body Parameters
true if the intercept feature is enabled.
Settings related to how incoming calls are handled when the intercept feature is enabled.
INTERCEPT_ALL indicated incoming calls are intercepted.
Incoming calls are routed as the destination and voicemail specify.
Incoming calls are not intercepted.
If true, the destination will be the person's voicemail.
Settings related to how incoming calls are handled when the intercept feature is enabled.
DEFAULT indicates that a system default message will be placed when incoming calls are intercepted.
A custom greeting is played when incoming calls are intercepted.
A System default greeting is played when incoming calls are intercepted.
Information about the new number announcement.
If true, the caller will hear this new number when a call is intercepted.
New number caller will hear announced.
Information about how call will be handled if zero (0) is pressed.
If true, the caller will be transferred to destination of when zero (0) is pressed.
Destination to which caller will be transferred when zero is pressed.
Settings related to how outgoing calls are handled when the intercept feature is enabled.
INTERCEPT_ALL indicated all outgoing calls are intercepted.
Outgoing calls are routed as the destination and voicemail specify.
Only non-local calls are intercepted.
If true, when the person attempts to make an outbound call, a system default message is played and the call is made to the destination phone number
Number to which the outbound call will be transferred.
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
- ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Body
- `true` if the intercept feature is enabled.
- Settings related to how incoming calls are handled when the intercept feature is enabled.
- Settings related to how outgoing calls are handled when the intercept feature is enabled.
{
"enabled": true,
"incoming": {
"type": "INTERCEPT_ALL",
"voicemailEnabled": false,
"announcements": {
"greeting": "DEFAULT",
"fileName": "",
"newNumber": {
"enabled": false,
"destination": ""
},
"zeroTransfer": {
"enabled": false,
"destination": ""
}
}
},
"outgoing": {
"transferEnabled": false,
"type": "INTERCEPT_ALL",
"destination": ""
}
}