DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Platform IntroductionBotsButtons and CardsIntegrationsWidgetsGuest IssuerDeveloper SandboxPromote your AppFAQs
Embedded Apps
OverviewDeveloper GuideDesign Guidelines for MeetingsDesign Guidelines for MessagingAPI ReferenceSubmission Checklist for Embedded Apps
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person Settings
GETRead Person's Calling Behavior
PUTConfigure a Person's Calling Behavior
GETRead Barge In Settings for a Person
PUTConfigure Barge In Settings for a Person
GETRead Forwarding Settings for a Person
PUTConfigure Call Forwarding Settings for a Person
GETRead Call Intercept Settings for a Person
PUTConfigure Call Intercept Settings for a Person
POSTConfigure Call Intercept Greeting for a Person
GETRead Call Recording Settings for a Person
PUTConfigure Call Recording Settings for a Person
GETRead Caller ID Settings for a Person
PUTConfigure Caller ID Settings for a Person
GETRead Do Not Disturb Settings for a Person
PUTConfigure Do Not Disturb Settings for a Person
GETRead Voicemail Settings for a Person
PUTConfigure Voicemail Settings for a Person
POSTConfigure Busy Voicemail Greeting for a Person
POSTConfigure No Answer Voicemail Greeting for a Person
GETList of Schedules for a Person
POSTCreate Schedule for a Person
GETGet a Schedule Details
PUTUpdate a Schedule
DELETEDelete a Schedule
GETFetch Event for a Person's Schedule
POSTAdd a New Event for Person's Schedule
PUTUpdate an Event for a Person's Schedule
DELETEDelete an Event for a Person's Schedule
GETRead Call Waiting Settings for a Person
PUTConfigure Call Waiting Settings for a Person
GETRetrieve a Person's Monitoring Settings
PUTModify a Person's Monitoring Settings
GETGet a List of Phone Numbers for a Person
GETRetrieve a Person's Application Services Settings
PUTModify a Person's Application Services Settings
GETGet a person's Privacy Settings
PUTConfigure a person's Privacy Settings
GETRetrieve Executive Assistant Settings for a Person
PUTModify Executive Assistant Settings for a Person
GETRead Receptionist Client Settings for a Person
PUTConfigure Receptionist Client Settings for a Person
GETRead Hoteling Settings for a Person
PUTConfigure Hoteling Settings for a Person
POSTReset Voicemail PIN
GETRead Incoming Permission Settings for a Person
PUTConfigure Incoming Permission Settings for a Person
GETRetrieve a Person's Outgoing Calling Permissions Settings
PUTModify a Person's Outgoing Calling Permissions Settings
Wholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Webex for BroadWorksIntegrations and AuthorizationWebex for Wholesale
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person Settings
GETRead Person's Calling Behavior
PUTConfigure a Person's Calling Behavior
GETRead Barge In Settings for a Person
PUTConfigure Barge In Settings for a Person
GETRead Forwarding Settings for a Person
PUTConfigure Call Forwarding Settings for a Person
GETRead Call Intercept Settings for a Person
PUTConfigure Call Intercept Settings for a Person
POSTConfigure Call Intercept Greeting for a Person
GETRead Call Recording Settings for a Person
PUTConfigure Call Recording Settings for a Person
GETRead Caller ID Settings for a Person
PUTConfigure Caller ID Settings for a Person
GETRead Do Not Disturb Settings for a Person
PUTConfigure Do Not Disturb Settings for a Person
GETRead Voicemail Settings for a Person
PUTConfigure Voicemail Settings for a Person
POSTConfigure Busy Voicemail Greeting for a Person
POSTConfigure No Answer Voicemail Greeting for a Person
GETList of Schedules for a Person
POSTCreate Schedule for a Person
GETGet a Schedule Details
PUTUpdate a Schedule
DELETEDelete a Schedule
GETFetch Event for a Person's Schedule
POSTAdd a New Event for Person's Schedule
PUTUpdate an Event for a Person's Schedule
DELETEDelete an Event for a Person's Schedule
GETRead Call Waiting Settings for a Person
PUTConfigure Call Waiting Settings for a Person
GETRetrieve a Person's Monitoring Settings
PUTModify a Person's Monitoring Settings
GETGet a List of Phone Numbers for a Person
GETRetrieve a Person's Application Services Settings
PUTModify a Person's Application Services Settings
GETGet a person's Privacy Settings
PUTConfigure a person's Privacy Settings
GETRetrieve Executive Assistant Settings for a Person
PUTModify Executive Assistant Settings for a Person
GETRead Receptionist Client Settings for a Person
PUTConfigure Receptionist Client Settings for a Person
GETRead Hoteling Settings for a Person
PUTConfigure Hoteling Settings for a Person
POSTReset Voicemail PIN
GETRead Incoming Permission Settings for a Person
PUTConfigure Incoming Permission Settings for a Person
GETRetrieve a Person's Outgoing Calling Permissions Settings
PUTModify a Person's Outgoing Calling Permissions Settings
Webex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Devices
Overview
Guides
Workspace Integrations Guide
Reference
Device ConfigurationsDevicesPlacesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Meeting Resource GuideEmbedded Apps GuideEmbedded Apps ReferenceIntegrations and AuthorizationEmbedded Apps Design and Experience GuidelinesWebhooksWebinar Guide
Reference
Meeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsPeopleRecording ReportRecordingsWebhooks
Messaging
Overview
Guides
Embedded Apps GuideEmbedded Apps ReferenceBotsIntegrations and AuthorizationEmbedded Apps Design and Experience GuidelinesWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsWebhooks
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference Guide
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesOrganizationsPeoplePlacesRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person Settings
GETRead Person's Calling Behavior
PUTConfigure a Person's Calling Behavior
GETRead Barge In Settings for a Person
PUTConfigure Barge In Settings for a Person
GETRead Forwarding Settings for a Person
PUTConfigure Call Forwarding Settings for a Person
GETRead Call Intercept Settings for a Person
PUTConfigure Call Intercept Settings for a Person
POSTConfigure Call Intercept Greeting for a Person
GETRead Call Recording Settings for a Person
PUTConfigure Call Recording Settings for a Person
GETRead Caller ID Settings for a Person
PUTConfigure Caller ID Settings for a Person
GETRead Do Not Disturb Settings for a Person
PUTConfigure Do Not Disturb Settings for a Person
GETRead Voicemail Settings for a Person
PUTConfigure Voicemail Settings for a Person
POSTConfigure Busy Voicemail Greeting for a Person
POSTConfigure No Answer Voicemail Greeting for a Person
GETList of Schedules for a Person
POSTCreate Schedule for a Person
GETGet a Schedule Details
PUTUpdate a Schedule
DELETEDelete a Schedule
GETFetch Event for a Person's Schedule
POSTAdd a New Event for Person's Schedule
PUTUpdate an Event for a Person's Schedule
DELETEDelete an Event for a Person's Schedule
GETRead Call Waiting Settings for a Person
PUTConfigure Call Waiting Settings for a Person
GETRetrieve a Person's Monitoring Settings
PUTModify a Person's Monitoring Settings
GETGet a List of Phone Numbers for a Person
GETRetrieve a Person's Application Services Settings
PUTModify a Person's Application Services Settings
GETGet a person's Privacy Settings
PUTConfigure a person's Privacy Settings
GETRetrieve Executive Assistant Settings for a Person
PUTModify Executive Assistant Settings for a Person
GETRead Receptionist Client Settings for a Person
PUTConfigure Receptionist Client Settings for a Person
GETRead Hoteling Settings for a Person
PUTConfigure Hoteling Settings for a Person
POSTReset Voicemail PIN
GETRead Incoming Permission Settings for a Person
PUTConfigure Incoming Permission Settings for a Person
GETRetrieve a Person's Outgoing Calling Permissions Settings
PUTModify a Person's Outgoing Calling Permissions Settings
Webex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJavaCommunity
Developer CommunityCertifications

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.

PUT/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 the token used to access API.

Body Parameters
enabled
boolean

true if the intercept feature is enabled.

incoming
object

Settings related to how incoming calls are handled when the intercept feature 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 the intercept feature 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.

newNumber
object

Information about the new number announcement.

enabled
boolean

If true, the caller will hear this new number when a 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 the intercept feature 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.
  • Try it
  • Example
PUT
/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 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.
  • Request
  • Response
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/intercept?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
    "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": ""
    }
}
204 / No Content

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2022 Cisco and/or its affiliates. All rights reserved.