Get Available Ring Groups for IVRs

Retrieve the ring groups that can be selected when adding or editing an IVR.

Request URL

GET {base_url}/uc-cconfig/api/v1/ivrs/ring-groups

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
results Array<Ring_Group_Option> The list of available ring groups.
Ring_Group_Option
Parameter Type Description
id String The unique identifer of the ring group.
extension String The extension number of the ring group.
name String The name of the ring group.

Example

Request example

GET /uc-cconfig/api/v1/ivrs/ring-groups HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc3Mzg0NSwiaWF0IjoxNzkwNzUyMjQ1LCJqdGkiOiIwODdjMzkyNS0yMjU3LTRlOTMtOGJlYS0zZjg0NDRmZWFjZTciLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.uThx_0gcb83u-i-zjDfTh-a-O-awJXx3TzGsVBno6M_qdiyisg3PFAf-wIsKZTfnDnweAJLrsZ_hUA4qB0p3jiCrtuqjrSbdmsjJsO-QEF4_8jT8jFt3rkAqFAG9mK6J4esaoZCBDDw_wRMIDkd9DhWyVw-i1_T59mq_MMZPh4cVLbYpoObsUPPPpNSZ-JFXwnB7ZWR6z78lwBuBJKlWN8Qg2b80FG3IPwyUwkg6KsgAMHAaGc6RaKldzGOwJPgQyAJgU-NvcfazXcMCcsZnHWPPBJZytcKrqWlbxPZZp4_-5POHNC6J3e8-_Y59LBqEnkiPA7A1aSa0QRWBBJTcJw
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
    "requestId": "459951c6c8bbc2a6e9625d308dbbf212",
    "code": "200",
    "message": "SUCCESS",
    "detailMessage": "",
    "results": [
        {
            "id": "342547744471269376",
            "extension": "6300",
            "name": "6300"
        }
    ]
}