Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.
REST API
Getting Started Basics
Guides
API Reference
API Changelog

Read Call Intercept Settings for a Person

Retrieves 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 service configuration, none, some, or all incoming calls to the specified person are intercepted. Also depending on service configuration, outgoing calls are intercepted or rerouted to another location.

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.

GET/v1/people/{personId}/features/intercept
URI Parameters
personId
stringrequired

Unique identifier for the person.

Query Parameters
orgId
string

Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as token used to access API.

Response Properties
enabled
boolean

true if call intercept is enabled.

incoming
object

Settings related to how incoming calls are handled when intercept is enabled.

type
enum

INTERCEPT_ALL indicated incoming calls are intercepted.

INTERCEPT_ALL
string

Incoming calls are routed as destination and voicemail specify.

ALLOW_ALL
string

Incoming calls are not intercepted.

voicemailEnabled
boolean

If true, the destination will be the person's voicemail.

announcements
object

Settings related to how incoming calls are handled when intercept is enabled.

greeting
enum

DEFAULT indicates that a system default message will be placed when incoming calls are intercepted.

CUSTOM
string

A custom will be placed when incoming calls are intercepted.

DEFAULT
string

A System default message will be placed when incoming calls are intercepted.

filename
string

Filename of custom greeting, may be empty string if no custom greeting has been uploaded.

newNumber
object

Information about the new number announcement.

enabled
boolean

If true, the caller will hear this new number when call is intercepted.

destination
string

New number caller will hear announced.

zeroTransfer
object

Information about how call will be handled if zero (0) is pressed.

enabled
boolean

If true, the caller will be transferred to destination of when zero (0) is pressed.

destination
string

Destination to which caller will be transferred when zero is pressed.

outgoing
object

Settings related to how outgoing calls are handled when intercept is enabled.

type
enum

INTERCEPT_ALL indicated all outgoing calls are intercepted.

INTERCEPT_ALL
string

Outgoing calls are routed as destination and voicemail specify.

ALLOW_LOCAL_ONLY
string

Only non-local calls are intercepted.

transferEnabled
boolean

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

destination
string

Number to which the outbound call be transferred.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/people//features/intercept{?orgId}
Log in to try the API.
Header
Query Parameters
  • Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as token used to access API.
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/intercept?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    "enabled": false,
    "incoming": {
        "type": "INTERCEPT_ALL",
        "voicemailEnabled": false,
        "announcements": {
                "greeting": "DEFAULT",
                "newNumber": {
                        "enabled": false
                },
                "zeroTransfer": {
                        "enabled": false
                }
        }
    },
    "outgoing": {
        "type": "INTERCEPT_ALL",
        "transferEnabled": false
    }
}