API reference

Carrier ring groups

Create and manage ring groups so inbound calls ring a team of agents simultaneously, first-to-answer wins.

Ring group resource

RingGroupjson

{
  "data": {
    "id": "RG…",
    "type": "ring_group",
    "attributes": {
      "name": "Support Team",
      "strategy": "simultaneous",
      "timeout": 30
    }
  }
}

Strategies

strategy	Behavior
`simultaneous`	Ring every available agent at once; first answer wins.
`round_robin`	Ring agents one at a time in order.
`least_recent`	Ring the agent who answered least recently.
`least_busy`	Ring the agent with the least active load.
`random`	Ring a random available agent.

Create a ring group

POST/carrier/v1/accounts/{account_id}/ring_groups

Parameter	Type	Description
`data.type` required	`string`	`ring_group`
`data.attributes.name` required	`string`	Human-readable name.
`data.attributes.strategy` optional	`string`	Routing strategy (see table).
`data.attributes.timeout` optional	`integer`	Seconds to ring before giving up (default 30).

List ring groups

GET/carrier/v1/accounts/{account_id}/ring_groups

Return an account's ring groups.

Fetch a ring group

GET/carrier/v1/accounts/{account_id}/ring_groups/{id}

Return a single ring group with its members.

Add an agent

POST/carrier/v1/accounts/{account_id}/ring_groups/{id}/add_agent

Add an agent extension to the ring group.

Parameter	Type	Description
`data.type` required	`string`	`ring_group_member`
`data.attributes.agent_extension_id` required	`string`	The agent extension to add.

Remove an agent

POST/carrier/v1/accounts/{account_id}/ring_groups/{id}/remove_agent

Remove an agent extension from the ring group.

Parameter	Type	Description
`data.type` required	`string`	`ring_group_member`
`data.attributes.agent_extension_id` required	`string`	The agent extension to remove.

Update a ring group

PATCH/carrier/v1/accounts/{account_id}/ring_groups/{id}

Change the name, strategy, or timeout.

Delete a ring group

DELETE/carrier/v1/accounts/{account_id}/ring_groups/{id}

Delete the ring group. Numbers assigned to it will stop routing through it.

Ring groups are covered in the call routing guide.