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 the List of Hunt Groups

Lists 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, user, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/huntGroups
Query Parameters
orgId
string

List hunt groups for this organization.

locationId
string

Only return hunt groups with matching location ID.

max
number

Limit number of objects returned to this maximum count.

start
number

Start at the zero-based offset in the list of matching objects.

name
string

Only return hunt groups with the matching name.

phoneNumber
string

Only return hunt groups with the matching primary phone number or extension.

Response Properties
huntGroups
array

Array of hunt groups.

id
string

A unique identifier for the hunt group.

name
string

Unique name for the hunt group.

locationName
string

Name of location for hunt group.

locationId
string

ID of location for hunt group.

phoneNumber
string

Primary phone number of the hunt group.

extension
string

Primary phone extension of the hunt group.

enabled
boolean

Whether or not the hunt group 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/huntGroups{?orgId,locationId,max,start,name,phoneNumber}
Log in to try the API.
Header
Query Parameters
  • List hunt groups for this organization.
  • Only return hunt groups with matching location ID.
  • Limit number of objects returned to this maximum count.
  • Start at the zero-based offset in the list of matching objects.
  • Only return hunt groups with the matching name.
  • Only return hunt groups with the matching primary phone number or extension.
https://webexapis.com/v1/telephony/config/huntGroups?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&locationId=Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA&max=5&start=0&name=Customer%20Support&phoneNumber=5558675309
200 / OK
{
    "huntGroups": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
            "name": "5714328359",
            "locationName": "WXCSIVDKCPAPIC4S1",
            "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
            "enabled": true
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYVhZd2QySTJNbmM1YWtBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
            "name": "bram",
            "locationName": "Brampton",
            "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw",
            "phoneNumber": "5558675309",
            "enabled": true
        }
    ]
}