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 queue-profiles API

The queue-profiles API from Nfon — 5 operation(s) for queue-profiles.

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

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

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

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

  • bearer_auth — JSON Web Token

Paths & Operations 7

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

queue-profiles 7
GET
/tenants/{tenant}/extensions/{extension}/queue-profiles
Get tenant queue profiles
getTenantQueueProfiles 2 params → 404400200503402500
PUT
/tenants/{tenant}/extensions/{extension}/queue-profiles/{queueProfileId}/activate
Activate queue profile
activateExtensionQueueProfile 3 params → 404400503204402500
PUT
/tenants/{tenant}/extensions/{extension}/queue/logout
Logout from all queues
logoutFromAllQueues 2 params → 404400503204402500
GET
/tenants/{tenant}/queue-profiles
Get queue profiles
getExtensionQueueProfiles 1 param → 404500200503400
POST
/tenants/{tenant}/queue-profiles
Create queue profile
createTenantQueueProfile 1 param body → 404400201503500402409
DELETE
/tenants/{tenant}/queue-profiles/{queueProfileId}
Delete queue profile
deleteTenantQueueProfile 2 params → 404400503204402500
PATCH
/tenants/{tenant}/queue-profiles/{queueProfileId}
Update queue profile
updateTenantQueueProfile 2 params body → 404400200503402500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are QueueProfile (5 properties), GetQueueProfilesExtensionResponse (5 properties), Error (4 properties), QueueProfilePatchRequest (4 properties). Each schema is shown below with its type and property counts.

Error
object
Error represents the standard API error response.
4 properties
ErrorDetail
object
ErrorDetail represents error details in the delete response.
2 properties
Visibility
object
Visibility represents a single visibility entry with name and extension.
2 properties 2 required
QueueProfilePatchRequest
object
QueueProfilePatchRequest represents a partial update request. All fields are optional, but at least one must be provided.
4 properties
QueueProfile
object
QueueProfileResponse represents the response when creating/updating a queue profile. This is named QueueProfile in the OpenAPI spec.
5 properties
QueueProfileRequest
object
QueueProfilesRequest represents the request body for creating a queue profile. Name and Color are required. Visibilities and QueueServiceNumbers are optional.
4 properties 2 required
QueueProfileList
array
QueueProfileList is a list of queue profiles.
GetQueueProfilesExtensionResponse
object
GetQueueProfilesExtensionResponse represents extension queue profiles response.
5 properties
Status
string
Status represents an active/inactive status.
Visibilities
array
Visibilities is a list of visibility entries.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-queue-profiles-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