REST ClientNumber Groups

create

View as MarkdownOpen in Claude

Create a new number group.

Request

namestringRequired
The name given to the number group. Helps to distinguish different groups within your project.
sticky_senderbooleanOptionalDefaults to false
Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one.

Response

idstringRequiredformat: "uuid"
The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically.
namestringRequired
The name given to the number group. Helps to distinguish different groups within your project.
sticky_senderbooleanRequired
Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one.
phone_number_countintegerRequired
The number of phone numbers within the group.

Response Example

Response
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "name": "My Number Group",
4  "sticky_sender": false,
5  "phone_number_count": 4
6}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const group = await client.numberGroups.create({ name: "Sales Numbers" });
10console.log("Group ID:", group.id);