Webex APIs
OverviewBasicsComplianceHybrid ServicesAPI Changelog
Full API reference
Admin Audit Events Attachment Actions BroadWorks Enterprises BroadWorks Subscribers Call Controls Device Configurations Devices Events Historical Analytics Hybrid Clusters Hybrid Connectors Licenses Locations Meeting Invitees Meeting Participants Meeting Preferences Meeting Qualities Meeting Transcripts Meetings Memberships Messages Organizations People Places Recordings Report Templates Reports Resource Group Memberships Resource Groups Roles Room Tabs Rooms Space Classifications Team Memberships Teams Webex Calling Organization Settings Webex Calling Person Settings Webhooks Workspace Metrics Workspaces xAPI

Read Call Forwarding Rule Settings

Read a Selective Call Forwarding Rule Settings.

A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

Note that the list of existing call forward rules is available in the call queue's call forwarding settings.

Reading information about a call queue requires a full, user, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

NOTE: The Call Forwarding Rule ID will change upon modification of the Call Forwarding Rule name.

GET/v1/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules/{ruleId}
URI Parameters
locationId
stringrequired

Location in which to call queue exists.

queueId
stringrequired

Return setting for a rule for this call queue.

ruleId
stringrequired

Call queue you are retrieving settings for.

Query Parameters
orgId
string

Get settings for this organization.

Response Properties
name
string

Unique name for the selective rule in the hunt group.

id
string

Unique ID for the rule.

enabled
boolean

Reflects if rule is enabled.

holidaySchedule
string

Name of the location's holiday schedule which determines when this selective call forwarding rule is in effect.

businessSchedule
string

Name of the location's business schedule which determines when this selective call forwarding rule is in effect.

forwardTo
object

Controls what happens when the rule matches including the destination number for the call forwarding.

selection
enum

Controls what happens when the rule matches.

FORWARD_TO_DEFAULT_NUMBER
string

When the rule matches, forward to the destination for the hunt group.

FORWARD_TO_SPECIFIED_NUMBER
string

When the rule matches, forward to the destination for this rule.

DO_NOT_FORWARD
string

When the rule matches, do not forward to another number.

phoneNumber
string

Phone number used if selection is FORWARD_TO_SPECIFIED_NUMBER.

callsFrom
object

Settings related to the rule matching based on incoming caller ID.

selection
enum

If CUSTOM, use "customNumbers" to specify which incoming caller ID values cause this rule to match. ANY means any incoming call matches assuming the rule is in effect based on the associated schedules.

ANY
string

Rule matches for calls from any number.

CUSTOM
string

Rule matches based on the numbers and options in customNumbers.

customNumbers
object

Custom rules for matching incoming caller ID information.

privateNumberEnabled
boolean

Match if caller ID indicates the call is from a private number.

unavailableNumberEnabled
boolean

Match if caller ID is unavailable.

numbers
array

Array of numbers to be matched against incoming caller ID.

callsTo
object

Settings related to the rule matching based on the destination number.

numbers
array

Array of numbers to be matched against the calling destination number.

phoneNumber
string

Only return call queues with matching primary phone number or extension.

extension
string

Primary phone extension of the call queue.

type
enum

Type of

PRIMARY
string

Indicates that the given phoneNumber or extension associated with this rule's containing object is a primary number or extension.

ALTERNATE
string

Indicates that the given phoneNumber or extension associated with this rule's containing object is an alternate number or extension.

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/telephony/config/locations//queues//callForwarding/selectiveRules//queues//callForwarding/selectiveRules/{?orgId}
Log in to try the API.
Header
Query Parameters
  • Get settings for this organization.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA/queues/Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0/callForwarding/selectiveRules/Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    {
        "name": "My Rule",
        "id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WMmhsYmxSdg",
        "enabled": true,
        "businessSchedule": "BusiSched1",
        "holidaySchedule": "HolSched1",
        "forwardTo":
            {
                "selection": "FORWARD_TO_DEFAULT_NUMBER"},
                "callsFrom":
                    {
                        "selection": "CUSTOM",
                        "customNumbers":
                            {
                                "privateNumberEnabled": true,
                                "unavailableNumberEnabled": true,
                                "numbers": ["2025551212"]
                            }
                    },
                "callsTo": { "numbers": [] }
}