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 SIP Servers API

Manage SIP server infrastructure

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

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

This API exposes 5 operations across 2 paths, and defines 14 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.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 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 SIP Servers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 5

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

SIP Servers 5

Manage SIP server infrastructure

GET
/sip-servers
List SIP servers
get_220 → 200
POST
/sip-servers
Create SIP server
post_56 body → 400201
PUT
/sip-servers/{sipServerId}
Update SIP server
put_58 1 param body → 404204400
DELETE
/sip-servers/{sipServerId}
Delete SIP server
delete_58 1 param → 404204400
GET
/sip-servers/{sipServerId}
Get SIP server
get_221 1 param → 200404403401

Schemas 14

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

CollectionLinks
object
Pagination links for collection responses
4 properties
String
object
Link to the last page
6 properties
SipServerPUTRequest
object
4 properties
SipServerPOSTLinks
object
1 property
SipServerPUTLinks
object
1 property
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
SipServerPOSTData
object
SIP server creation data
8 properties
SipServerPOSTRequest
object
4 properties
NfonApiCollectionResponse
object
Collection response envelope
Links
object
Related resource links
SipServerPUTData
object
SIP server update data (all fields optional)
8 properties
Integer
object
Subscribers soft limit
6 properties
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-sip-servers-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