Nfon

Nfon Customer Phone Books API

The Customer Phone Books API from Nfon — 5 operation(s) for customer phone books.

GitHub OpenAPI

Operations 12

PUT /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId} #
DELETE /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId} #
GET /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId} #
POST /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities #
DELETE /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities #
GET /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities #
GET /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities/available-phone-extensions #
DELETE /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities/{extensionNumber} #
GET /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities/{extensionNumber} #
POST /tenants/{participantExternalIdentifier}/phone-books #
DELETE /tenants/{participantExternalIdentifier}/phone-books #
GET /tenants/{participantExternalIdentifier}/phone-books #

Documentation

📖
Documentation
https://api.nfon.net/configuration/
📖
APIReference
https://api.nfon.net/configuration/
📖
Documentation
https://nfon-ag.github.io/CTI-API/
📖
APIReference
https://nfon-ag.github.io/CTI-API/
📖
Documentation
https://nfon-ag.github.io/Call-History-API/
📖
APIReference
https://nfon-ag.github.io/Call-History-API/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nfon/refs/heads/main/openapi/nfon-customer-phone-books-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nfon-customer-phone-books-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nfon-customer-phone-books-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: APIs for managing PBX configuration, tenants, operators, licenses, and related resources
  title: PBX Configuration Customer Phone Books API
  version: 2026.07.20
servers:
- url: /configuration/v1
tags:
- name: Customer Phone Books
paths:
  /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}:
    put:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/PhoneBookPUTRequest'
      parameters:
      - schema:
          format: int64
          type: integer
        required: true
        in: path
        name: phoneBookId
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Phone Books
      operationId: put_40
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '404':
          description: Not found
        '204':
          description: Updated
        '400':
          description: Validation error
        '403':
          description: Insufficient permissions
    delete:
      parameters:
      - schema:
          format: int64
          type: integer
        required: true
        in: path
        name: phoneBookId
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Phone Books
      operationId: delete_39
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '404':
          description: Not found
        '204':
          description: Deleted
        '403':
          description: Insufficient permissions
    get:
      parameters:
      - schema:
          format: int64
          type: integer
        required: true
        in: path
        name: phoneBookId
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Phone Books
      operationId: get_129
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                $ref: '#/components/schemas/NfonApiResponse'
              example:
                links:
                - href: /api/customers/K1234/phonebook/1/visibilities
                  rel: phoneBookVisibilities
                - href: /api/customers/K1234/available-vpn-providers
                  rel: availableVpnProviders
                data:
                - value: John Smith
                  name: displayName
                - value: +49 89 123456
                  name: displayNumber
                - value: '200'
                  name: vpnNumber
                - value: NFON
                  name: vpnProvider
                href: /api/customers/example-id/phone-books/example-id
          description: Success
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
  /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities:
    post:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/PhoneBookVisibilityPOSTRequest'
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      - schema:
          type: string
        required: true
        in: path
        name: phoneBookId
      tags:
      - Customer Phone Books
      operationId: post_41
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '403':
          description: Insufficient permissions
        '400':
          description: Validation error
        '201':
          description: Created
    delete:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      - schema:
          type: string
        required: true
        in: path
        name: phoneBookId
      tags:
      - Customer Phone Books
      operationId: delete_40
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '404':
          description: Not found
        '204':
          description: Deleted
        '403':
          description: Insufficient permissions
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      - schema:
          type: string
        required: true
        in: path
        name: phoneBookId
      tags:
      - Customer Phone Books
      operationId: get_131
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                $ref: '#/components/schemas/NfonApiCollectionResponse'
          description: Success
        '403':
          description: Insufficient permissions
  /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities/available-phone-extensions:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      - schema:
          type: string
        required: true
        in: path
        name: phoneBookId
      tags:
      - Customer Phone Books
      operationId: get_130
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                $ref: '#/components/schemas/NfonApiCollectionResponse'
          description: Success
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
  /tenants/{participantExternalIdentifier}/phone-books/{phoneBookId}/visibilities/{extensionNumber}:
    delete:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: extensionNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      - schema:
          type: string
        required: true
        in: path
        name: phoneBookId
      tags:
      - Customer Phone Books
      operationId: delete_41
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '404':
          description: Not found
        '204':
          description: Deleted
        '403':
          description: Insufficient permissions
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: extensionNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      - schema:
          type: string
        required: true
        in: path
        name: phoneBookId
      tags:
      - Customer Phone Books
      operationId: get_132
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                $ref: '#/components/schemas/NfonApiResponse'
              example:
                links:
                - href: /api/customers/K1234/phone-extensions/100
                  rel: phoneExtension
                data:
                - value: '100'
                  name: extensionNumber
                - value: John Smith
                  name: displayName
                href: /api/customers/example-id/phone-books/example-id/visibilities/example-id
          description: Success
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
  /tenants/{participantExternalIdentifier}/phone-books:
    post:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/PhoneBookPOSTRequest'
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Phone Books
      operationId: post_40
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '403':
          description: Insufficient permissions
        '400':
          description: Validation error
        '201':
          description: Created
    delete:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Phone Books
      operationId: delete_38
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '404':
          description: Not found
        '204':
          description: Deleted
        '403':
          description: Insufficient permissions
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Phone Books
      operationId: get_128
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                $ref: '#/components/schemas/NfonApiCollectionResponse'
              example:
                links: {}
                data:
                - value: John Smith
                  name: displayName
                - value: +49 89 123456
                  name: displayNumber
                - value: '200'
                  name: vpnNumber
                - value: NFON
                  name: vpnProvider
                href: /api/customers/example-id/phone-books
          description: Success
        '403':
          description: Insufficient permissions
components:
  schemas:
    NoData:
      type: object
    NfonApiCollectionResponse:
      oneOf:
      - $ref: '#/components/schemas/NfonApiCollectionResponsePage'
      - $ref: '#/components/schemas/NfonApiCollectionResponseNonPage'
      type: object
      description: Collection response envelope
    NfonApiCollectionResponsePage:
      properties:
        links:
          $ref: '#/components/schemas/CollectionLinks'
        offset:
          example: 0
          description: Current page offset
          format: int64
          type: integer
        total:
          example: 42
          description: Total number of items in the collection
          format: int64
          type: integer
        items:
          type: array
          items:
            $ref: '#/components/schemas/NfonApiResponse'
          description: Items in this page
        size:
          example: 20
          description: Number of items in this page
          format: int32
          type: integer
        href:
          description: Self-link to this collection
          type: string
      type: object
      description: Paginated collection response envelope
    Links:
      description: Related resource links
      type: object
    NoLinks:
      type: object
    PhoneBookVisibilityPOSTRequest:
      properties:
        links:
          $ref: '#/components/schemas/PhoneBookVisibilityPOSTLinks'
        data:
          $ref: '#/components/schemas/NoData'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
    PhoneBookPOSTData:
      properties:
        vpnNumber:
          $ref: '#/components/schemas/String'
        vpnProvider:
          $ref: '#/components/schemas/String'
        displayName:
          example: John Smith
          type: string
        displayNumber:
          example: +49 89 123456
          type: string
      type: object
    String:
      properties:
        notNull:
          type: boolean
        notPresent:
          type: boolean
        present:
          type: boolean
        presentNotNull:
          type: boolean
        presentNull:
          type: boolean
        value:
          type: string
      type: object
      description: Link to the last page
    NfonApiResponse:
      properties:
        links:
          $ref: '#/components/schemas/Links'
        data:
          description: Resource data (name/value pairs or structured object)
          type: object
        href:
          example: /api/sip-servers/100
          type: string
          description: Self-link to this resource
      type: object
      description: Standard API response envelope for a single resource
    PhoneBookPUTData:
      properties:
        vpnNumber:
          $ref: '#/components/schemas/String'
        vpnProvider:
          $ref: '#/components/schemas/String'
        displayName:
          $ref: '#/components/schemas/String'
        displayNumber:
          $ref: '#/components/schemas/String'
      type: object
    PhoneBookVisibilityPOSTLinks:
      properties:
        phoneExtension:
          example: /api/customers/K1234/phone-extensions/100
          type: string
      type: object
    PhoneBookPOSTRequest:
      properties:
        links:
          $ref: '#/components/schemas/NoLinks'
        data:
          $ref: '#/components/schemas/PhoneBookPOSTData'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
    NfonApiCollectionResponseNonPage:
      properties:
        links:
          $ref: '#/components/schemas/Links'
        href:
          description: Self-link to this collection
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/NfonApiResponse'
          description: All items in the collection
      type: object
      description: Non-paginated collection response envelope
    CollectionLinks:
      properties:
        first:
          $ref: '#/components/schemas/String'
        prev:
          $ref: '#/components/schemas/String'
        next:
          $ref: '#/components/schemas/String'
        last:
          $ref: '#/components/schemas/String'
      type: object
      description: Pagination links for collection responses
    PhoneBookPUTRequest:
      properties:
        links:
          $ref: '#/components/schemas/NoLinks'
        data:
          $ref: '#/components/schemas/PhoneBookPUTData'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
  securitySchemes:
    jwt:
      scheme: bearer
      bearerFormat: JWT
      type: http