SignalWire Number Group Membership API

openapi: 3.2.0
info:
  title: SignalWire REST Number Group Membership API
  version: 1.0.0
  contact:
    name: SignalWire
    url: https://support.signalwire.com/portal/en/newticket?departmentId=1029313000000006907&layoutId=1029313000000074011
    email: support@signalwire.com
  license:
    name: MIT
    url: https://github.com/signalwire/docs/blob/main/LICENSE
  termsOfService: https://signalwire.com/legal/signalwire-cloud-agreement
  description: Manage phone number memberships within number groups.
servers:
- url: https://{space_name}.signalwire.com
  description: SignalWire API
  variables:
    space_name:
      default: '{Your_Space_Name}'
      description: Your SignalWire Space name
security:
- SignalWireBasicAuth: []
tags:
- name: Number Group Membership
  description: Manage phone number memberships within number groups.
  externalDocs:
    url: https://signalwire.com/docs/apis
    description: Developer documentation on SignalWire REST APIs
paths:
  /api/relay/rest/number_group_memberships/{id}:
    get:
      operationId: retrieve_number_group_membership
      summary: Get number group membership
      description: 'Retrieves the details of a number group membership.


        #### 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/NumberGroupMembershipPathID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberGroupMembershipResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Number Group Membership
    delete:
      operationId: delete_number_group_membership
      summary: Delete number group membership
      description: 'Removes a phone number from a number 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/NumberGroupMembershipPathID'
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode400'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Number Group Membership
  /api/relay/rest/number_groups/{NumberGroupId}/number_group_memberships:
    get:
      operationId: list_number_group_memberships
      summary: List number group memberships
      description: 'Returns a list of phone numbers in a number 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/NumberGroupIdPath'
      - $ref: '#/components/parameters/ListNumberGroupMembershipsQuery.page_number'
      - $ref: '#/components/parameters/ListNumberGroupMembershipsQuery.page_size'
      - $ref: '#/components/parameters/ListNumberGroupMembershipsQuery.page_token'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberGroupMembershipListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Number Group Membership
    post:
      operationId: create_number_group_membership
      summary: Create number group membership
      description: 'Adds a phone number to a number 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/NumberGroupIdPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberGroupMembershipResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Number Group Membership
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddNumberGroupMembershipRequest'
components:
  schemas:
    NumberGroupMembershipListResponse:
      type: object
      required:
      - links
      - data
      properties:
        links:
          allOf:
          - $ref: '#/components/schemas/PaginationLinks'
          description: Pagination links.
        data:
          type: array
          items:
            $ref: '#/components/schemas/NumberGroupMembership'
          description: List of number group memberships.
      unevaluatedProperties:
        not: {}
      description: Response containing a list of number group memberships.
    MembershipPhoneNumber:
      type: object
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier of the phone number.
        name:
          type: string
          description: The name given to the phone number.
          examples:
          - Jenny
        number:
          type: string
          description: The phone number in E.164 format.
          examples:
          - '+15558675309'
        capabilities:
          type: array
          items:
            type: string
          description: The capabilities of the phone number.
          examples:
          - - voice
            - sms
            - mms
            - fax
      unevaluatedProperties:
        not: {}
      description: Phone number representation within a membership.
    Types.StatusCodes.StatusCode401:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Unauthorized
      unevaluatedProperties:
        not: {}
      description: Access is unauthorized.
    AddNumberGroupMembershipRequest:
      type: object
      required:
      - phone_number_id
      properties:
        phone_number_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The phone number ID to add to the group.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
      unevaluatedProperties:
        not: {}
      description: Request body for adding a phone number to a number group.
    NumberGroupMembershipResponse:
      type: object
      required:
      - id
      - number_group_id
      - phone_number
      - created_at
      - updated_at
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        number_group_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier of the Number Group this membership is associated with.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        phone_number:
          allOf:
          - $ref: '#/components/schemas/MembershipPhoneNumber'
          description: A representation of the phone number this membership is associated with.
        created_at:
          type: string
          description: The date and time when the membership was created.
          examples:
          - '2023-01-15T10:30:00Z'
        updated_at:
          type: string
          description: The date and time when the membership was last updated.
          examples:
          - '2023-01-15T10:30:00Z'
      unevaluatedProperties:
        not: {}
      description: Response containing a single number group membership.
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    Types.StatusCodes.StatusCode404:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Not Found
      unevaluatedProperties:
        not: {}
      description: The server cannot find the requested resource.
    Types.StatusCodes.ValidationError:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem'
          description: List of validation errors.
      unevaluatedProperties:
        not: {}
      description: The request failed validation. See errors for details.
    Types.StatusCodes.SpaceApiErrorItem:
      type: object
      required:
      - detail
      - status
      - title
      - code
      properties:
        detail:
          type: string
          description: A description of what caused the error.
          examples:
          - Label can't be blank
        status:
          type: string
          description: The HTTP status code.
          examples:
          - '422'
        title:
          type: string
          description: A short summary of the error type.
          examples:
          - Invalid Attribute
        code:
          type: string
          description: The error code.
          examples:
          - '422'
      unevaluatedProperties:
        not: {}
      description: Details about a specific validation error.
    Types.StatusCodes.StatusCode500:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Internal Server Error
      unevaluatedProperties:
        not: {}
      description: An internal server error occurred.
    NumberGroupMembership:
      type: object
      required:
      - id
      - number_group_id
      - phone_number
      - created_at
      - updated_at
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        number_group_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier of the Number Group this membership is associated with.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        phone_number:
          allOf:
          - $ref: '#/components/schemas/MembershipPhoneNumber'
          description: A representation of the phone number this membership is associated with.
        created_at:
          type: string
          description: The date and time when the membership was created.
          examples:
          - '2023-01-15T10:30:00Z'
        updated_at:
          type: string
          description: The date and time when the membership was last updated.
          examples:
          - '2023-01-15T10:30:00Z'
      unevaluatedProperties:
        not: {}
      description: Number group membership model.
    Types.StatusCodes.StatusCode400:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Bad Request
      unevaluatedProperties:
        not: {}
      description: The request is invalid.
    PaginationLinks:
      type: object
      required:
      - self
      - first
      properties:
        self:
          type: string
          description: Link to the current page.
        first:
          type: string
          description: Link to the first page.
        next:
          type: string
          description: Link to the next page. Only present when there are more results.
        prev:
          type: string
          description: Link to the previous page. Only present when not on the first page.
      unevaluatedProperties:
        not: {}
      description: Pagination links for list responses.
  parameters:
    NumberGroupIdPath:
      name: NumberGroupId
      in: path
      required: true
      description: Unique ID of the number group.
      schema:
        $ref: '#/components/schemas/uuid'
    ListNumberGroupMembershipsQuery.page_size:
      name: page_size
      in: query
      required: false
      description: The number of results per page.
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 1000
        default: 50
      explode: false
    NumberGroupMembershipPathID:
      name: id
      in: path
      required: true
      description: Unique ID of the number group membership.
      schema:
        $ref: '#/components/schemas/uuid'
    ListNumberGroupMembershipsQuery.page_token:
      name: page_token
      in: query
      required: false
      description: Token for cursor-based pagination.
      schema:
        type: string
      explode: false
    ListNumberGroupMembershipsQuery.page_number:
      name: page_number
      in: query
      required: false
      description: The page number to retrieve.
      schema:
        type: integer
        format: int32
        default: 0
      explode: false
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: Basic
      description: 'SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of project_id:token.

        The project ID will be used as the username and the API token as the password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```'
      x-fern-basic:
        username:
          name: project_id
          env: SIGNALWIRE_PROJECT_ID
        password:
          name: api_token
          env: SIGNALWIRE_API_TOKEN
    SignalWireBearerAuth:
      type: http
      scheme: Bearer
      description: 'SignalWire Bearer Token Authentication for subscriber endpoints.

        The client sends HTTP requests with the Authorization header containing

        the word Bearer followed by a space and the subscriber token.


        Example:

        ```

        Authorization: Bearer <subscriber_token>

        ```'