Number Group Membership

List number group memberships

Lists the project-owned phone numbers that belong to one Number Group. Use it to understand which senders make up the pool; use List phone numbers for all numbers owned by the project.

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/{NumberGroupId}/number_group_memberships

Request

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

Path parameters

NumberGroupIdstring uuid required

Universal Unique Identifier.

Unique ID of the number group.

Query parameters

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": [
    {
      "phone_number": {
        "name": "Jenny",
        "number": "+15558675309",
        "capabilities": [
          "voice",
          "sms",
          "mms",
          "fax"
        ]
      },
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-01-15T10:30:00Z"
    }
  ]
}

Changes

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