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);
}

groups = client.voice.ring_groups.list()
for group in groups.data:
    print(group.id, group.name, group.online_member_count)

groups, err := client.Voice.RingGroups.List(context.Background())
if err != nil {
	log.Fatal(err)
}
for _, group := range groups.Data {
	fmt.Println(group.Id, group.Name, group.OnlineMemberCount)
}

$groups = $bird->voice->ringGroups->list();
foreach ($groups->getData() ?? [] as $group) {
    echo $group->getId(), ' ', $group->getName(), ' ', $group->getOnlineMemberCount(), "\n";
}

bird voice ring-groups list

curl -X GET "https://us1.platform.bird.com/v1/voice/ring-groups" \
  -H "Authorization: Bearer $TOKEN"

Resposta200

{
  "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.

Payload de resposta

data

array of object

obrigatório

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

Mostrar atributos secundários

data.id

string

obrigatório

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

data.name

string

obrigatório

The ring group's name.

data.is_default

boolean

obrigatório

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

data.online_member_count

integer

obrigatório

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

obrigatório

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

data.updated_at

nullable string

obrigatório

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

Continue com a documentação, guias e exemplos sobre este tópico.

Obtenha um resumo de implementação

const groups = await bird.voice.ringGroups.list();
for (const group of groups.data) {
  console.log(group.id, group.name, group.online_member_count);
}

groups = client.voice.ring_groups.list()
for group in groups.data:
    print(group.id, group.name, group.online_member_count)

groups, err := client.Voice.RingGroups.List(context.Background())
if err != nil {
	log.Fatal(err)
}
for _, group := range groups.Data {
	fmt.Println(group.Id, group.Name, group.OnlineMemberCount)
}

$groups = $bird->voice->ringGroups->list();
foreach ($groups->getData() ?? [] as $group) {
    echo $group->getId(), ' ', $group->getName(), ' ', $group->getOnlineMemberCount(), "\n";
}

bird voice ring-groups list

curl -X GET "https://us1.platform.bird.com/v1/voice/ring-groups" \
  -H "Authorization: Bearer $TOKEN"

Resposta200

{
  "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"
    }
  ]
}

List ring groups

Payload de resposta

Recursos relacionados