Nfon Customer Devices API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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.1.0, at version 2.0-early-access.

Requests are made against a single base URL, https://api.nfon.com/call-history.

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.1.0

API Version

2.0-early-access

Base URL

https://api.nfon.net/configuration/v1

Authentication

HTTP Bearer

Contact

NFON

License

NFON proprietary

View terms

Resource Areas

Authentication & Security 1

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

bearer_auth — JSON Web Token

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 3 params → 200403

POST

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys

post_11 3 params body → 403400201

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}

put_16 3 params body → 404204400403

DELETE

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}

delete_12 3 params → 404204403

GET

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}

get_47 3 params → 200403404

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}/site-options

put_13 3 params body → 404204400403

DELETE

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}/site-options

delete_8 3 params → 404204403

GET

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{deviceId}/site-options

get_44 3 params → 200403404

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{uniqueIdentifier}/activate

post_6 3 params body → 404204400403

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{uniqueIdentifier}/activation-credentials-renewal

put_7 3 params body → 404204400403

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{uniqueIdentifier}/activation-pin-renewal

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 2 params body → 403400201

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys/{licenseId}

put_12 4 params body → 404204400403

DELETE

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys/{licenseId}

delete_7 4 params → 404204403

GET

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/license-keys/{licenseId}

get_41 4 params → 200403404

POST

/tenants/{participantExternalIdentifier}/devices/{uniqueIdentifier}/reset-authentication

post_8 2 params body → 403400201

GET

/tenants/{participantExternalIdentifier}/devices/{deviceType}/available-phones

get_42 2 params → 200403

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets/{handsetId}

put_11 4 params body → 404204400403

DELETE

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets/{handsetId}

delete_6 4 params → 404204403

GET

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets/{handsetId}

get_39 4 params → 200403404

GET

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets

get_38 3 params → 200403

POST

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets

post_10 3 params body → 403400201

GET

/tenants/{participantExternalIdentifier}/devices

get_35 1 param → 200403

DELETE

/tenants/{participantExternalIdentifier}/devices/lync/{uniqueIdentifier}

delete_9 2 params → 404204403

GET

/tenants/{participantExternalIdentifier}/devices/lync/{uniqueIdentifier}

get_43 2 params → 200403404

PUT

/tenants/{participantExternalIdentifier}/devices/softphone/{uniqueIdentifier}

put_15 2 params body → 404204400403

DELETE

/tenants/{participantExternalIdentifier}/devices/softphone/{uniqueIdentifier}

delete_11 2 params → 404204403

GET

/tenants/{participantExternalIdentifier}/devices/softphone/{uniqueIdentifier}

get_46 2 params → 200403404

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}

put_9 3 params body → 404204400403

DELETE

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}

delete_5 3 params → 404204403

GET

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}

get_36 3 params → 200403404

GET

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/free-ports

get_37 3 params → 200403404

POST

/tenants/{participantExternalIdentifier}/devices/{deviceType}

post_12 2 params body → 403400201

PUT

/tenants/{participantExternalIdentifier}/devices/{deviceType}/{baseId}/handsets/{handsetId}/activate

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.

BaseDevicePOSTData

object

15 properties

HandsetDeviceUpdateRequest

object

4 properties

UpdateOperatorPanelRequest

object

4 properties

NoLinks

object

XCAPIDevicePUTData

object

6 properties

StandardDevicePOSTRequest

object

4 properties

BaseLicenseUpdateRequest

object

4 properties

DeviceBypassAuthenticationRequest

object

4 properties

SoftphoneDevicePUTRequest

object

4 properties

StandardDevicePOSTRequestLinks

object

3 properties

Integer

object

Subscribers soft limit

6 properties

ExternalLineDevicePUTLinks

object

1 property

BaseDevicePUTLinks

object

2 properties

SoftphoneDevicePOSTRequest

object

4 properties

SoftphoneDevicePOSTRequestData

object

3 properties

String

object

Link to the last page

6 properties

MediaGatewayPOSTData

object

3 properties

DeviceResetAuthenticationRequest

object

4 properties

ExternalLineDevicePOSTRequest

object

4 properties

DeviceActivationCredentialsRenewalData

object

UnprovisionedSipDevicePOSTRequest

object

4 properties

ExternalLineDevicePUTRequest

object

4 properties

NfonApiResponse

object

Standard API response envelope for a single resource

3 properties

BaseLicenseCreateData

object

2 properties

XCAPIDevicePOSTRequestData

object

7 properties

BaseDevicePOSTLinks

object

3 properties

UnprovisionedSipDevicePOSTRequestData

object

5 properties

SiteOptionsPUTData

object

25 properties

DeviceActivationPinRenewalRequest

object

4 properties

UnprovisionedSipDevicePOSTRequestLinks

object

2 properties

OperatorPanelDeviceRequest

object

4 properties

DeviceBypassAuthenticationData

object

BaseDevicePOSTRequest

object

4 properties

NfonApiCollectionResponse

object

Collection response envelope

SoftphoneDevicePUTRequestData

object

3 properties

DeviceResetAuthenticationData

object

UnprovisionedSipDevicePUTRequest

object

4 properties

HandsetDeviceItem

object

14 properties

DeviceActivationCredentialsRenewalRequest

object

4 properties

StandardDevicePUTRequest

object

4 properties

ExternalLineDevicePUTData

object

7 properties

MediaGatewayPOSTRequest

object

4 properties

SoftphoneDevicePUTRequestLinks

object

1 property

DeviceLinks

object

Enum

object

6 properties

ExternalLineDevicePOSTRequestLinks

object

2 properties

StandardDevicePOSTRequestData

object

8 properties

DeviceActivationPinRenewalData

object

ExternalLineDevicePOSTRequestData

object

8 properties

UnprovisionedSipDevicePUTLinks

object

2 properties

SoftphoneDevicePOSTRequestLinks

object

2 properties

NfonApiCollectionResponsePage

object

Paginated collection response envelope

6 properties

StandardDevicePUTRequestLinks

object

2 properties

XCAPIDevicePOSTRequestLinks

object

2 properties

Data

object

Data represents key-value pair for additional reference metadata.

2 properties 2 required

Boolean

object

6 properties

CollectionLinks

object

Pagination links for collection responses

4 properties

XCAPIDevicePUTLinks

object

1 property

BaseLicenseUpdateData

object

2 properties

BaseLicenseCreateRequest

object

4 properties

DeviceSiteOptionsPUTRequest

object

4 properties

StandardDevicePUTRequestData

object

7 properties

MediaGatewayPOSTLinks

object

3 properties

UnprovisionedSipDevicePUTData

object

4 properties

XCAPIDevicePOSTRequest

object

4 properties

DeviceActivationData

object

1 property

HandsetDeviceRequest

object

4 properties

DeviceActivationRequest

object

4 properties

XCAPIDevicePUTRequest

object

4 properties

Links

object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

AE Profile APIs.io

#Customer Devices

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Nfon Customer Devices API

Metadata

Authentication & Security 1

Paths & Operations 35

Schemas 74

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Nfon Customer Devices API

Metadata

Authentication & Security 1

Paths & Operations 35

Schemas 74

Specification

Source

More from Nfon 12

API Details

Provider

Explore more