A ring group is a group of phone numbers, extensions or physical telephones that ring together, simultaneously, when one extension number or extension is dialed.

Get List of all Ring Group

curl --request GET \
  --url https://api.acefone.co.uk/v1/ring_groups \
  --header 'accept: application/json' \
  --header 'authorization: Authorization'

Response

Variable NameDescriptionData Type
idUnique ID of ring groupNumber
nameName for ring groupNumber
descriptionDescription for ring groupNumber
ring_strategyRing strategy associated with ring groupString
skip_busy_agentBusy extensions are not called if this is set to 1Number
prefixCaller ID prefix associated with ring groupString
timeout_destination_typeType of destination where call should be routed (when on member of ring group answers the call)String
timeout_destination_idUnique ID of destination where call should be routed (when on member of ring group answers the call)Number
intercomIntercom number set for the ring groupString
sticky_agentIs sticky agent enabled on ring groupNumber
sticky_agent_hoursTotal number of hours to check for sticky agentNumber
service_levelService level set for ring groupString
call_conversionCalls answered within service level time frame (used for service level statistics)Number
revenue_per_callString
sticky_agent_daysNumber
membersRing group members/destination associated with ring groupObject
destination_idUnique destination IDNumber
destination_typeType of destinationString
destination_ipSpecific IP on which call is to be routedString
timeoutTime till which call should be ringNumber
priorityPriority of destinationNumber
timegroupTimegroup associated with memberString
Sample JSON
{
"data":[
0:{
"id":149
"name":"Xyz"
"description":"abc"
"ring_strategy":"random"
"skip_busy_agent":1
"prefix":"wee"
"timeout_destination_type":"extension"
"timeout_destination_id":"050XXXXX01"
"intercom":"4000"
"sticky_agent":1
"sticky_agent_hours":0
"service_level":20
"call_conversion":NULL
"revenue_per_call":NULL
"sticky_agent_days":1
"members":[
0:{
"destination_id":"050XXXXX01"
"destination_type":"extension"
"destination_ip":""
"timeout":30
"priority":1
"timegroup":19
}
]
}
]
}
Language
Click Try It! to start a request and see the response here!