Sign inGet Started

Create a ring group

POST
/v1/voice/ring-groups
const group = await bird.voice.ringGroups.create({ name: "Support" });
console.log(group.id, group.name);
Respons201
{
  "id": "vrg_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Support",
  "is_default": false,
  "online_member_count": 0,
  "created_at": "2026-10-01T12:00:00Z",
  "updated_at": "2026-10-01T12:00:00Z"
}

Creates a ring group with no members. Add members with POST /v1/voice/ring-groups/{ring_group_id}/members.

A workspace can have at most 50 ring groups besides its default group. Creating another returns 422.

Payload Permintaan

name
string
wajib

The ring group's name.

Payload Respons

id
string
wajib

Unique identifier for this ring group. The default group's ID is vrg_ followed by the workspace ID's suffix.

name
string
wajib

The ring group's name.

is_default
boolean
wajib

Whether this is the workspace's default group, which rings the users who are online in the browser phone.

online_member_count
integer
wajib

How many of the group's members are connected to the browser phone and accepting calls, read live. A member on a call counts, though a call to the group skips them until it ends. For the default group, the count includes every connected user who accepts calls.

created_at
nullable string
wajib

When the ring group was created. Null for the default group.

updated_at
nullable string
wajib

When the ring group's name or members last changed. Null for the default group.