Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nfon import-export API

Bulk import and export operations

Nfon import-export API is one of 52 APIs that Nfon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include import-export. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2.0-early-access.

Requests are made against a single base URL, https://api.nfon.com/call-history.

9 operations 5 paths 5 schemas 5 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0-early-access
Base URL
https://api.nfon.net/configuration/v1
Authentication
HTTP Bearer
Contact
License
NFON proprietary
Terms of Service
Resource Areas
1

Authentication & Security 1

Nfon import-export API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

import-export 9

Bulk import and export operations

GET
/tenants/{tenant}/virtual-fax-extensions/bulk
Bulk Export Virtual Fax Extensions
bulkExportVirtualFaxExtensions 2 params → 404400401200503403500
POST
/tenants/{tenant}/virtual-fax-extensions/bulk
Bulk Import Virtual Fax Extensions
bulkImportVirtualFaxExtensions 1 param body → 202400401503500403413
GET
/tenants/{tenant}/phone-books/bulk
Bulk Export Phone Books
bulkExportPhoneBooks 2 params → 404400401200503403500
POST
/tenants/{tenant}/phone-books/bulk
Bulk Import Phone Books
bulkImportPhoneBooks 1 param body → 202400401503500403413
GET
/tenants/{tenant}/jobs
List jobs
listJobs 4 params → 404400200204503500
GET
/tenants/{tenant}/phone-extensions/bulk
Bulk Export Phone Extensions
bulkExportPhoneExtensions 3 params → 404400401200503403500
POST
/tenants/{tenant}/phone-extensions/bulk
Bulk Import Phone Extensions
bulkImportPhoneExtensions 1 param body → 202400401503500403413
GET
/tenants/{tenant}/speed-dials/bulk
Bulk Export Speed Dials
bulkExportSpeedDials 2 params → 404400401200503403500
POST
/tenants/{tenant}/speed-dials/bulk
Bulk Import Speed Dials
bulkImportSpeedDials 1 param body → 202400401503500403413

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), ErrorDetail (2 properties), SubmitJobResponse (2 properties), BulkImportRequest (2 properties). Each schema is shown below with its type and property counts.

Error
object
Error represents the standard API error response.
4 properties
BulkImportRequest
object
BulkImportRequest represents the multipart form data for bulk import operations.
2 properties
ImportMetadata
object
ImportMetadata represents the optional JSON metadata in a bulk import request.
1 property
SubmitJobResponse
object
ImportResponse represents the response after submitting an import job. This is named SubmitJobResponse in the OpenAPI spec.
2 properties
ErrorDetail
object
ErrorDetail represents error details in the delete response.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-import-export-api-openapi.yml Raw ↑

Other APIs Nfon publishes across the network.

NFON Service Portal API (legacy)
Nfon Accounts API
Nfon address API
Nfon authentication API
Nfon Blacklist Profiles API
Nfon clip-screened-prefixes API
Nfon Contract Types API
Nfon Customer Announcements API
Nfon Customer Conference API
Nfon Customer Contracts API
Nfon Customer Device Types API
Nfon Customer Devices API