openapi: 3.1.0
info:
description: 'The NFON Call History API provides endpoints for retrieving, streaming, and deleting call history records for an authenticated NFON Cloud Telephony user.
This API is currently offered as part of **Login with NFON (Early Access)**. As an early access offering, the API is subject to change. Updates may occur on short notice, though we strive to provide advance notice where possible.
For more information, see: https://www.nfon.com/en/integrations/login-with-nfon/'
title: NFON Call History Accounts Customers API
version: 2.0-early-access
termsOfService: https://www.nfon.com/en/legal/gtc
contact:
name: NFON
email: integration@nfon.com
license:
name: NFON proprietary
servers:
- url: https://api.nfon.com/call-history
tags:
- name: Customers
description: Customer management
paths:
/tenants/{participantExternalIdentifier}/codec-profiles:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_26
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/default-system-integrator:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_11
security:
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
example:
links:
- href: /api/system-integrators/SI001
rel: defaultSystemIntegrator
data:
- value: SI001 - Default System Integrator
name: defaultSystemIntegrator
href: /api/customers/example-id/default-system-integrator
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
put:
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/CustomerDefaultSystemIntegratorPUTRequest'
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: put_1
security:
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'404':
description: Not found
'204':
description: Updated
'400':
description: Validation error
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}:
get:
summary: Get customer
parameters:
- schema:
type: string
example: K0611
required: true
description: Customer external identifier
in: path
name: participantExternalIdentifier
tags:
- Customers
description: Returns customer details including options, links to operator, SIP server, and PBX group
operationId: get_13
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
description: Customer details
'404':
description: Customer not found
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}:
put:
tags:
- Customers
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/IntegrationTenantPUTRequest'
parameters:
- schema:
format: int64
type: integer
required: true
in: path
name: customerIntegrationId
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
summary: Update an integration tenant
responses:
'404':
description: Integration tenant not found
'204':
description: Integration tenant updated successfully
'400':
description: Validation error
'409':
description: Duplicate STANDARD integration tenant for same customer and provider
operationId: put_33
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
description: 'Updates an existing integration tenant. The status field can be changed. Allowed values: VALID, INVALID, PENDING. Uniqueness constraint: STANDARD integrations are limited to one per customer per provider. CUSTOM and MCP integrations have no uniqueness restriction.'
delete:
parameters:
- schema:
format: int64
type: integer
required: true
in: path
name: customerIntegrationId
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: delete_31
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'404':
description: Not found
'204':
description: Deleted
'403':
description: Insufficient permissions
get:
parameters:
- schema:
format: int64
type: integer
required: true
in: path
name: customerIntegrationId
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_107
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
/tenants/{participantExternalIdentifier}/integrations/{customerIntegrationId}/targets:
get:
parameters:
- schema:
format: int64
type: integer
required: true
in: path
name: customerIntegrationId
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_108
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
post:
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/IntegrationTargetPOSTRequest'
parameters:
- schema:
format: int64
type: integer
required: true
in: path
name: customerIntegrationId
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: post_33
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'403':
description: Insufficient permissions
'400':
description: Validation error
'201':
description: Created
/tenants/{participantExternalIdentifier}/license-status:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_16
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/monitoring-levels:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_125
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/nmeeting-options:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_126
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/operator-details:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_14
security:
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
example:
links:
- href: /api/operators/O1234/pbx-groups/pbx-group-01
rel: pbxGroup
data:
- value: O1234
name: operator
- value: NFON AG
name: operatorName
- value: SI5678
name: systemIntegrator
- value: Partner GmbH
name: systemIntegratorName
- value: pbx-group-01
name: pbxGroupName
- value: sip-server-01
name: sipServerName
href: /api/customers/example-id/operator-details
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
put:
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/CustomerOperatorDetailPUTRequest'
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: put_2
security:
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'404':
description: Not found
'204':
description: Updated
'400':
description: Validation error
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/options:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_127
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
example:
links:
- href: /api/operators/O1234/rating-profiles/default
rel: ratingProfile
- href: /api/operators/O1234/rating-profiles/available
rel: availableRatingProfiles
- href: /api/customers/K0611/count-of-trunks
rel: availableCountOfTrunks
- href: /api/customers/K0611/evn-modes
rel: availableEvnModes
- href: /api/customers/K0611/contract-types
rel: availableContractTypes
- href: /api/customers/K0611/cti-billing-modes
rel: availableCtiBillingModes
- href: /api/customers/K0611/click-to-dial-states
rel: availableClickToDialStates
- href: /api/customers/K0611/nmeeting-options
rel: availableNmeetingOptions
- href: /api/timezones/Europe%2FBerlin
rel: timezone
data:
- value: TRUNKS_2
name: countOfTrunks
- value: 3
name: speedDialLength
- value: '***'
name: deviceCreationPassword
- value: FULL
name: evnMode
- value: 4
name: projectNumberLength
- value: STANDARD
name: contractType
- value: 'OFF'
name: ctiBillingMode
- value: ENABLED
name: clickToDialState
- value: 'OFF'
name: nmeeting
- value: 4
name: vmPasswordLengthMin
- value: 8
name: vmPasswordLengthMax
- value: 4
name: operatorVmPasswordLengthMin
- value: 8
name: operatorVmPasswordLengthMax
- value: UDP
name: sipTransport
- value: false
name: lockDeviceWebserver
- value: false
name: portLock
- value: true
name: intercomEnabled
- value: 'false'
name: betaTester
- value: 'false'
name: betaDeviceTester
- value: 'false'
name: aastra31NewLayout
- value: 'false'
name: sipCustomPort
- value: true
name: ccbs
- value: false
name: mediaGatewayEmergencyDialplanEnabled
- value: false
name: nmqEnabled
- value: false
name: vlanProvisioning
- value: 'false'
name: acureusBilling
- value: 'false'
name: blockedOutbound
- value: 'false'
name: trialPeriod
- value: 'false'
name: trialPermanent
- value: 'false'
name: newBss
- value: '2024-01-15'
name: blockedAt
- value: default
name: ratingProfileName
- value: 'false'
name: dialWithoutPrefix
- value: '0'
name: dialPrefix
- value: false
name: disableT38
- value: 'true'
name: previewFeatureEnabled
- value: 'false'
name: coachingEnabled
- value: de
name: language
- value: 'true'
name: voicemailTranscriptionEnabled
- value: 'true'
name: presenceTeamsConnectorEnabled
- value: EMAIL
name: voicemailNotificationMode
- value: 'false'
name: callTranscriptionConsentRequired
- value: 'false'
name: aiEssentialsEnabled
- value: true
name: operatorTPSAvailable
- value: false
name: operatorLdapVisible
- value: false
name: operatorNmqEnabled
href: /api/customers/example-id/options
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
put:
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/CustomerOptionsRequest'
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: put_39
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'404':
description: Not found
'204':
description: Updated
'400':
description: Validation error
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/directcall-numbers:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_55
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
post:
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/CustomerDirectcallRequest'
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: post_9
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'403':
description: Insufficient permissions
'400':
description: Validation error
'201':
description: Created
/tenants/{participantExternalIdentifier}/directcall-numbers/{number}:
delete:
parameters:
- schema:
type: string
required: true
in: path
name: number
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: delete_10
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'404':
description: Not found
'204':
description: Deleted
'403':
description: Insufficient permissions
get:
parameters:
- schema:
type: string
required: true
in: path
name: number
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_56
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
/tenants/{participantExternalIdentifier}/emergency-sites:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_12
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/evn-modes:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_57
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
example:
links: {}
data:
- value: ENABLED
name: evnMode
href: /api/customers/example-id/evn-modes
description: Success
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/feature-status:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_15
security:
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/forward-destinations/direct-dial/{directDialNumber}:
get:
parameters:
- schema:
type: string
required: true
in: path
name: directDialNumber
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: getDirectDialDetails
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json: {}
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
/tenants/{participantExternalIdentifier}/options/external-numbers:
put:
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/ExternalNumbersRequest'
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: put_30
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'404':
description: Not found
'204':
description: Updated
'400':
description: Validation error
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/ownVoicemail:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_17
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
/tenants/{participantExternalIdentifier}/available-record-start-message-recipients:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_154
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
/tenants/{participantExternalIdentifier}/available-recording-audio-types:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_155
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
/tenants/{participantExternalIdentifier}/basic-data:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_20
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
put:
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/CustomerBasicDataRequest'
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: put_3
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'404':
description: Not found
'204':
description: Updated
'400':
description: Validation error
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/blacklist-global-profiles:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_8
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
description: Success
'403':
description: Insufficient permissions
/tenants/{participantExternalIdentifier}/blacklist-global-profiles/{profileName}:
get:
parameters:
- schema:
type: string
required: true
in: path
name: profileName
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_9
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiResponse'
description: Success
'403':
description: Insufficient permissions
'404':
description: Not found
/tenants/{participantExternalIdentifier}/blacklist-profiles:
get:
parameters:
- schema:
type: string
required: true
in: path
name: participantExternalIdentifier
tags:
- Customers
operationId: get_21
security:
- oauth2:
- tenant.manager
- oauth2:
- tenant.system-integrator
- oauth2:
- tenant.operator
- oauth2:
- tenant.admin
responses:
'200':
content:
application/vnd.collection.next+json:
schema:
$ref: '#/components/schemas/NfonApiCollectionResponse'
example:
links: {}
data:
- value: Default Blacklist
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nfon/refs/heads/main/openapi/nfon-customers-api-openapi.yml