post https://api.fonestorm.com/v2/ringgroups
Add a new RingGroup to an account.
Notes
label
label
Name/Label for the RingGroup
destinations
destinations
Array of destination objects.
Destination Object:
destination_type
- Destination type can be Device or SpeedDial.destination
- Destination can be a device id or a speed dial, which depends on the destination_type.
greeting
greeting
Greeting message for incoming calls. It can be a sound file or text.
ring_strategy
ring_strategy
Four ring strategies are supported:
Simultaneous
- Ring all destinations simultaneousSequential
- Ring all destinations is a sequence one by oneRandom
- Ring all destinations randomly one by oneLongestIdle
- Ring a destination which was idle from longest time
max_ring_time
max_ring_time
Maximum ring time in seconds for a destination. After seconds pass next destination will ring.
ring_timeout
ring_timeout
Ring timeout in seconds. Call will be sent to failover if no one answers call until specified seconds.
ring_busy_destinations
ring_busy_destinations
Ring busy destination or not.
failover_type
failover_type
Failover type for the RingGroup. FracTEL network will send call to failover destination after ring_timeout
seconds pass.
failover_type | failover | Example |
---|---|---|
Hangup | Hangup incoming call | |
Reject | Reject incoming call | |
Busy | Send busy signal to the incoming call | |
Device | The ID for the destination device | 987123543678 |
Phonenumber | A forwarding phone number | 3215551111 |
Conference | The ID for the destination Conference | 456123543123 |
IVRMenu | The ID for the destination IVRMenu | 456123543678 |
Scheduler | The ID for the destination Scheduler | 123123543678 |
Voicemail | The ID for the destination Voicemail Box | 298123543678 |
failover
failover
Failover depends on the failover type.
Sample Response
{
"ringgroup": {
"id":"RINGGRP0101010102",
"label":"RingGroup Test 2",
"destinations": [{
"destination_type":"SpeedDial",
"destination":"101"
},
{
"destination_type":"Device",
"destination":"101010101011"
}],
"greeting":"TTS:Hello this is a welcome message",
"ring_strategy":"Random",
"max_ring_time":"",
"ring_timeout":15,
"ring_busy_destinations":true,
"failover_type":"Reject",
"failover":""
}
}
Response Properties
Property | Type | Description |
---|---|---|
id | string | RingGroup ID |
label | string | Name/Label for RingGroup |
destinations | array | Array of destination objects consisting destination type and destination id |
greeting | string | Sound file URL or Text to speech string |
ring_strategy | string | One of the ring strategy - Simultaneous, Sequential, Random or LongestIdle |
max_ring_time | integer | Maximum ring time in seconds |
ring_timeout | integer | Ring timeout in seconds |
ring_busy_destinations | boolean | Ring busy destinations yes or no |
failover_type | string | One of the supported Failover destinations - Conference, Hangup, Busy, Reject, Forward, IVRMenu, Scheduler, Device, Voicemail |
failover | string | Failover ID |