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

Operator management

Nfon Operators API is one of 52 APIs that Nfon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Operators. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

11 operations 8 paths 24 schemas 8 GET2 POST1 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 Operators API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 11

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

Operators 11

Operator management

GET
/operators/{operatorId}
Get operator
get_206 1 param → 200404
PUT
/operators/{operatorId}
Update operator
put_57 1 param body → 404204400
GET
/operators/{operatorId}/rating-profiles
get_213 1 param → 200403
POST
/operators/{operatorId}/rating-profiles
post_55 1 param body → 403400201
GET
/operators/{operatorId}/rating-profiles/available
get_212 1 param → 200403404
GET
/operators/{operatorId}/tenants
get_209 1 param → 200403
GET
/operators/{operatorId}/system-integrators
get_217 1 param → 200403
GET
/operators/{operatorId}/blacklist-profiles
get_207 1 param → 200403
GET
/operators
List operators
get_205 → 200
POST
/operators
Create operator
createOperator body → 500409503201400
GET
/operators/{operatorId}/pbx-groups
get_210 1 param → 200403

Schemas 24

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

NoLinks
object
OperatorPUTRequest
object
4 properties
CreateOperatorRating
object
CreateOperatorRating represents rating configuration for operator.
2 properties 2 required
PrimaryContact
PrimaryContactParams represents primary contact with address. This is named PrimaryContact in the OpenAPI spec.
Integer
object
Subscribers soft limit
6 properties
CreateOperatorRequest
object
CreateOperatorRequest represents the request body for creating an operator.
14 properties 7 required
Contact
object
Contact is the struct that holds the contact in a request.
5 properties 2 required
String
object
Link to the last page
6 properties
OperatorCreated
object
CreateOperatorResponse represents the response structure for creating an operator. This is named OperatorCreated in the OpenAPI spec.
2 properties
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
RatingProfilePOSTRequest
object
4 properties
NfonApiCollectionResponse
object
Collection response envelope
OperatorPUTData
object
24 properties
ErrorDetail
object
ErrorDetail represents error details in the delete response.
2 properties
PrimaryContactOperator
PrimaryContactOperator represents primary contact for operator.
RatingProfilePOSTData
object
1 property
OperatorPUTLinks
object
5 properties
Address
object
Address is the struct that holds the address in a request. nolint:recvcheck // mixed receivers for zerolog/validation compatibility
4 properties 4 required
Error
object
Error represents the standard API error response.
4 properties
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
CollectionLinks
object
Pagination links for collection responses
4 properties
Boolean
object
6 properties
Links
object
Related resource links
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-operators-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