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

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

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

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.1.0
API Version
2.0-early-access
Base URL
https://api.nfon.net/configuration/v1
Authentication
HTTP Bearer
Contact
License
NFON proprietary
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearer_auth — JSON Web Token

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 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services
get_113 1 param → 200403
POST
/tenants/{participantExternalIdentifier}/targets/ivr-services
post_35 1 param body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/available-destinations-on-timeout
get_177 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/target-available-destinations
get_120 1 param → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}
put_35 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}
delete_34 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}
get_114 2 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers
get_115 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers
post_36 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments
get_117 2 params → 200403
POST
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments
post_37 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments/target-available-destinations
get_119 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments/{keyAssignmentNumber}
put_36 3 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments/{keyAssignmentNumber}
delete_36 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/key-assignments/{keyAssignmentNumber}
get_118 3 params → 200403404
DELETE
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}
delete_35 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}
get_116 3 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/timeout
put_51 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/timeout
delete_51 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/ivr-services/{serviceNumber}/timeout
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), Date (6 properties), Integer (6 properties), NfonApiCollectionResponsePage (6 properties). Each schema is shown below with its type and property counts.

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