Get List of Ring Groups

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

ring-groups:read

Body Response - Schema

200 (list of ring groups)

ParameterTypeDescription
totalintegern/a
pageintegern/a
per_pageintegern/a
countintegern/a
_embeddedobject

A subset of the list of Ring Groups for the account. "_embedded" subdivides into:

1 - "ring_groups" (array[object]), which subdivides into:
1.1 - "name" (string) - the name that represents the ring group (required)

1.2 - "short_abandoned_threshold" (integer) - short calls that abandon before this threshold will not be reported as abandoned

1.3 - "wait_time_threshold" (integer) - calls answered within the threshold will be considered as meeting service level

_linksobject

HAL API related links. "_links" subdivides into:

1 - "self" (object), which subdivides into:
1.1 - "href" (string)

2 - "next" (object), which subdivides into:
2.1 - "href" (string)

3 - "previous" (object), which subdivides into:
3.1 - "href" (string)

4 - "page" (object), which subdivides into:
4.1 - "templated" (boolean)
4.2 - "href" (string)

400 (invalid request), 401 (the request does not contain one of the mandatory headers), 403 (the user is authenticated but does not have sufficient permissions to perform the action), 404 (not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]

"fields" subdivides into:

"name" (string)

"description" (string)

yes (name and description)
🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Query Params
int32
Defaults to 1
string
Defaults to 50
string
string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json