Get a Ring Group

Retrieves the details of a ring group.

Request URL

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

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.
Path parameters
Parameter Required Type Description
id Yes String The ring group ID. You can obtain the ID using the Search Ring Groups 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.
result Object<Ring_Group> The details of the ring group.
Ring_Group
Parameter Type Description
id String The ID of the ring group.
extension String The extension number of the ring group.
name String The name of the ring group.
ringStrategy String The ringing strategy:
  • RING_ALL: Ring all the members at the same time.
  • SEQUENTIALLY: Ring the members one by one in order.
  • MEMORY_HUNT: Ring from the member who answered the last call first.
ringTimeout Integer The ring timeout for each round, in seconds.
members Array<Member> The list of ring group members.
joinAnnouncement String The join announcement of the ring group.
playJoinAnnouncementBeforeRinging Boolean Whether to play the join announcement before ringing.
musicOnWait String The music on wait.
musicOnHold String The music on hold.
alertInfo String The Alert-Info SIP header for outbound calls.
failoverDestination Object<Destination> The failover destination when the call is not answered.
recordMissCalls Boolean Whether to record missed calls.
version Integer The version number of the data, which increments on each change.
createdAt String The time when the ring group was created, in Unix timestamp format (milliseconds).
updatedAt String The time when the ring group was last updated, in Unix timestamp format (milliseconds).
timeBasedRoutingEnabled Boolean Whether time-based routing is enabled.
timeBasedRoutingProfileId String The ID of the business hours configuration associated with time-based routing.
timeBasedRoutingConfig Object<Time_Based_Routing_Config> The time-based routing configuration.
directDidNumbers Array<Direct_Did_Number> The list of DIDs bound to the ring group destinations.
Member
Parameter Type Description
userId String The ID of the user.
extension String The extension number of the user.
name String The name of the member.
Destination
Parameter Type Description
type String The destination type:
  • HANGUP: Hang up.
  • USER: Extension.
  • IVR: IVR.
  • RING_GROUP: Ring group.
  • EXTERNAL_NUMBER: External number.
  • QUEUE: Queue.
  • USER_VOICEMAIL: User voicemail. value is the user ID.
  • GROUP_VOICEMAIL: Group voicemail. value is the ring group ID.
  • PLAY_PROMPT: Play the prompt and hang up. value is the prompt file name.
  • RECEIVE_CALLS: Receive calls, which are handled by the feature itself. This type applies to the outside and holiday destinations of time-based routing only.
value String The destination value, such as the resource ID, prompt file name, or external number.
prefix String The dial-out prefix. This parameter applies only when type is EXTERNAL_NUMBER.
repeatCount Integer The number of playback times, ranging from 1 to 5. This parameter applies only when type is PLAY_PROMPT. 0 means not set.
Time_Based_Routing_Config
Parameter Type Description
holidayHandling String The holiday handling mode:
  • route: Route calls to the holiday destination.
  • play_prompt: Play the prompt.
  • ignore: Ignore holidays and follow the normal routing.
outsideDestination Object<Destination> The destination outside business hours.
holidayDestination Object<Destination> The destination on holidays.
Direct_Did_Number
Parameter Type Description
id String The DID ID.
number String The DID number.
name String The DID name.

Example

Request example

GET /uc-cconfig/api/v1/ring-groups/363588204383244288 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc3NTMyMCwiaWF0IjoxNzkwNzUzNzIwLCJqdGkiOiI2ZDg1ZTg2NC1jOTk0LTRjZTItOGUzYi1mMTRiODE1Y2M4NDIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.o8tXb4Q9dImuGjtnui9LWTCukF9S5HKMkqYYWT7rjd1H7_2S40ZUjYuGonzGZR37q66kWBxrbHI0a9c7ICQO4MAq-0X0Ev6coK1Q8ud9yWFq1cf7H58pC0wYxE_bCjnDdKLxQk6lHCFbD_WiMTjuuK_Vtckuv6sI9-3ILspzK1WLJLktESKBV1qbsMJY-pO-pD8enoZq9I1Lo_kWIOHckg5Hq4kKjwq9iN1pecnSVQwKsL5Z8KDiJS8QXuoJrZtySacLbGB0-_GeljzDXk5JmsmOrpUr3UWDD7Lh4rcYq3Xwc6ya126GV5ETTZHAM4uX-OWev69cR29MHRxw5eNZIw
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "824640731d85767006abcf3896013a35",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "363588204383244288",
    "extension": "6300",
    "name": "zz-test-rg",
    "ringStrategy": "SEQUENTIALLY",
    "ringTimeout": 30,
    "members": [
      {
        "userId": "355536619424391168",
        "extension": "1000",
        "name": "3 1"
      }
    ],
    "musicOnWait": "[Default]",
    "musicOnHold": "[Default]",
    "failoverDestination": {
      "type": "USER_VOICEMAIL",
      "value": "355536619424391168",
      "prefix": "",
      "repeatCount": 0
    },
    "version": 1,
    "createdAt": "1790753383077",
    "updatedAt": "1790753383077"
  }
}