How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nfon Customer Devices API

The Customer Devices API from Nfon — 20 operation(s) for customer devices.

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

This API exposes 35 operations across 20 paths, and defines 74 schemas. It is described by OpenAPI 3.2.0, at version 2026.07.20.

Requests are made against a single base URL, /configuration/v1.

35 operations 20 paths 74 schemas 8 DELETE12 GET5 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026.07.20
Base URL
https://api.nfon.net/configuration/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 35

Across 20 paths, the API surfaces 35 operations — 8 DELETE, 12 GET, 5 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Customer Devices 35
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys
Get 40
get_40 3 params → 200403
POST
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys
Post 11
post_11 3 params body → 403400201
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}
Put 16
put_16 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}
Delete 12
delete_12 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}
Get 47
get_47 3 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}/site-options
Put 13
put_13 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}/site-options
Delete 8
delete_8 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}/site-options
Get 44
get_44 3 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{uniqueIdentifier}/activate
Post 6
post_6 3 params body → 404204400403
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{uniqueIdentifier}/activation-credentials-renewal
Put 7
put_7 3 params body → 404204400403
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{uniqueIdentifier}/activation-pin-renewal
Put 8
put_8 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/devices/{uniqueIdentifier}
Delete device by unique identifier
delete_4 2 params → 404204400
POST
/tenants/{participantExternalIdentifier}/devices/{uniqueIdentifier}/bypass-authentication
Post 7
post_7 2 params body → 403400201
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys/{licenseId}
Put 12
put_12 4 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys/{licenseId}
Delete 7
delete_7 4 params → 404204403
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys/{licenseId}
Get 41
get_41 4 params → 200403404
POST
/tenants/{participantExternalIdentifier}/devices/{uniqueIdentifier}/reset-authentication
Post 8
post_8 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/available-phones
Get 42
get_42 2 params → 200403
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets/{handsetId}
Put 11
put_11 4 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets/{handsetId}
Delete 6
delete_6 4 params → 404204403
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets/{handsetId}
Get 39
get_39 4 params → 200403404
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets
Get 38
get_38 3 params → 200403
POST
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets
Post 10
post_10 3 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/devices
Get 35
get_35 1 param → 200403
DELETE
/tenants/{participantExternalIdentifier}/devices/lync/{uniqueIdentifier}
Delete 9
delete_9 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/devices/lync/{uniqueIdentifier}
Get 43
get_43 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/devices/softphone/{uniqueIdentifier}
Put 15
put_15 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/devices/softphone/{uniqueIdentifier}
Delete 11
delete_11 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/devices/softphone/{uniqueIdentifier}
Get 46
get_46 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}
Put 9
put_9 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}
Delete 5
delete_5 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}
Get 36
get_36 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/free-ports
Get 37
get_37 3 params → 200403404
POST
/tenants/{participantExternalIdentifier}/devices/{deviceType}
Post 12
post_12 2 params body → 403400201
PUT
/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets/{handsetId}/activate
Put 10
put_10 4 params body → 404204400403

Schemas 74

The contract defines 74 schemas that model the data the API accepts and returns. The most detailed are SiteOptionsPUTData (25 properties), BaseDevicePOSTData (15 properties), HandsetDeviceItem (14 properties), BaseDevicePUTData (12 properties). Each schema is shown below with its type and property counts.

XCAPIDevicePUTRequest
object
4 properties
XCAPIDevicePUTData
object
6 properties
BaseLicenseUpdateRequest
object
4 properties
DeviceActivationRequest
object
4 properties
BaseLicenseUpdateData
object
2 properties
StandardDevicePUTRequestData
object
7 properties
Enum
object
6 properties
ExternalLineDevicePUTRequest
object
4 properties
BaseLicenseCreateRequest
object
4 properties
BaseDevicePOSTRequest
object
4 properties
UnprovisionedSipDevicePOSTRequestLinks
object
2 properties
ExternalLineDevicePUTData
object
7 properties
SoftphoneDevicePOSTRequestLinks
object
2 properties
Integer
object
Subscribers soft limit
6 properties
UnprovisionedSipDevicePUTRequest
object
4 properties
StandardDevicePOSTRequestLinks
object
3 properties
MediaGatewayPOSTRequest
object
4 properties
UpdateOperatorPanelRequest
object
4 properties
UnprovisionedSipDevicePUTData
object
4 properties
HandsetDeviceUpdateRequest
object
4 properties
ExternalLineDevicePUTLinks
object
1 property
BaseDevicePOSTLinks
object
3 properties
BaseDevicePUTRequest
object
4 properties
Data
object
Data represents key-value pair for additional reference metadata.
2 properties 2 required
DeviceBypassAuthenticationData
object
XCAPIDevicePOSTRequestData
object
7 properties
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
DeviceResetAuthenticationData
object
StandardDevicePUTRequest
object
4 properties
XCAPIDevicePUTLinks
object
1 property
MediaGatewayPOSTData
object
3 properties
DeviceActivationData
object
1 property
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
StandardDevicePOSTRequest
object
4 properties
Links
object
Related resource links
StandardDevicePUTRequestLinks
object
2 properties
BaseDevicePUTLinks
object
2 properties
DeviceActivationCredentialsRenewalRequest
object
4 properties
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties
ExternalLineDevicePOSTRequestData
object
8 properties
XCAPIDevicePOSTRequestLinks
object
2 properties
XCAPIDevicePOSTRequest
object
4 properties
UnprovisionedSipDevicePOSTRequest
object
4 properties
StandardDevicePOSTRequestData
object
8 properties
OperatorPanelDeviceRequest
object
4 properties
BaseLicenseCreateData
object
2 properties
BaseDevicePUTData
object
12 properties
HandsetDeviceItem
object
14 properties
BaseDevicePOSTData
object
15 properties
DeviceActivationPinRenewalData
object
ExternalLineDevicePOSTRequestLinks
object
2 properties
NoLinks
object
ExternalLineDevicePOSTRequest
object
4 properties
Boolean
object
6 properties
SoftphoneDevicePUTRequest
object
4 properties
SoftphoneDevicePUTRequestLinks
object
1 property
SoftphoneDevicePUTRequestData
object
3 properties
DeviceBypassAuthenticationRequest
object
4 properties
String
object
Link to the last page
6 properties
DeviceResetAuthenticationRequest
object
4 properties
DeviceSiteOptionsPUTRequest
object
4 properties
SiteOptionsPUTData
object
25 properties
CollectionLinks
object
Pagination links for collection responses
4 properties
UnprovisionedSipDevicePOSTRequestData
object
5 properties
DeviceActivationPinRenewalRequest
object
4 properties
UnprovisionedSipDevicePUTLinks
object
2 properties
DeviceActivationCredentialsRenewalData
object
SoftphoneDevicePOSTRequest
object
4 properties
SoftphoneDevicePOSTRequestData
object
3 properties
HandsetDeviceRequest
object
4 properties
MediaGatewayPOSTLinks
object
3 properties
DeviceLinks
object
NfonApiCollectionResponse
object
Collection response envelope
DeviceSiteOptionsPUTLinks
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-customer-devices-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 DIDs API
Where this information came from

This is an independent, third-party profile of Nfon Customer Devices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.