Sign inGet Started

Update a ring group

PATCH
/v1/voice/ring-groups/{ring_group_id}
const group = await bird.voice.ringGroups.update("RING_GROUP_ID", { name: "Tier 2 support" });
console.log(group.id, group.name);
响应200
{
  "id": "vrg_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Tier 2 support",
  "is_default": false,
  "online_member_count": 3,
  "created_at": "2026-10-01T12:00:00Z",
  "updated_at": "2026-10-02T09:30:00Z"
}

Renames the ring group. Renaming the default group returns 409 Conflict.

参数

ring_group_idstring

ID of the ring group.

请求载荷

name
string
必填

The ring group's new name.

响应载荷

id
string
必填

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

name
string
必填

The ring group's name.

is_default
boolean
必填

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

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.

created_at
nullable string
必填

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

updated_at
nullable string
必填

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