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 import-export 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:
- x-displayName: Import Export
description: Bulk import and export operations
name: import-export
paths:
/tenants/{tenant}/virtual-fax-extensions/bulk:
get:
summary: Bulk Export Virtual Fax Extensions
parameters:
- schema:
type: string
required: true
in: path
description: ''
name: tenant
- schema:
type: boolean
required: false
in: query
description: ''
name: sanitize
tags:
- import-export
description: Export all virtual fax extensions for a tenant as CSV or Excel file (synchronous)
operationId: bulkExportVirtualFaxExtensions
security:
- OAuth2:
- tenant.admin
- tenant.operator
- tenant.system-integrator
- tenant.manager
responses:
'404':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The requested resource was not found
code: not_found
summary: Not found
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Tenant not found
'400':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid request parameters
code: validation_error
summary: Validation error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Invalid request
'401':
content:
application/json:
examples:
missingToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: JWT missing from the Authorization header.
code: authorization
summary: Missing token
invalidToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid JWT in the Authorization header.
code: authorization
summary: Invalid token
expiredToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: There was an issue validating your authorization token.
code: authorization
summary: Expired token
accessingAnotherTenant:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: user is not allowed to perform actions in this access scope
code: authorization
summary: Accessing another Tenant
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Unauthorized
'200':
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Export file
'503':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The service is temporarily unavailable. Please try again later.
code: upstream_unavailable
summary: Service unavailable
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Service temporarily unavailable
'403':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: User does not have permission to perform this operation
code: forbidden
summary: Forbidden
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Forbidden
'500':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Internal server error
code: internal_error
summary: Internal server error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Internal server error
post:
tags:
- import-export
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkImportRequest'
required: true
parameters:
- schema:
type: string
required: true
in: path
description: ''
name: tenant
summary: Bulk Import Virtual Fax Extensions
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitJobResponse'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Import job submitted
'400':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid request parameters
code: validation_error
summary: Validation error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Bad Request - validation or format errors
'401':
content:
application/json:
examples:
missingToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: JWT missing from the Authorization header.
code: authorization
summary: Missing token
invalidToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid JWT in the Authorization header.
code: authorization
summary: Invalid token
expiredToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: There was an issue validating your authorization token.
code: authorization
summary: Expired token
accessingAnotherTenant:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: user is not allowed to perform actions in this access scope
code: authorization
summary: Accessing another Tenant
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Unauthorized
'503':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The service is temporarily unavailable. Please try again later.
code: upstream_unavailable
summary: Service unavailable
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Service temporarily unavailable
'500':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Internal server error
code: internal_error
summary: Internal server error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Internal server error
'403':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: User does not have permission to perform this operation
code: forbidden
summary: Forbidden
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Forbidden
'413':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: File too large
operationId: bulkImportVirtualFaxExtensions
security:
- OAuth2:
- tenant.admin
- tenant.operator
- tenant.system-integrator
- tenant.manager
description: Submit a bulk import job for virtual fax extensions (asynchronous). The delete flag is not supported and will return an error if set to true.
/tenants/{tenant}/phone-books/bulk:
get:
summary: Bulk Export Phone Books
parameters:
- schema:
type: string
required: true
in: path
description: ''
name: tenant
- schema:
type: boolean
required: false
in: query
description: ''
name: sanitize
tags:
- import-export
description: Export all phone book entries for a tenant as CSV or Excel file (synchronous)
operationId: bulkExportPhoneBooks
security:
- jwt: {}
responses:
'404':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The requested resource was not found
code: not_found
summary: Not found
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Tenant not found
'400':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid request parameters
code: validation_error
summary: Validation error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Invalid request
'401':
content:
application/json:
examples:
missingToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: JWT missing from the Authorization header.
code: authorization
summary: Missing token
invalidToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid JWT in the Authorization header.
code: authorization
summary: Invalid token
expiredToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: There was an issue validating your authorization token.
code: authorization
summary: Expired token
accessingAnotherTenant:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: user is not allowed to perform actions in this access scope
code: authorization
summary: Accessing another Tenant
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Unauthorized
'200':
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Export file
'503':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The service is temporarily unavailable. Please try again later.
code: upstream_unavailable
summary: Service unavailable
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Service temporarily unavailable
'403':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: User does not have permission to perform this operation
code: forbidden
summary: Forbidden
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Forbidden
'500':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Internal server error
code: internal_error
summary: Internal server error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Internal server error
post:
tags:
- import-export
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkImportRequest'
required: true
parameters:
- schema:
type: string
required: true
in: path
description: ''
name: tenant
summary: Bulk Import Phone Books
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitJobResponse'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Import job submitted
'400':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid request parameters
code: validation_error
summary: Validation error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Bad Request - validation or format errors
'401':
content:
application/json:
examples:
missingToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: JWT missing from the Authorization header.
code: authorization
summary: Missing token
invalidToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid JWT in the Authorization header.
code: authorization
summary: Invalid token
expiredToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: There was an issue validating your authorization token.
code: authorization
summary: Expired token
accessingAnotherTenant:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: user is not allowed to perform actions in this access scope
code: authorization
summary: Accessing another Tenant
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Unauthorized
'503':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The service is temporarily unavailable. Please try again later.
code: upstream_unavailable
summary: Service unavailable
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Service temporarily unavailable
'500':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Internal server error
code: internal_error
summary: Internal server error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Internal server error
'403':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: User does not have permission to perform this operation
code: forbidden
summary: Forbidden
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Forbidden
'413':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: File too large
operationId: bulkImportPhoneBooks
security:
- jwt: {}
description: Submit a bulk import job for phone book entries (asynchronous)
/tenants/{tenant}/jobs:
get:
summary: List jobs
parameters:
- schema:
type: string
required: true
in: path
description: ''
name: tenant
- schema:
type: string
required: false
in: query
description: ''
name: type
- schema:
type: string
required: false
in: query
description: ''
name: status
- schema:
type: integer
required: false
in: query
description: ''
name: limit
tags:
- import-export
description: List all async jobs for a tenant with optional type and status filtering
operationId: listJobs
security:
- OAuth2:
- tenant.admin
- tenant.operator
- tenant.system-integrator
- tenant.manager
responses:
'404':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The requested resource was not found
code: not_found
summary: Not found
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Tenant not found
'400':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid request parameters
code: validation_error
summary: Validation error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Invalid request
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JobStatusResponseList'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: List of jobs
'204':
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: No jobs found
'503':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The service is temporarily unavailable. Please try again later.
code: upstream_unavailable
summary: Service unavailable
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Service temporarily unavailable
'500':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Internal server error
code: internal_error
summary: Internal server error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Internal server error
/tenants/{tenant}/phone-extensions/bulk:
get:
summary: Bulk Export Phone Extensions
parameters:
- schema:
type: string
required: true
in: path
description: ''
name: tenant
- schema:
type: boolean
required: false
in: query
description: ''
name: sanitize
- schema:
type: string
required: false
in: query
description: ''
name: filter
tags:
- import-export
description: Export all phone extensions for a tenant as CSV or Excel file (synchronous)
operationId: bulkExportPhoneExtensions
security:
- OAuth2:
- tenant.admin
- tenant.operator
- tenant.system-integrator
- tenant.manager
responses:
'404':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The requested resource was not found
code: not_found
summary: Not found
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Tenant not found
'400':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid request parameters
code: validation_error
summary: Validation error
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Invalid request
'401':
content:
application/json:
examples:
missingToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: JWT missing from the Authorization header.
code: authorization
summary: Missing token
invalidToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: Invalid JWT in the Authorization header.
code: authorization
summary: Invalid token
expiredToken:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: There was an issue validating your authorization token.
code: authorization
summary: Expired token
accessingAnotherTenant:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: user is not allowed to perform actions in this access scope
code: authorization
summary: Accessing another Tenant
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Unauthorized
'200':
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Export file
'503':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: The service is temporarily unavailable. Please try again later.
code: upstream_unavailable
summary: Service unavailable
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Service temporarily unavailable
'403':
content:
application/json:
examples:
example:
value:
request_id: 550e8400-e29b-41d4-a716-446655440000
message: User does not have permission to perform this operation
code: forbidden
summary: Forbidden
schema:
$ref: '#/components/schemas/Error'
headers:
X-Request-Id:
schema:
format: uuid
type: string
description: Unique request identifier
description: Forbidden
'500'
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nfon/refs/heads/main/openapi/nfon-import-export-api-openapi.yml