Bandwidth Phone Numbers API — Available Numbers

naftiko: 1.0.0-alpha2
info:
  label: Bandwidth Phone Numbers API — Available Numbers
  description: 'Bandwidth Phone Numbers API — Available Numbers. 1 operations. Lead operation: Search available phone numbers.
    Self-contained Naftiko capability covering one Bandwidth business surface.'
  tags:
  - Bandwidth
  - Available Numbers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BANDWIDTH_API_KEY: BANDWIDTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: phone-numbers-available-numbers
    baseUri: https://dashboard.bandwidth.com/api
    description: Bandwidth Phone Numbers API — Available Numbers business capability. Self-contained, no shared references.
    resources:
    - name: accounts-accountId-availableNumbers
      path: /accounts/{accountId}/availableNumbers
      operations:
      - name: searchavailablenumbers
        method: GET
        description: Search available phone numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: areaCode
          in: query
          type: string
          description: Three-digit area code to search
        - name: npaNxx
          in: query
          type: string
          description: Six-digit NPA-NXX combination to search
        - name: rateCenter
          in: query
          type: string
          description: Rate center name to search
        - name: city
          in: query
          type: string
          description: City name to search
        - name: state
          in: query
          type: string
          description: Two-letter state abbreviation
        - name: zip
          in: query
          type: string
          description: Five-digit ZIP code to search
        - name: lata
          in: query
          type: string
          description: LATA code to search
        - name: quantity
          in: query
          type: integer
          description: Number of results to return (1-5000, default 5000)
        - name: tollFreeWildCardPattern
          in: query
          type: string
          description: Toll-free number pattern using wildcards (e.g., 8**) for toll-free number searches
        - name: enableTNDetail
          in: query
          type: boolean
          description: Include detailed information for each number
        - name: localVanity
          in: query
          type: string
          description: Vanity number search pattern
    authentication:
      type: basic
      username: '{{env.BANDWIDTH_USER}}'
      password: '{{env.BANDWIDTH_PASS}}'
  exposes:
  - type: rest
    namespace: phone-numbers-available-numbers-rest
    port: 8080
    description: REST adapter for Bandwidth Phone Numbers API — Available Numbers. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/accounts/{accountid}/availablenumbers
      name: accounts-accountid-availablenumbers
      description: REST surface for accounts-accountId-availableNumbers.
      operations:
      - method: GET
        name: searchavailablenumbers
        description: Search available phone numbers
        call: phone-numbers-available-numbers.searchavailablenumbers
        with:
          areaCode: rest.areaCode
          npaNxx: rest.npaNxx
          rateCenter: rest.rateCenter
          city: rest.city
          state: rest.state
          zip: rest.zip
          lata: rest.lata
          quantity: rest.quantity
          tollFreeWildCardPattern: rest.tollFreeWildCardPattern
          enableTNDetail: rest.enableTNDetail
          localVanity: rest.localVanity
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: phone-numbers-available-numbers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Bandwidth Phone Numbers API — Available Numbers. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: search-available-phone-numbers
      description: Search available phone numbers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: phone-numbers-available-numbers.searchavailablenumbers
      with:
        areaCode: tools.areaCode
        npaNxx: tools.npaNxx
        rateCenter: tools.rateCenter
        city: tools.city
        state: tools.state
        zip: tools.zip
        lata: tools.lata
        quantity: tools.quantity
        tollFreeWildCardPattern: tools.tollFreeWildCardPattern
        enableTNDetail: tools.enableTNDetail
        localVanity: tools.localVanity
      outputParameters:
      - type: object
        mapping: $.