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

The Customer Groups API from Nfon — 8 operation(s) for customer groups.

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

This API exposes 17 operations across 8 paths, and defines 20 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.

17 operations 8 paths 20 schemas 4 DELETE8 GET3 POST2 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 Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 17

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

Customer Groups 17
GET
/tenants/{participantExternalIdentifier}/targets/group-services/available-destinations-on-timeout
get_176 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/members
get_105 2 params → 200403404
POST
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/members
post_31 2 params body → 403400201
GET
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/inbound-trunk-numbers
list 2 params → 200403404
POST
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/inbound-trunk-numbers
post_30 2 params body → 403400201
PUT
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}
put_32 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}
delete_28 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}
get_102 2 params → 200403404
PUT
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/timeout
put_50 2 params body → 404204400403
DELETE
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/timeout
delete_50 2 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/timeout
get_180 2 params → 200403404
DELETE
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/members/{extensionNumber}
delete_30 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/members/{extensionNumber}
get_104 3 params → 200403404
DELETE
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}
delete_29 3 params → 404204403
GET
/tenants/{participantExternalIdentifier}/targets/group-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}
get_103 3 params → 200403404
GET
/tenants/{participantExternalIdentifier}/targets/group-services
get_101 1 param → 200403
POST
/tenants/{participantExternalIdentifier}/targets/group-services
post_29 1 param body → 403400201

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are String (6 properties), NfonApiCollectionResponsePage (6 properties), TimeoutRequest (4 properties), CollectionLinks (4 properties). Each schema is shown below with its type and property counts.

NoLinks
object
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
NewGroupRequest
object
4 properties
TimeoutLinks
object
NewGroupMemberRequest
object
4 properties
NfonApiCollectionResponse
object
Collection response envelope
NoData
object
InboundTrunkNumberRequest
object
4 properties
NewGroupMemberLinks
object
1 property
PUTLinks
object
2 properties
UpdateGroupRequest
object
4 properties
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
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-groups-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