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

The Customer Extensions API from Nfon — 38 operation(s) for customer extensions.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 67 operations across 38 paths, and defines 61 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.

67 operations 38 paths 61 schemas 9 DELETE37 GET10 POST11 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 Extensions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 67

Across 38 paths, the API surfaces 67 operations — 9 DELETE, 37 GET, 10 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.

Customer Extensions 67
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions
get_66 1 param → 200403
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions
post_15 1 param body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/available-internal-outgoings
get_64 2 params → 200403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/call-forwards
get_78 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/call-forwards
put_24 2 params body → 404204400403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-globals
get_70 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-globals
put_18 2 params body → 404204400403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-globals/{type}
get_71 3 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-globals/{type}
put_19 3 params body → 404204400403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-globals/{type}/available
getAvailable_1 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules
get_74 3 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules
post_18 3 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId}/{type}/available
getAvailable_2 5 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/devices
get_60 2 params → 200403404
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/devices
post_13 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/function-keys/available-targets
get_80 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/function-keys/{keyNumber}
put_25 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/function-keys/{keyNumber}
delete_19 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/function-keys/{keyNumber}
get_82 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/inbound-trunk-numbers
get_68 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/inbound-trunk-numbers
post_16 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/function-keys/available-targets
get_79 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}
put_17 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}
delete_15 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}
get_67 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/outbound-trunk-numbers/available-trunks
getAvailableTrunks 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId}
put_21 4 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId}
delete_18 4 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId}
get_75 4 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/voice-mail
get_87 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/voice-mail
put_26 2 params body → 404204400403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/voice-mail/announcements
get_86 2 params → 200403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{specification}/available
get_65 2 params → 200403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/call-forwards/{type}/available
getAvailable 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles
get_72 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles
Create a callforward profile
post_17 2 params body → 400201
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/available-cti-info
get_62 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/available-devices
get_58 1 param → 200403404
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/inbound-trunk-numbers/{didNumber}
delete_16 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/inbound-trunk-numbers/{didNumber}
get_69 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/lync
get_83 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/lync
post_20 2 params body → 403400201
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/lync/{lyncOptionId}
delete_20 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/lync/{lyncOptionId}
get_84 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/outbound-trunk-numbers
getOutboundTrunkNumbersWithPage 2 params → 200403404
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/outbound-trunk-numbers
postOutboundTrunkNumbers 2 params body → 403400201
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/outbound-trunk-numbers/{outboundTrunkNumberId}
deleteOutboundTrunkNumber 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/outbound-trunk-numbers/{outboundTrunkNumberId}
getOutboundTrunkNumbers 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/skills
get_85 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/skills
post_21 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/skills/login-status
get_92 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/skills/login-status
put_28 2 params body → 404204400403
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/voice-mail/announcements/{announcementType}
post_22 3 params body → 403400201
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/voice-mail/announcements/{announcementType}
delete_21 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/voice-mail/announcements/{announcementType}
getContent_1 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/available-internal-outgoings
get_5 1 param → 200403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/available-cti-info/{ctiInfoName}
get_63 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/function-keys
get_81 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/function-keys
post_19 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/call-forwards/{type}
get_77 3 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/call-forwards/{type}
put_23 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/devices/{uniqueIdentifier}
delete_13 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId}/{type}
get_76 5 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId}/{type}
put_22 5 params body → 404204400403
PUT
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}
Update a callforward profile
put_20 3 params body → 404204400
DELETE
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}
Delete a callforward profile
delete_17 3 params → 404204400
GET
/tenants/{participantExternalIdentifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}
get_73 3 params → 200403404

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are PhoneExtensionPUTData (26 properties), PhoneExtensionPOSTData (26 properties), VoicemailData (15 properties), PhoneExtensionPUTLinks (8 properties). Each schema is shown below with its type and property counts.

CallForwardGlobalsReferenceLinks
object
2 properties
LoginStatusData
object
NoLinks
object
OutboundTrunkNumberData
object
PhoneExtensionCallForwardsPUTData
object
3 properties
CallForwardProfilesPOSTRequest
object
4 properties
FunctionKeyPUTLinks
object
1 property
Integer
object
Subscribers soft limit
6 properties
FunctionKeyPUTRequest
object
4 properties
CFRulesPOSTLinks
object
5 properties
CallForwardProfilesPOSTData
object
3 properties
CallForwardGlobalsReferenceData
object
3 properties
String
object
Link to the last page
6 properties
PhoneExtensionPOSTData
object
26 properties
CallForwardGlobalsPUTData
object
2 properties
PhoneExtensionDevicesPOSTLinks
object
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
VoicemailData
object
15 properties
PhoneExtensionLinks
object
8 properties
FunctionKeyPOSTData
object
4 properties
NfonApiCollectionResponse
object
Collection response envelope
PhoneExtensionCallForwardData
object
3 properties
CallForwardProfilePUTRequest
object
4 properties
NoData
object
PhoneExtensionPUTData
object
26 properties
PhoneExtensionSkillCollectionData
object
4 properties
FunctionKeyPOSTRequest
object
4 properties
FunctionKeyPOSTLinks
object
1 property
InboundTrunkNumberRequest
object
4 properties
CallForwardRulePUTData
object
5 properties
OutboundTrunkNumberLinks
object
PhoneExtensionPOSTRequest
object
4 properties
CallForwardGlobalsPUTRequest
object
4 properties
PhoneExtensionPUTLinks
object
8 properties
Enum
object
6 properties
PhoneExtensionSkillCollectionRequest
object
4 properties
PhoneExtensionCallForwardsPUTRequest
object
4 properties
CallForwardRulesPOSTRequest
object
4 properties
LyncOptionLinks
object
3 properties
CallForwardProfilePUTData
object
3 properties
CFRulesPOSTData
object
5 properties
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
FunctionKeyPUTData
object
3 properties
InboundTrunkNumberData
object
1 property
Boolean
object
6 properties
CollectionLinks
object
Pagination links for collection responses
4 properties
PhoneExtensionPUTRequest
object
4 properties
LoginStatusRequest
object
4 properties
PhoneExtensionDevicesPOSTRequest
object
4 properties
PhoneExtensionSkillCollectionLinks
object
1 property
LyncOptionRequest
object
4 properties
Date
object
6 properties
CallForwardGlobalsReferenceRequest
object
4 properties
OutboundTrunkNumberRequest
object
4 properties
CallForwardRequest
object
4 properties
CallForwardRulePUTRequest
object
4 properties
Links
object
Related resource links
VoicemailRequest
object
4 properties
PhoneExtensionCallForwardLinks
object
2 properties
InboundTrunkNumberLinks
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-customer-extensions-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 Extensions
← Back to N APIs
API Details
ID
nfon:nfon-customer-extensions-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