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

The Customer Frontdesk API from Nfon — 6 operation(s) for customer frontdesk.

Nfon Customer Frontdesk 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 Frontdesk. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

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

  • bearer_auth — JSON Web Token

Paths & Operations 14

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

Customer Frontdesk 14
PUT
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/target/{targetServiceNumber}
updateTargetByTargetId 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/target/{targetServiceNumber}
deleteTarget 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/target/{targetServiceNumber}
getTargetByTargetId 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/inbound-trunk-numbers
get_99 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/inbound-trunk-numbers
post_28 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/target
getAllTargets 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/target
createFrontdeskTarget 2 params body → 403400201
PUT
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}
put_31 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}
delete_26 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}
get_98 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/frontdesk-services
get_97 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/frontdesk-services
post_27 1 param body → 403400201
DELETE
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}
delete_27 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/frontdesk-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}
get_100 3 params → 200403404

Schemas 19

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

Integer
object
Subscribers soft limit
6 properties
String
object
Link to the last page
6 properties
FrontdeskTargetData
object
1 property
FrontdeskServiceLinks
object
2 properties
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
FrontdeskServiceData
object
13 properties
FrontdeskTargetDto
object
4 properties
NfonApiCollectionResponse
object
Collection response envelope
InboundTrunkNumberRequest
object
4 properties
FrontdeskServiceRequest
object
4 properties
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
InboundTrunkNumberData
object
1 property
Boolean
object
6 properties
CollectionLinks
object
Pagination links for collection responses
4 properties
Date
object
6 properties
FrontdeskTargetLinks
object
1 property
Links
object
Related resource links
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties
InboundTrunkNumberLinks
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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