REST API
Getting Started Basics
API Reference
Guides
API Changelog

Read Forwarding Settings for a Person

Retrieve a Person's Call Forwarding Settings

Three types of call forwarding are supported:

  • Always – forwards all incoming calls to the destination you choose.

  • When busy – forwards all incoming calls to the destination you chose while phone is in use or person is set to busy.

  • When no answer – forwarding only occurs when you are away or not answering your phone.

In addition the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read or a user auth token with spark:people_read scope can be used by a person to read their own settings.

GET/v1/people/{personId}/features/callForwarding
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
callForwarding
object

Settings related to "Always", "Busy", and "No Answer" call forwarding.

always
object

Settings for forwarding all incoming calls to the destination you choose.

enabled
boolean

"Always" call forwarding is enabled or disabled.

destination
string

Destination for "Always" call forwarding.

ringReminderEnabled
boolean

If true, a brief tone will be played on the person’s phone when a call has been forwarded.

destinationVoicemailEnabled
boolean

Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled.

busy
object

Settings for forwarding all incoming calls to the destination you chose while phone is in use or person is set to busy.

enabled
boolean

"Busy" call forwarding is enabled or disabled.

destination
string

Destination for "Busy" call forwarding.

destinationVoicemailEnabled
boolean

Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled.

noAnswer
object

Settings for forwarding which only occurs when you are away or not answering your phone.

enabled
boolean

"No Answer" call forwarding is enabled or disabled.

destination
string

Destination for "No Answer" call forwarding.

numberOfRings
number

Number of rings before call will be forwarded if unanswered.

systemMaxNumberOfRings
number

System-wide maximum number of rings allowed for numberOfRings setting.

destinationVoicemailEnabled
boolean

Indicates enabled or disabled state of sending incoming calls to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled.

businessContinuity
object

Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem.

enabled
boolean

Business Continuity is enabled or disabled.

destination
string

Destination for Business Continuity.

destinationVoicemailEnabled
boolean

Indicates enabled or disabled state of sending incoming calls to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled.

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/callForwarding{?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/callForwarding?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    "callForwarding": {
            "always": {
                    "enabled": false,
                    "ringReminderEnabled": false,
                    "destinationVoicemailEnabled": false
            },
            "busy": {
                    "enabled": false,
                    "destinationVoicemailEnabled": false
            },
            "noAnswer": {
                    "enabled": false,
                    "numberOfRings": 2,
                    "systemMaxNumberOfRings": 20,
                    "destinationVoicemailEnabled": false
            }
    },
    "businessContinuity": {
            "enabled": false,
            "destinationVoicemailEnabled": false
    }
}