Number Groups

List number groups

Lists the Number Groups in your SignalWire project. A Number Group organizes owned phone numbers into a sender pool and can preserve the same sender for repeated outbound traffic with sticky_sender. Use List number group memberships to see which numbers belong to a group. Results are sorted by creation date, most recent first.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

get/api/relay/rest/number_groups

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/number_groups
  • Auth
    HTTP basic

Query parameters

filter_namestring

Filter by name. Returns all number groups containing this value as a substring.

page_numberinteger

The page number to retrieve.

page_sizeinteger

The number of results per page.

page_tokenstring

Token for cursor-based pagination.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "name": "My Number Group",
      "phone_number_count": 4
    }
  ]
}

Changes

No operation changes found yet. Some revisions have not been checked.