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

The Customer Targets API from Nfon — 29 operation(s) for customer targets.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 44 operations across 29 paths, and defines 24 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.

44 operations 29 paths 24 schemas 7 DELETE28 GET7 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
NFON
License
NFON proprietary
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

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

  • bearer_auth — JSON Web Token

Paths & Operations 44

Across 29 paths, the API surfaces 44 operations — 7 DELETE, 28 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Customer Targets 44
GET
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/inbound-trunk-numbers
get_95 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/inbound-trunk-numbers
post_26 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix
get_88 1 param → 200403
POST
/tenants/{participantExternalIdentifier}/targets/routing-prefix
post_23 1 param body → 403400201
PUT
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}
put_27 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}
delete_22 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}
get_89 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/devices
get_61 2 params → 200403404
POST
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/devices
post_14 2 params body → 403400201
DELETE
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/devices/{uniqueIdentifier}
delete_14 3 params → 404204403
DELETE
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/inbound-trunk-numbers/{didNumber}
delete_23 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/inbound-trunk-numbers/{didNumber}
get_91 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/outbound-trunk-numbers
getOutboundTrunkNumbersWithPage_1 2 params → 200403404
POST
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/outbound-trunk-numbers
postOutboundTrunkNumbers_1 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/outbound-trunk-numbers/available-trunks
getAvailableTrunks_1 2 params → 200403404
DELETE
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/outbound-trunk-numbers/{outboundTrunkNumberId}
deleteOutboundTrunkNumber_1 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/outbound-trunk-numbers/{outboundTrunkNumberId}
getOutboundTrunkNumbers_1 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets
get_174 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/targets/BUSY
get_166 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/HANGUP
get_169 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/INTERNAL_SOURCE
get_170 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/OWN_VOICEMAIL
get_172 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/REPEAT
get_173 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/VOICEMAILSERVICE
get_175 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions
get_93 1 param → 200403
POST
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions
post_25 1 param body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/NO_ACTION
get_171 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}
put_29 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}
delete_24 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}
get_94 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/direct-dial/{directDialNumber}
get_167 3 params → 200403404
DELETE
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/inbound-trunk-numbers/{didNumber}
delete_25 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/inbound-trunk-numbers/{didNumber}
get_96 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix/available-devices
get_59 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/outbound-trunk-numbers
getOutboundTrunkNumbersWithPage_2 2 params → 200403404
POST
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/outbound-trunk-numbers
postOutboundTrunkNumbers_2 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/outbound-trunk-numbers/available-trunks
getAvailableTrunks_2 2 params → 200403404
DELETE
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/outbound-trunk-numbers/{outboundTrunkNumberId}
deleteOutboundTrunkNumber_2 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/virtual-fax-extensions/{extensionNumber}/outbound-trunk-numbers/{outboundTrunkNumberId}
getOutboundTrunkNumbers_2 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/external/{externalNumber}
get_168 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/inbound-trunk-numbers
get_90 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/routing-prefix/{extensionNumber}/inbound-trunk-numbers
post_24 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/ANY_SOURCE
get_165 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/ANONYMOUS_SOURCE
get_164 1 param → 200403404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are VirtualFaxExtensionData (11 properties), POSTData (7 properties), String (6 properties), Short (6 properties). Each schema is shown below with its type and property counts.

OutboundTrunkNumberData
object
VirtualFaxExtensionData
object
11 properties
PUTRequest
object
4 properties
String
object
Link to the last page
6 properties
POSTData
object
7 properties
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
VirtualFaxExtensionLinks
object
5 properties
NfonApiCollectionResponse
object
Collection response envelope
VirtualFaxExtensionRequest
object
4 properties
InboundTrunkNumberRequest
object
4 properties
PUTLinks
object
2 properties
OutboundTrunkNumberLinks
object
Short
object
6 properties
RoutingPrefixExtensionLinks
object
2 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
OutboundTrunkNumberRequest
object
4 properties
PUTData
object
3 properties
POSTRequest
object
4 properties
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-targets-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
#Customer Targets
← Back to N APIs
API Details
ID
nfon:nfon-customer-targets-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