APIs
Getting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Overview
Guides
Reference
Admin Audit EventsEventsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person SettingsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Devices
imiconnect
Meetings
Messaging
Webex Assistant Skills
Full API Reference
Admin Audit EventsAttachment ActionsBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesMessages with EditOrganizationsPeoplePlacesRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Person SettingsWebhooksWorkspace LocationsWorkspace MetricsWorkspacesxAPI
API Changelog

Get Call Forwarding Settings for a Hunt Group

Retrieve Call Forwarding settings for the designated Hunt Group including the list of call forwarding rules.

Retrieving call forwarding settings for a hunt group requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding
URI Parameters
locationId
stringrequired

Location in which this hunt group exists.

huntGroupId
stringrequired

Read the call forwarding settings for this hunt group.

Query Parameters
orgId
string

Retrieve hunt group forwarding settings from from this organization.

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.

selective
object

Selectively forward calls to a designated number, depending on criteria rules. You'll need to have at least one rule for forwarding applied for call forwarding to be active.

enabled
boolean

"Busy" call forwarding is enabled or disabled.

destination
string

Destination for "Busy" 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.

rules
array[CallForwardRulesGet]

Rules for selectively forwarding calls.

id
string

Unique ID for the rule.

name
string

Unique name of rule.

callFrom
string

Comma-separated list of incoming call numbers that, when matched, will not be forwarded. A Limit of 12 numbers is allowed. Use Any private Number in the comma-separated value to indicate rules that match incoming calls from a private number. Use Any unavailable number in the comma-separated value to match incoming calls from an unavailable number.

callsTo
string

Comma-separated list of the types of numbers being matched for incoming call destination.

forwardTo
string

Number to which calls will be forwarded if the rule is of type "Forward To" and the incoming call is matched.

enabled
boolean

Reflects if rule is 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/telephony/config/locations//huntGroups//huntGroups//callForwarding{?orgId}
Log in to try the API.
Header
Query Parameters
  • Retrieve hunt group forwarding settings from from this organization.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx/huntGroups/Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0/callForwarding?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    "callForwarding": {
        "always": {
            "enabled": false,
            "ringReminderEnabled": false,
            "destinationVoicemailEnabled": false
        },
        "selective": {
            "enabled": false,
            "destination": "00000",
            "ringReminderEnabled": false,
            "destinationVoicemailEnabled": false
        },
        "rules": [
            {
                "id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVXg",
                "name": "testRule1",
                "forwardTo": "65546",
                "enabled": true
            },
            {
                "id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVTA",
                "name": "testRule4",
                "forwardTo": "00000",
                "enabled": true
            }
        ]
    }
}