Sign inGet Started

List ring groups

GET
/v1/voice/ring-groups
const groups = await bird.voice.ringGroups.list();
for (const group of groups.data) {
  console.log(group.id, group.name, group.online_member_count);
}
प्रतिक्रिया200
{
  "data": [
    {
      "id": "vrg_01j8z5k2qvfpx9m3n7r4t6y8bc",
      "name": "Default",
      "is_default": true,
      "online_member_count": 5,
      "created_at": null,
      "updated_at": null
    },
    {
      "id": "vrg_01krdgeqcxet5s7t44vh8rt9mg",
      "name": "Support",
      "is_default": false,
      "online_member_count": 3,
      "created_at": "2026-10-01T12:00:00Z",
      "updated_at": "2026-10-01T12:00:00Z"
    }
  ]
}

Returns the workspace's ring groups. The first is always the default group, which is not stored: it rings the users who are online in the browser phone. The others follow, oldest first.

Response Payload

data
array of object
आवश्यक

The default group first, then the other ring groups, oldest first.

चाइल्ड एट्रिब्यूट दिखाएँ
data.id
string
आवश्यक

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

data.name
string
आवश्यक

The ring group's name.

data.is_default
boolean
आवश्यक

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

data.online_member_count
integer
आवश्यक

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.

data.created_at
nullable string
आवश्यक

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

data.updated_at
nullable string
आवश्यक

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

इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।