These docs are for v2.11. Click to read the latest docs for v2.12.

Get RingGroups

Get a list of all ringgroups.

This will return a listing of all the ringgroups belonging to the FracTEL account associated with the API token being used.

Sample Response

{
  "ringgroups":[{
    "id":"RINGGRP0101010101",
    "label":"RingGroup Test 1",
    "destinations": [{
      "destination_type":"Device",
      "destination":"101010101010"
    },
    {
      "destination_type":"Device",
      "destination":"101010101011"
    }],
    "greeting":"TTS:Hello this is a welcome message",
    "ring_strategy":"Simultaneous",
    "max_ring_time":"",
    "ring_timeout":15,
    "ring_busy_destinations":true,
    "failover_type":"Hangup",
    "failover":""
  },
  {
    "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

PropertyTypeDescription
ringgroupsarrayArray of RingGroup
Language
Credentials
Header
Click Try It! to start a request and see the response here!