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

The Customer IVR API from Nfon — 11 operation(s) for customer ivr.

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

This API exposes 21 operations across 11 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 2026.07.20.

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

21 operations 11 paths 22 schemas 4 DELETE11 GET3 POST3 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 IVR API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (jwt).

Paths & Operations 21

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

Customer IVR 21
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/available-general-announcements
Get 112
get_112 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services
Get 113
get_113 1 param → 200403
POST
/tenants/{participantExternalIdentifier}/targets/ivr-services
Post 35
post_35 1 param body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/available-destinations-on-timeout
Get 177
get_177 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/target-available-destinations
Get 120
get_120 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}
Put 35
put_35 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}
Delete 34
delete_34 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}
Get 114
get_114 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers
Get 115
get_115 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers
Post 36
post_36 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments
Get 117
get_117 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments
Post 37
post_37 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments/target-available-destinations
Get 119
get_119 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments/{keyAssignmentNumber}
Put 36
put_36 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments/{keyAssignmentNumber}
Delete 36
delete_36 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments/{keyAssignmentNumber}
Get 118
get_118 3 params → 200403404
DELETE
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}
Delete 35
delete_35 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}
Get 116
get_116 3 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/timeout
Put 51
put_51 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/timeout
Delete 51
delete_51 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/timeout
Get 181
get_181 2 params → 200403404

Schemas 22

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

InboundTrunkNumberData
object
1 property
IVRServiceKeyAssignmentLinks
object
1 property
Integer
object
Subscribers soft limit
6 properties
Data
object
Data represents key-value pair for additional reference metadata.
2 properties 2 required
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
Links
object
Related resource links
IVRServiceRequest
object
4 properties
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties
IVRServiceKeyAssignmentData
object
1 property
TimeoutLinks
object
Date
object
6 properties
InboundTrunkNumberRequest
object
4 properties
IVRServiceData
object
10 properties
InboundTrunkNumberLinks
object
1 property
IVRServiceLinks
object
4 properties
Boolean
object
6 properties
String
object
Link to the last page
6 properties
CollectionLinks
object
Pagination links for collection responses
4 properties
TimeoutRequest
object
4 properties
NfonApiCollectionResponse
object
Collection response envelope
IVRServiceKeyAssignmentRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-customer-ivr-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
Where this information came from

This is an independent, third-party profile of Nfon Customer IVR 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.