REST API
Getting Started Basics
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 TeamsWebex Calling Organization Settings Webex Calling Person Settings Webhooks Workspace Locations Workspace Metrics Workspaces xAPI
Guides
API Changelog

Configure Call Forwarding Settings for a Hunt Group

Configures call forwarding settings for the designated hunt group.

Configuring a hunt group requires a full or user administrator auth token with a scope of spark-admin:telephony_config_write.

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

Location from which the hunt group exists.

huntGroupId
stringrequired

Configure call forwarding settings for this hunt group.

Query Parameters
orgId
string

Configure settings from this organization.

Body Parameters
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[CallForwardRulesSet]

Rules for selectively forwarding calls.

id
stringrequired

Unique ID for the rule.

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.
PUT
/v1/telephony/config/locations//huntGroups//huntGroups//callForwarding{?orgId}
Log in to try the API.
Header
Query Parameters
  • Configure settings from this organization.
Body
  • Settings related to "Always", "Busy", and "No Answer" call forwarding.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx/huntGroups/Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0/callForwarding?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
    "callForwarding":
    {
        "always": {
            "enabled": false,
            "destination": ""},
        "selective": {
            "enabled": true,
            "destination": "35556",
            "destinationVoicemailEnabled": true},
        "rules": [
            {
                "id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlpVW1WdVlXMWw",
                "enabled": true},
            {
                "id": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WMmhsYmxSdg",
                "enabled": false}]}
}
204 / No Content