Read Call Forwarding Settings for a Virtual Line
Retrieve a virtual line'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 the phone is in use or the virtual line is 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 a power outage, failed Internet connection, or wiring problem.
Retrieving the call forwarding settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve settings for a virtual line with the matching ID.
Query Parameters
ID of the organization in which the virtual line 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.
Response Properties
Settings related to "Always", "Busy", and "No Answer" call forwarding.
Settings for forwarding all incoming calls to the destination you choose.
"Always" call forwarding is enabled or disabled.
Destination for "Always" call forwarding.
If true, a brief tone will be played on the virtual line's phone when a call has been forwarded.
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.
Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the virtual line is busy.
"Busy" call forwarding is enabled or disabled.
Destination for "Busy" call forwarding.
Indicates the 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.
Settings for forwarding which only occurs when you are away or not answering your phone.
"No Answer" call forwarding is enabled or disabled.
Destination for "No Answer" call forwarding.
Number of rings before the call will be forwarded if unanswered.
System-wide maximum number of rings allowed for numberOfRings setting.
Indicates the 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.
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.
Business Continuity is enabled or disabled.
Destination for Business Continuity.
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.
| 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 virtual line 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.
{
"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
}
}