openapi: 3.2.0
info:
  title: Teliax Messaging NNIDs API
  version: v1
  contact:
    name: Ringer API Support
    url: https://ringer.tel
    email: api-support@ringer.tel
  description: 'Operations tagged Messaging NNIDs across 2 of this provider''s published API definitions: teliax-tniq-openapi.json, teliax-tniq-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.tniq.ringer.tel
  description: Production
- url: https://tniq-api.ringer.tel
  description: Production (legacy alias)
- url: https://staging-api.ringer.tel
  description: Staging
tags:
- name: Messaging NNIDs
  description: NetNumber ID management for SMS provisioning
paths:
  /v1/messaging/nnids/{nnidId}:
    get:
      tags:
      - Messaging NNIDs
      summary: Get NNID
      operationId: getNnid
      parameters:
      - name: nnidId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    put:
      tags:
      - Messaging NNIDs
      summary: Update NNID
      operationId: updateNnid
      parameters:
      - name: nnidId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNnidRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    delete:
      tags:
      - Messaging NNIDs
      summary: Delete NNID
      operationId: deleteNnid
      parameters:
      - name: nnidId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/messaging/nnids:
    get:
      tags:
      - Messaging NNIDs
      summary: List NNIDs
      description: List NNIDs for the customer. Optional spid= filters to that SPID's allow-list (Phase B TN-card source). Omit spid for the full customer_nnids list.
      operationId: listNnids
      parameters:
      - name: customerId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      - name: spid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    post:
      tags:
      - Messaging NNIDs
      summary: Create NNID
      description: Add a new NNID for the customer
      operationId: createNnid
      parameters:
      - name: customerId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNnidRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
components:
  schemas:
    CreateNnidRequest:
      required:
      - nnid
      type: object
      properties:
        nnid:
          type: string
        description:
          type: string
        carrierCode:
          type: string
        spid:
          type: string
        isDefault:
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Bearer token authentication. Pass your API token or user JWT in the Authorization header: Authorization: Bearer YOUR_TOKEN'
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- teliax-tniq-openapi.json
- teliax-tniq-openapi.yml