RingGroups
ringgroups

Update RingGroup

Update a RingGroup.

put/ringgroups/{id}

Request

  • Base URL: https://api.fonestorm.com/v2
  • URL: https://api.fonestorm.com/v2/ringgroups/{id}
  • Auth: API key in header token

Path parameters

idstring required

RingGroup ID

Request body

labelstring

Name/Label for RingGroup

greetingstring

Greeting text or soundfile

ring_strategy'Simultaneous' | 'Sequential' | 'Random' | 'LongestIdle'

Ring strategy for RingGroup

max_ring_timeinteger

Maximum ring time in seconds

ring_timeoutinteger

Ring timeout in seconds

ring_busy_destinationsboolean

Ring busy destinations or not

failover_type'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector'

RingGroup Failover Type.

failoverstring

Failover ID.

Response

Success

Example response

{
  "ringgroup": {
    "id": "RG12341234",
    "label": "My RingGroup",
    "destinations": [
      {
        "destination_type": "SpeedDial"
      }
    ],
    "greeting": "SF12341234",
    "ring_strategy": "Simultaneous",
    "max_ring_time": 20,
    "ring_timeout": 20,
    "failover_type": "Voicemail",
    "failover": "VM12341234"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.