openapi: 3.0.3
info:
  title: Telefoon Number Management Available Numbers API
  description: Search, purchase, and manage Dutch, Belgian, German, and European phone numbers. Supports local geographic numbers, national numbers, toll-free (0800), premium (0900), and service numbers with full compliance for EU regulatory requirements.
  version: v1
  contact:
    name: Telefoon Support
    url: https://www.telefoon.com/support
  termsOfService: https://www.telefoon.com/terms
servers:
- url: https://api.telefoon.com/v1/numbers
  description: Telefoon Number Management API
security:
- ApiKeyAuth: []
tags:
- name: Available Numbers
  description: Search available numbers
paths:
  /available:
    get:
      operationId: searchAvailableNumbers
      summary: Search Available Numbers
      description: Search available phone numbers for European countries.
      tags:
      - Available Numbers
      parameters:
      - name: country_code
        in: query
        required: true
        schema:
          type: string
        description: ISO 3166-1 alpha-2 country code (NL, BE, DE, FR, etc.)
      - name: type
        in: query
        schema:
          type: string
          enum:
          - geographic
          - national
          - mobile
          - toll-free
          - premium-rate
          - service
        description: Number type
      - name: area_code
        in: query
        schema:
          type: string
        description: Area code / NDC (e.g., 020 for Amsterdam)
      - name: sms_enabled
        in: query
        schema:
          type: boolean
        description: Filter for SMS-capable numbers
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 20
      responses:
        '200':
          description: Available numbers
          content:
            application/json:
              schema:
                type: object
                properties:
                  available_numbers:
                    type: array
                    items:
                      $ref: '#/components/schemas/AvailableNumber'
components:
  schemas:
    AvailableNumber:
      type: object
      required:
      - phone_number
      - country_code
      - type
      properties:
        phone_number:
          type: string
          description: Phone number in E.164 format
        friendly_name:
          type: string
          description: Formatted display number
        country_code:
          type: string
          description: ISO country code
        type:
          type: string
          enum:
          - geographic
          - national
          - mobile
          - toll-free
          - premium-rate
          - service
        capabilities:
          type: object
          properties:
            voice:
              type: boolean
            sms:
              type: boolean
        monthly_rate:
          type: string
          description: Monthly fee in EUR
        address_required:
          type: boolean
          description: Whether address registration is required for compliance
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key