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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Nfon

Nfon Customers API

Customer management

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 52 operations across 39 paths, and defines 41 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.

52 operations 39 paths 41 schemas 3 DELETE38 GET3 POST8 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
NFON
License
NFON proprietary
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

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

  • bearer_auth — JSON Web Token

Paths & Operations 52

Across 39 paths, the API surfaces 52 operations — 3 DELETE, 38 GET, 3 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 52

Customer management

GET
/tenants/{participantExternalIdentifier}/codec-profiles
get_26 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/default-system-integrator
get_11 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/default-system-integrator
put_1 1 param body → 404204400403
GET
/tenants/{participantExternalIdentifier}
Get customer
get_13 1 param → 200404
PUT
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}
Update an integration tenant
put_33 2 params body → 404204400409
DELETE
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}
delete_31 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}
get_107 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}/targets
get_108 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}/targets
post_33 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/license-status
get_16 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/monitoring-levels
get_125 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/nmeeting-options
get_126 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/operator-details
get_14 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/operator-details
put_2 1 param body → 404204400403
GET
/tenants/{participantExternalIdentifier}/options
get_127 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/options
put_39 1 param body → 404204400403
GET
/tenants/{participantExternalIdentifier}/directcall-numbers
get_55 1 param → 200403
POST
/tenants/{participantExternalIdentifier}/directcall-numbers
post_9 1 param body → 403400201
DELETE
/tenants/{participantExternalIdentifier}/directcall-numbers/{number}
delete_10 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/directcall-numbers/{number}
get_56 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/emergency-sites
get_12 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/evn-modes
get_57 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/feature-status
get_15 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/forward-destinations/direct-dial/{directDialNumber}
getDirectDialDetails 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/options/external-numbers
put_30 1 param body → 404204400403
GET
/tenants/{participantExternalIdentifier}/ownVoicemail
get_17 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/available-record-start-message-recipients
get_154 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/available-recording-audio-types
get_155 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/basic-data
get_20 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/basic-data
put_3 1 param body → 404204400403
GET
/tenants/{participantExternalIdentifier}/blacklist-global-profiles
get_8 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/blacklist-global-profiles/{profileName}
get_9 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/blacklist-profiles
get_21 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/call-recording
get_23 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/call-recording
put_4 1 param body → 404204400403
GET
/tenants/{participantExternalIdentifier}/snom-transfer
get_161 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/category
get_24 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/click-to-dial-states
get_25 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/count-of-trunks
get_33 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/cti-billing-modes
get_34 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/contract-information
get_6 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/subscriptions
get_18 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/uacsta-protocols
get_192 1 param → 200403
GET
/tenants
List customers
get_10 → 200
GET
/tenants/{participantExternalIdentifier}/integrations
get_106 1 param → 200403
POST
/tenants/{participantExternalIdentifier}/integrations
Create an integration tenant
post_32 1 param body → 409400201
PUT
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}/targets/{targetId}
put_34 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}/targets/{targetId}
delete_32 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}/targets/{targetId}
get_109 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/port-speeds
get_133 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/blacklist-profiles/{blacklistProfileId}
get_22 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/available-pbx-groups
get_7 1 param → 200403404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are CustomerOptionsPUTData (34 properties), CustomerBasicDataPUT (13 properties), CustomerOptionsLinks (9 properties), IntegrationTenantPOSTData (6 properties). Each schema is shown below with its type and property counts.

NoLinks
object
CustomerDefaultSystemIntegratorPUTLinks
object
1 property
Integer
object
Subscribers soft limit
6 properties
IntegrationTenantPUTRequest
object
4 properties
IntegrationTenantPOSTRequest
object
4 properties
String
object
Link to the last page
6 properties
CustomerBasicDataRequest
object
4 properties
IntegrationTenantPUTLinks
object
1 property
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
CustomerOptionsRequest
object
4 properties
IntegrationTargetPOSTData
object
3 properties
DirectcallData
object
1 property
NfonApiCollectionResponse
object
Collection response envelope
NoData
object
IntegrationTenantPOSTData
object
6 properties
CustomerOptionsLinks
object
9 properties
ExternalNumbersHrefData
object
1 property
IntegrationTargetPUTData
object
3 properties
IntegrationTargetPOSTRequest
object
4 properties
IntegrationTargetPOSTLinks
object
1 property
Enum
object
6 properties
CustomerOperatorDetailsPUTLinks
object
1 property
CustomerCallRecordingPUTLinks
object
1 property
CustomerDirectcallRequest
object
4 properties
ExternalNumbersRequest
object
4 properties
CustomerCallRecordingPUTData
object
3 properties
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
IntegrationTenantPUTData
object
6 properties
CustomerOptionsPUTData
object
34 properties
CustomerBasicDataPUT
object
13 properties
Boolean
object
6 properties
CollectionLinks
object
Pagination links for collection responses
4 properties
JsonNode
object
IntegrationTargetPUTLinks
object
IntegrationTargetPUTRequest
object
4 properties
IntegrationTenantPOSTLinks
object
1 property
CustomerDefaultSystemIntegratorPUTRequest
object
4 properties
Links
object
Related resource links
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties
CustomerOperatorDetailPUTRequest
object
4 properties
CustomerCallRecordingRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-customers-api-openapi.yml Raw ↑

Other APIs Nfon publishes across the network.

NFON Service Portal API (legacy)
AE Profile APIs.io
Nfon Accounts API
AE Profile APIs.io
Nfon address API
AE Profile APIs.io
Nfon authentication API
AE Profile APIs.io
Nfon Blacklist Profiles API
AE Profile APIs.io
Nfon clip-screened-prefixes API
AE Profile APIs.io
Nfon Contract Types API
AE Profile APIs.io
Nfon Customer Announcements API
AE Profile APIs.io
Nfon Customer Conference API
AE Profile APIs.io
Nfon Customer Contracts API
AE Profile APIs.io
Nfon Customer Device Types API
AE Profile APIs.io
Nfon Customer Devices API
AE Profile APIs.io
#Customers
← Back to N APIs
API Details
ID
nfon:nfon-customers-api
Base URL
https://api.nfon.net/configuration/v1
Docs
https://www.nfon.com/en/integrations/api
Provider
Nfon
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network