Nfon

Nfon Customer Queues API

The Customer Queues API from Nfon — 12 operation(s) for customer queues.

GitHub OpenAPI

Operations 23

GET /tenants/{participantExternalIdentifier}/targets/queue-services/available-destinations-on-rejection #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/available-general-announcements #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/available-music-on-hold-announcements #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/members #
POST /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/members #
PUT /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/members/{extensionNumber} #
DELETE /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/members/{extensionNumber} #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/members/{extensionNumber} #
PUT /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/timeout #
DELETE /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/timeout #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/timeout #
PUT /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber} #
DELETE /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber} #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber} #
DELETE /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/inbound-trunk-numbers/{didNumber} #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/inbound-trunk-numbers/{didNumber} #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/inbound-trunk-numbers #
POST /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/inbound-trunk-numbers #
GET /tenants/{participantExternalIdentifier}/targets/queue-services #
POST /tenants/{participantExternalIdentifier}/targets/queue-services #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/destination-on-rejection #
PUT /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/destination-on-rejection #
GET /tenants/{participantExternalIdentifier}/targets/queue-services/available-destinations-on-timeout #

Documentation

📖
Documentation
https://api.nfon.net/configuration/
📖
APIReference
https://api.nfon.net/configuration/
📖
Documentation
https://nfon-ag.github.io/CTI-API/
📖
APIReference
https://nfon-ag.github.io/CTI-API/
📖
Documentation
https://nfon-ag.github.io/Call-History-API/
📖
APIReference
https://nfon-ag.github.io/Call-History-API/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nfon/refs/heads/main/openapi/nfon-customer-queues-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nfon-customer-queues-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nfon-customer-queues-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: APIs for managing PBX configuration, tenants, operators, licenses, and related resources
  title: PBX Configuration Customer Queues API
  version: 2026.07.20
servers:
- url: /configuration/v1
tags:
- name: Customer Queues
paths:
  /tenants/{participantExternalIdentifier}/targets/queue-services/available-destinations-on-rejection:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_146
      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}/targets/queue-services/available-general-announcements:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_142
      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}/targets/queue-services/available-music-on-hold-announcements:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_143
      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}/targets/queue-services/{serviceNumber}/members:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_150
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                type: object
          description: Success
        '403':
          description: Insufficient permissions
    post:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/QueueMemberRequest'
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: post_46
      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}/targets/queue-services/{serviceNumber}/members/{extensionNumber}:
    put:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/QueueMemberRequest'
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: extensionNumber
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: put_45
      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
    delete:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: extensionNumber
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: delete_46
      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: extensionNumber
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_151
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                type: object
          description: Success
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
  /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/timeout:
    put:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/TimeoutRequest'
      parameters:
      - schema:
          format: int32
          type: integer
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: put_52
      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
    delete:
      parameters:
      - schema:
          format: int32
          type: integer
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: delete_52
      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: int32
          type: integer
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_182
      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/customers/K1234/queues/available-timeout-destinations
                  rel: availableDestinations
                - href: /api/customers/K1234/targets/services/12
                  rel: destinationOnTimeout
                data:
                - value: '45'
                  name: timeoutDelay
                href: /api/customers/example-id/targets/queue-services/example-id/timeout
          description: Success
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
  /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}:
    put:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/QueueRequest'
      parameters:
      - schema:
          format: int32
          type: integer
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: put_41
      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
    delete:
      parameters:
      - schema:
          format: int32
          type: integer
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: delete_42
      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: int32
          type: integer
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_135
      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: {}
                data:
                - value: INBOUND
                  name: direction
                - value: '5'
                  name: weight
                - value: RING_ALL
                  name: ringType
                - value: ROUND_ROBIN
                  name: selectionStrategy
                - value: '10'
                  name: retryTimeout
                - value: 'true'
                  name: reportHoldTime
                - value: '30'
                  name: memberTimeout
                - value: '5'
                  name: memberWrapUpTime
                - value: '60'
                  name: periodicAnnouncementInterval
                - value: '30'
                  name: positionAnnouncementInterval
          description: Success
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
  /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/inbound-trunk-numbers/{didNumber}:
    delete:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: didNumber
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: delete_43
      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: didNumber
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_137
      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: {}
                data:
                - value: '123456'
                  name: didExtension
          description: Success
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
  /tenants/{participantExternalIdentifier}/targets/queue-services/{serviceNumber}/inbound-trunk-numbers:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_136
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                type: object
              example:
                links: {}
                data:
                - value: '123456'
                  name: didExtension
          description: Success
        '403':
          description: Insufficient permissions
    post:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InboundTrunkNumberRequest'
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: post_43
      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}/targets/queue-services:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_134
      security:
      - oauth2:
        - tenant.manager
      - oauth2:
        - tenant.system-integrator
      - oauth2:
        - tenant.operator
      - oauth2:
        - tenant.admin
      responses:
        '200':
          content:
            application/vnd.collection.next+json:
              schema:
                type: object
              example:
                links:
                - href: /api/sip-servers?_pageSize=20&_offset=0
                  rel: first
                data:
                - value: INBOUND
                  name: direction
                - value: '5'
                  name: weight
                - value: RING_ALL
                  name: ringType
                - value: ROUND_ROBIN
                  name: selectionStrategy
                - value: '10'
                  name: retryTimeout
                - value: 'true'
                  name: reportHoldTime
                - value: '30'
                  name: memberTimeout
                - value: '5'
                  name: memberWrapUpTime
                - value: '60'
                  name: periodicAnnouncementInterval
                - value: '30'
                  name: positionAnnouncementInterval
          description: Success
        '403':
          description: Insufficient permissions
    post:
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/QueueRequest'
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: post_42
      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}/targets/queue-services/{serviceNumber}/destination-on-rejection:
    get:
      parameters:
      - schema:
          format: int32
          type: integer
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_148
      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/DestinationOnRejectionRequest'
      parameters:
      - schema:
          format: int32
          type: integer
        required: true
        in: path
        name: serviceNumber
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: put_43
      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}/targets/queue-services/available-destinations-on-timeout:
    get:
      parameters:
      - schema:
          type: string
        required: true
        in: path
        name: participantExternalIdentifier
      tags:
      - Customer Queues
      operationId: get_178
      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
components:
  schemas:
    TimeoutRequest:
      properties:
        links:
          $ref: '#/components/schemas/TimeoutLinks'
        data:
          $ref: '#/components/schemas/Data'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
    QueueMemberLinks:
      properties:
        phoneExtension:
          $ref: '#/components/schemas/String'
      type: object
    InboundTrunkNumberRequest:
      properties:
        links:
          $ref: '#/components/schemas/InboundTrunkNumberLinks'
        data:
          $ref: '#/components/schemas/InboundTrunkNumberData'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
    NfonApiCollectionResponseNonPage:
      properties:
        links:
          $ref: '#/components/schemas/Links'
        href:
          description: Self-link to this collection
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/NfonApiResponse'
          description: All items in the collection
      type: object
      description: Non-paginated collection response envelope
    Links:
      description: Related resource links
      type: object
    DestinationOnRejectionRequest:
      properties:
        links:
          $ref: '#/components/schemas/RequestLinks'
        data:
          $ref: '#/components/schemas/Data'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
    Integer:
      properties:
        notNull:
          type: boolean
        notPresent:
          type: boolean
        present:
          type: boolean
        presentNotNull:
          type: boolean
        presentNull:
          type: boolean
        value:
          format: int32
          type: integer
      example: 1000
      type: object
      description: Subscribers soft limit
    CollectionLinks:
      properties:
        first:
          $ref: '#/components/schemas/String'
        prev:
          $ref: '#/components/schemas/String'
        next:
          $ref: '#/components/schemas/String'
        last:
          $ref: '#/components/schemas/String'
      type: object
      description: Pagination links for collection responses
    RequestLinks:
      properties:
        destinationOnRejection:
          type: string
      type: object
    QueueData:
      properties:
        weight:
          $ref: '#/components/schemas/Integer'
        ringType:
          $ref: '#/components/schemas/Enum'
        selectionStrategy:
          $ref: '#/components/schemas/Enum'
        retryTimeout:
          $ref: '#/components/schemas/Integer'
        reportHoldTime:
          $ref: '#/components/schemas/Boolean'
        memberTimeout:
          $ref: '#/components/schemas/Integer'
        memberWrapUpTime:
          $ref: '#/components/schemas/Integer'
        periodicAnnouncementInterval:
          $ref: '#/components/schemas/Integer'
        positionAnnouncementInterval:
          $ref: '#/components/schemas/Integer'
        name:
          $ref: '#/components/schemas/String'
        type:
          $ref: '#/components/schemas/String'
        active:
          $ref: '#/components/schemas/Boolean'
        displayName:
          $ref: '#/components/schemas/String'
        serviceNumber:
          $ref: '#/components/schemas/Integer'
        serviceCode:
          $ref: '#/components/schemas/String'
        notActiveSince:
          $ref: '#/components/schemas/Date'
        extensionNumber:
          $ref: '#/components/schemas/String'
        direction:
          $ref: '#/components/schemas/Enum'
      type: object
    QueueMemberData:
      properties:
        penalty:
          $ref: '#/components/schemas/Integer'
        displayName:
          $ref: '#/components/schemas/String'
        extensionNumber:
          $ref: '#/components/schemas/String'
      type: object
    ChildHref:
      type: object
    String:
      properties:
        notNull:
          type: boolean
        notPresent:
          type: boolean
        present:
          type: boolean
        presentNotNull:
          type: boolean
        presentNull:
          type: boolean
        value:
          type: string
      type: object
      description: Link to the last page
    Boolean:
      properties:
        notNull:
          type: boolean
        notPresent:
          type: boolean
        present:
          type: boolean
        presentNotNull:
          type: boolean
        presentNull:
          type: boolean
        value:
          type: boolean
      type: object
      example: false
    InboundTrunkNumberLinks:
      properties:
        trunk:
          type: string
      type: object
    QueueMemberRequest:
      properties:
        links:
          $ref: '#/components/schemas/QueueMemberLinks'
        data:
          $ref: '#/components/schemas/QueueMemberData'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
    NfonApiCollectionResponse:
      oneOf:
      - $ref: '#/components/schemas/NfonApiCollectionResponsePage'
      - $ref: '#/components/schemas/NfonApiCollectionResponseNonPage'
      type: object
      description: Collection response envelope
    QueueLinks:
      properties:
        availableMusicOnHoldAnnouncements:
          $ref: '#/components/schemas/String'
        periodicAnnouncement:
          $ref: '#/components/schemas/String'
        customer:
          $ref: '#/components/schemas/String'
        members:
          $ref: '#/components/schemas/String'
        initialAnnouncement:
          $ref: '#/components/schemas/String'
        inboundTrunkNumbers:
          $ref: '#/components/schemas/String'
        musicOnHoldAnnouncement:
          $ref: '#/components/schemas/String'
        destinationOnRejection:
          $ref: '#/components/schemas/String'
        memberAnnouncement:
          $ref: '#/components/schemas/String'
        availableDestinationsOnRejection:
          writeOnly: true
          type: string
        destinationOnTimeout:
          $ref: '#/components/schemas/ChildHref'
        availableGeneralAnnouncements:
          $ref: '#/components/schemas/String'
        availableDestinationsOnTimeout:
          writeOnly: true
          type: string
      type: object
    Enum:
      properties:
        notNull:
          type: boolean
        notPresent:
          type: boolean
        present:
          type: boolean
        presentNotNull:
          type: boolean
        presentNull:
          type: boolean
        value:
          type: object
      type: object
      example: 'OFF'
    NfonApiCollectionResponsePage:
      properties:
        links:
          $ref: '#/components/schemas/CollectionLinks'
        offset:
          example: 0
          description: Current page offset
          format: int64
          type: integer
        total:
          example: 42
          description: Total number of items in the collection
          format: int64
          type: integer
        items:
          type: array
          items:
            $ref: '#/components/schemas/NfonApiResponse'
          description: Items in this page
        size:
          example: 20
          description: Number of items in this page
          format: int32
          type: integer
        href:
          description: Self-link to this collection
          type: string
      type: object
      description: Paginated collection response envelope
    TimeoutLinks:
      type: object
    Date:
      properties:
        notNull:
          type: boolean
        notPresent:
          type: boolean
        present:
          type: boolean
        presentNotNull:
          type: boolean
        presentNull:
          type: boolean
        value:
          format: date-time
          type: string
      type: object
    NfonApiResponse:
      properties:
        links:
          $ref: '#/components/schemas/Links'
        data:
          description: Resource data (name/value pairs or structured object)
          type: object
        href:
          example: /api/sip-servers/100
          type: string
          description: Self-link to this resource
      type: object
      description: Standard API response envelope for a single resource
    InboundTrunkNumberData:
      properties:
        didExtension:
          example: '123456'
          type: string
      type: object
    Data:
      properties:
        key:
          type: string
          description: Metadata key.
          example: function_key_number
        value:
          type: string
          description: Metadata value.
          example: '5'
      type: object
      required:
      - key
      - value
      description: Data represents key-value pair for additional reference metadata.
    QueueRequest:
      properties:
        links:
          $ref: '#/components/schemas/QueueLinks'
        data:
          $ref: '#/components/schemas/QueueData'
        items:
          items:
            type: object
          type: array
        itemCount:
          format: int32
          type: integer
      type: object
  securitySchemes:
    jwt:
      scheme: bearer
      bearerFormat: JWT
      type: http