Number Group Membership

Create number group membership

Adds one project-owned phone number to a Number Group by phone-number ID. Use it to build or expand a sender pool after creating the group; this operation does not purchase or import the number. A phone number can belong to more than one group.

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.

post/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.

Request body

phone_number_idstring uuid required

Universal Unique Identifier.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

number_group_idstring uuid required

Universal Unique Identifier.

created_atstring required

The date and time when the membership was created.

updated_atstring required

The date and time when the membership was last updated.

Example response

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