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 Devices API

The Devices API from Nfon — 5 operation(s) for devices.

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

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

This API exposes 6 operations across 5 paths, and defines 20 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.

6 operations 5 paths 20 schemas 3 GET3 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 Devices API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 6

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

Devices 6
GET
/devices
List devices
get_200 → 200
POST
/devices/validate-deviceid
Validate device IDs
post_53 body → 200400
GET
/tenants/{tenant}/devices/bulk
Bulk Export Devices
bulkExportDevices 2 params → 404400401200503403500
POST
/tenants/{tenant}/devices/bulk
Submit Device Bulk Import
submitDeviceBulkImport 1 param body → 202400401503500403413
POST
/tenants/{tenant}/devices/bulk/validate
Validate Device Bulk Import
validateDeviceBulkImport 1 param body → 400401200503403500
GET
/tenants/{tenant}/jobs/{eventId}
Get Import Job Status
getJobStatus 2 params → 404400401200503403500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are NfonApiCollectionResponsePage (6 properties), String (6 properties), JobStatusResponse (6 properties), DeviceImportItem (5 properties). Each schema is shown below with its type and property counts.

DeviceImportItem
object
DeviceImportRequest represents a single device for import (API type).
5 properties
NoLinks
object
DeviceValidationResponse
object
DeviceValidationResponse represents the validation response.
1 property
String
object
Link to the last page
6 properties
JobStatusResponse
object
JobReport represents the status of an import job. This is named JobStatusResponse in the OpenAPI spec.
6 properties
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
JobDetails
object
JobDetails contains details about a job.
2 properties
DeviceIdPOSTRequest
object
4 properties
NfonApiCollectionResponse
object
Collection response envelope
ErrorDetail
object
ErrorDetail represents error details in the delete response.
2 properties
Error
object
Error represents the standard API error response.
4 properties
DeviceTypeInfo
object
DeviceTypeInfo contains device type metadata.
4 properties
JobError
object
JobError represents an error that occurred during processing.
3 properties
DeviceBulkImportRequest
object
DeviceBulkImportRequest represents the request body for device bulk import.
1 property
DeviceIdPOSTData
object
1 property
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
CollectionLinks
object
Pagination links for collection responses
4 properties
DeviceValidationItem
object
DeviceValidationItem represents a device in validation response.
4 properties
Links
object
Related resource links
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-devices-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