openapi: 3.0.0
info:
title: 'Webex Admin Address Book Features: Hunt Group API'
version: 1.0.0
description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: 'Features: Hunt Group'
paths:
/telephony/config/huntGroups:
get:
responses:
'200':
description: OK
headers:
Link:
schema:
type: string
content:
application/json:
schema:
type: object
required:
- huntGroups
properties:
huntGroups:
type: array
items:
$ref: '#/components/schemas/ListHuntGroupObject'
description: Array of hunt groups.
example:
huntGroups:
- id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
name: '5714328359'
locationName: WXCSIVDKCPAPIC4S1
locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
routingPrefix: '123'
esn: '1239097'
enabled: true
- id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYVhZd2QySTJNbmM1YWtBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
name: bram
locationName: Brampton
locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQwMjgw
phoneNumber: '+15558675309'
routingPrefix: '123'
esn: '1239097'
enabled: true
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Read the List of Hunt Groups
operationId: listHuntGroups
description: 'List all calling Hunt Groups for the organization.
Hunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group.
Retrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
tags:
- 'Features: Hunt Group'
parameters:
- name: orgId
in: query
description: List hunt groups for this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
- name: locationId
in: query
description: Only return hunt groups with matching location ID.
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
schema:
type: string
- name: max
in: query
description: Limit the number of objects returned to this maximum count.
example: '5'
schema:
type: number
- name: start
in: query
description: Start at the zero-based offset in the list of matching objects.
example: '0'
schema:
type: number
- name: name
in: query
description: Only return hunt groups with the matching name.
example: Customer Support
schema:
type: string
- name: phoneNumber
in: query
description: Only return hunt groups with the matching primary phone number or extension.
example: '+15558675309'
schema:
type: string
/telephony/config/locations/{locationId}/huntGroups:
post:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
type: string
description: ID of the newly created hunt group.
example:
id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Create a Hunt Group
operationId: createHuntGroup
description: 'Create new Hunt Groups for the given location.
Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.
Creating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
tags:
- 'Features: Hunt Group'
parameters:
- name: locationId
in: path
description: Create the hunt group for the given location.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg
schema:
type: string
- name: orgId
in: query
description: Create the hunt group for this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
requestBody:
content:
application/json:
example:
name: '5714328359'
phoneNumber: '+15558675309'
extension: '7781'
firstName: Hakim
lastName: Smith
callPolicies:
policy: UNIFORM
waitingEnabled: false
groupBusyEnabled: true
allowMembersToControlGroupBusyEnabled: true
noAnswer:
nextAgentEnabled: false
nextAgentRings: 5
forwardEnabled: false
numberOfRings: 0
destinationVoicemailEnabled: false
busyRedirect:
enabled: true
destination: '7037344404'
destinationVoicemailEnabled: true
businessContinuityRedirect:
enabled: true
destination: '7037344405'
destinationVoicemailEnabled: false
agents:
- id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI
- id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzU1YjUyZThhLWZmOWYtMTFlYi05ZjRhLTAzZDY1NzdhYzg1Yg
- id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9kZXRhMXZqeTBsQDY0OTQxMjk3LmludDEwLmJjbGQud2ViZXguY29t
enabled: true
huntGroupCallerIdForOutgoingCallsEnabled: true
directLineCallerIdName:
selection: CUSTOM_NAME
customName: Hakim Smith
dialByName: Hakim Smith
schema:
$ref: '#/components/schemas/CreateHuntGroupObject'
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}:
delete:
responses:
'204':
description: No Content
headers: {}
content: {}
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Delete a Hunt Group
operationId: deleteHuntGroup
description: 'Delete the designated Hunt Group.
Hunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group.
Deleting a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
tags:
- 'Features: Hunt Group'
parameters:
- name: locationId
in: path
description: Location from which to delete a hunt group.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
schema:
type: string
- name: huntGroupId
in: path
description: Delete the hunt group with the matching ID.
required: true
example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
schema:
type: string
- name: orgId
in: query
description: Delete the hunt group from this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetHuntGroupObject'
example:
id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
name: hgnME3
enabled: true
extension: 079999
distinctiveRing: true
alternateNumbers: []
language: English
languageCode: en-US
callingFirstName: .
callingLastName: hgnME3
timeZone: America/Los_Angeles
callPolicies:
policy: UNIFORM
waitingEnabled: false
groupBusyEnabled: true
allowMembersToControlGroupBusyEnabled: true
noAnswer:
nextAgentEnabled: false
nextAgentRings: 5
forwardEnabled: false
numberOfRings: 0
systemMaxNumberOfRing: 20
destinationVoicemailEnabled: false
busyRedirect:
enabled: true
destination: '7037344404'
destinationVoicemailEnabled: true
businessContinuityRedirect:
enabled: true
destination: '7037344405'
destinationVoicemailEnabled: false
agents:
- id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI
firstName: John
lastName: Doe
type: PEOPLE
phoneNumber: '+15558675310'
extension: '7781'
routingPrefix: '123'
esn: '1237781'
- id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ
firstName: Alaska Office
lastName: Second Floor
type: PLACE
phoneNumber: '+15558675311'
extension: '7781'
routingPrefix: '123'
esn: '1237781'
- id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg=
firstName: Alice
lastName: Smith
type: VIRTUAL_LINE
phoneNumber: '+15558675311'
extension: '7782'
routingPrefix: '123'
esn: '1237781'
huntGroupCallerIdForOutgoingCallsEnabled: true
directLineCallerIdName:
selection: CUSTOM_NAME
customName: Hakim Smith
dialByName: Hakim Smith
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Get Details for a Hunt Group
operationId: getHuntGroup
description: 'Retrieve Hunt Group details.
Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.
Retrieving hunt group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
tags:
- 'Features: Hunt Group'
parameters:
- name: locationId
in: path
description: Retrieve settings for a hunt group in this location.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg
schema:
type: string
- name: huntGroupId
in: path
description: Retrieve settings for the hunt group with this identifier.
required: true
example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
schema:
type: string
- name: orgId
in: query
description: Retrieve hunt group settings from this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
put:
responses:
'204':
description: No Content
headers: {}
content: {}
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Update a Hunt Group
operationId: updateHuntGroup
description: 'Update the designated Hunt Group.
Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.
Updating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
tags:
- 'Features: Hunt Group'
parameters:
- name: locationId
in: path
description: Update the hunt group for this location.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg
schema:
type: string
- name: huntGroupId
in: path
description: Update settings for the hunt group with the matching ID.
required: true
example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0
schema:
type: string
- name: orgId
in: query
description: Update hunt group settings from this organization.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
requestBody:
content:
application/json:
example:
name: '5714328359'
phoneNumber: '+15558675309'
extension: '7781'
firstName: Hakim
lastName: Smith
callPolicies:
policy: UNIFORM
waitingEnabled: false
groupBusyEnabled: true
allowMembersToControlGroupBusyEnabled: true
noAnswer:
nextAgentEnabled: false
nextAgentRings: 5
forwardEnabled: false
numberOfRings: 0
destinationVoicemailEnabled: false
busyRedirect:
enabled: true
destination: '7037344404'
destinationVoicemailEnabled: false
businessContinuityRedirect:
enabled: true
destination: '7037344405'
destinationVoicemailEnabled: false
agents:
- id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YTUwMDk1YS1mZjlmLTExZWItODA2NS04ZjhkOWIxNmIzOTQ
- id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ
enabled: true
huntGroupCallerIdForOutgoingCallsEnabled: true
directLineCallerIdName:
selection: CUSTOM_NAME
customName: Hakim Smith
dialByName: Hakim Smith
schema:
$ref: '#/components/schemas/ModifyHuntGroupObject'
/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CallForwardSettingsGet'
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Get Call Forwarding Settings for a Hunt Group
operationId: getHuntGroupCallForwardingSettings
description: 'Retrieve Call Forwarding settings for the specified Hunt Group including the list of call forwarding rules.
The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.
Below are the available options for configuring your call forwarding:
1. Always forward calls to a designated number.
2. Forward calls to a designated number based on certain criteria.
3. Forward calls using different modes.
Retrieving call forwarding settings for a hunt group requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
tags:
- 'Features: Hunt Group'
parameters:
- name: locationId
in: path
description: Location in which this hunt group exists.
required: true
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx
schema:
type: string
- name: huntGroupId
in: path
description: Read the call forwarding settings for this hunt group.
required: true
example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvMzk1ODc4ZGEtZmZmZS00YTI2LWJlOTctMjdhZmZmOT
# --- truncated at 32 KB (140 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-features-hunt-group-api-openapi.yml