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 Customer Sites API

The Customer Sites API from Nfon — 3 operation(s) for customer sites.

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

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

This API exposes 4 operations across 3 paths, and defines 9 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.

4 operations 3 paths 9 schemas 3 GET1 PUT

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 Customer Sites API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 3 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customer Sites 4
GET
/tenants/{participantExternalIdentifier}/sites
get_158 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/sites/{siteId}
get_159 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/sites/{siteId}/site-options
get_160 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/sites/{siteId}/site-options
put_48 2 params body → 404204400403

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SiteOptionsPUTData (25 properties), String (6 properties), Integer (6 properties), Boolean (6 properties). Each schema is shown below with its type and property counts.

Boolean
object
6 properties
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
SiteOptionsPUTLinks
object
3 properties
SiteOptionsPUTData
object
25 properties
Enum
object
6 properties
Integer
object
Subscribers soft limit
6 properties
Links
object
Related resource links
String
object
Link to the last page
6 properties
SiteOptionsPUTRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-customer-sites-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