openapi: 3.1.0
info:
  title: Cisco Voice Portal Administration API
  description: >-
    The Cisco Unified Customer Voice Portal (CVP) Operations, Administration,
    Maintenance, and Provisioning (OAMP) API provides RESTful web services for
    managing CVP deployment configuration. This API enables programmatic access
    to device management, application deployment, system settings, and
    provisioning operations through the CVP OAMP Server. The OAMP Server is the
    central management component of the CVP solution, typically accessed via the
    Unified CVP Operations Console (OAMP web interface) on port 9443.
  version: 12.6.0
  contact:
    name: Cisco Developer Support
    url: https://developer.cisco.com/
  license:
    name: Cisco DevNet
    url: https://developer.cisco.com/site/license/
  x-provider: cisco
  x-product: unified-customer-voice-portal
servers:
- url: https://{oamp-server}:9443/oamp/rest
  description: CVP OAMP Server REST API
  variables:
    oamp-server:
      default: cvp-oamp.example.com
      description: Hostname or IP of the CVP OAMP Server
paths:
  /device:
    get:
      operationId: listDevices
      summary: Cisco Voice Portal List All Managed Devices
      description: >-
        Retrieves a list of all devices registered with the CVP OAMP Server,
        including Call Servers, VXML Servers, Reporting Servers, and Media
        Servers. Each device entry contains its type, hostname, IP address,
        and current operational status.
      tags:
      - Device Management
      responses:
        '200':
          description: List of managed devices
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Device'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: addDevice
      summary: Cisco Voice Portal Add a New Device
      description: >-
        Registers a new device (Call Server, VXML Server, Reporting Server,
        or Media Server) with the CVP OAMP Server for centralized management.
      tags:
      - Device Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceCreateRequest'
      responses:
        '201':
          description: Device created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Device'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Device with this hostname or IP already exists
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /device/{deviceId}:
    get:
      operationId: getDevice
      summary: Cisco Voice Portal Get Device Details
      description: >-
        Retrieves detailed information about a specific managed device,
        including its configuration, status, and associated services.
      tags:
      - Device Management
      parameters:
      - $ref: '#/components/parameters/DeviceId'
      responses:
        '200':
          description: Device details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Device'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateDevice
      summary: Cisco Voice Portal Update Device Configuration
      description: >-
        Updates the configuration of an existing managed device. Changes may
        require a device restart to take effect.
      tags:
      - Device Management
      parameters:
      - $ref: '#/components/parameters/DeviceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceUpdateRequest'
      responses:
        '200':
          description: Device updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Device'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteDevice
      summary: Cisco Voice Portal Remove a Managed Device
      description: >-
        Removes a device from the CVP OAMP management. The device itself is not
        uninstalled but is no longer managed centrally.
      tags:
      - Device Management
      parameters:
      - $ref: '#/components/parameters/DeviceId'
      responses:
        '204':
          description: Device removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /device/{deviceId}/status:
    get:
      operationId: getDeviceStatus
      summary: Cisco Voice Portal Get Device Operational Status
      description: >-
        Retrieves the current operational status of a managed device, including
        service status, resource utilization, and connectivity state.
      tags:
      - Device Management
      parameters:
      - $ref: '#/components/parameters/DeviceId'
      responses:
        '200':
          description: Device status information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /device/{deviceId}/restart:
    post:
      operationId: restartDevice
      summary: Cisco Voice Portal Restart a Device Service
      description: >-
        Initiates a restart of the CVP service on the specified device. This
        operation is asynchronous and the device status can be monitored via
        the status endpoint.
      tags:
      - Device Management
      parameters:
      - $ref: '#/components/parameters/DeviceId'
      responses:
        '202':
          description: Restart initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /callserver:
    get:
      operationId: listCallServers
      summary: Cisco Voice Portal List All Call Servers
      description: >-
        Retrieves a list of all CVP Call Servers managed by the OAMP Server.
        Call Servers handle SIP call control and routing within the CVP
        deployment.
      tags:
      - Call Server Management
      responses:
        '200':
          description: List of Call Servers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CallServer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /callserver/{serverId}/config:
    get:
      operationId: getCallServerConfig
      summary: Cisco Voice Portal Get Call Server Configuration
      description: >-
        Retrieves the full configuration of a specific Call Server, including
        SIP settings, call routing rules, dialed number patterns, and
        connection settings to ICM/UCCE.
      tags:
      - Call Server Management
      parameters:
      - $ref: '#/components/parameters/ServerId'
      responses:
        '200':
          description: Call Server configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallServerConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateCallServerConfig
      summary: Cisco Voice Portal Update Call Server Configuration
      description: >-
        Updates the configuration of a specific Call Server. Changes to SIP
        and routing configuration may require a service restart.
      tags:
      - Call Server Management
      parameters:
      - $ref: '#/components/parameters/ServerId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallServerConfig'
      responses:
        '200':
          description: Configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallServerConfig'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /vxmlserver:
    get:
      operationId: listVxmlServers
      summary: Cisco Voice Portal List All Vxml Servers
      description: >-
        Retrieves a list of all CVP VXML Servers. VXML Servers host and execute
        VoiceXML applications that provide interactive voice response (IVR)
        functionality.
      tags:
      - VXML Server Management
      responses:
        '200':
          description: List of VXML Servers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VxmlServer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /vxmlserver/{serverId}/config:
    get:
      operationId: getVxmlServerConfig
      summary: Cisco Voice Portal Get Vxml Server Configuration
      description: >-
        Retrieves the configuration of a specific VXML Server, including
        application settings, thread pool configuration, and VXML browser
        settings.
      tags:
      - VXML Server Management
      parameters:
      - $ref: '#/components/parameters/ServerId'
      responses:
        '200':
          description: VXML Server configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VxmlServerConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateVxmlServerConfig
      summary: Cisco Voice Portal Update Vxml Server Configuration
      description: >-
        Updates the configuration of a specific VXML Server. Application
        deployment changes take effect immediately; server configuration
        changes may require a restart.
      tags:
      - VXML Server Management
      parameters:
      - $ref: '#/components/parameters/ServerId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VxmlServerConfig'
      responses:
        '200':
          description: Configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VxmlServerConfig'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /application:
    get:
      operationId: listApplications
      summary: Cisco Voice Portal List Deployed Applications
      description: >-
        Retrieves a list of all VXML and call studio applications deployed
        across the CVP infrastructure. Includes deployment status and
        associated server assignments.
      tags:
      - Application Management
      parameters:
      - name: type
        in: query
        description: Filter by application type
        schema:
          type: string
          enum:
          - vxml
          - callstudio
          - microapp
      - name: status
        in: query
        description: Filter by deployment status
        schema:
          type: string
          enum:
          - deployed
          - undeployed
          - error
      responses:
        '200':
          description: List of applications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Application'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: deployApplication
      summary: Cisco Voice Portal Deploy a New Application
      description: >-
        Deploys a VXML or Call Studio application to designated VXML Servers.
        The application archive is uploaded and distributed to the target
        servers.
      tags:
      - Application Management
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - applicationName
              - applicationFile
              properties:
                applicationName:
                  type: string
                  description: Unique name for the application
                applicationType:
                  type: string
                  enum:
                  - vxml
                  - callstudio
                  - microapp
                  description: Type of the application
                applicationFile:
                  type: string
                  format: binary
                  description: Application archive file (.zip or .war)
                targetServers:
                  type: array
                  items:
                    type: string
                  description: List of VXML Server IDs to deploy to
      responses:
        '201':
          description: Application deployed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /application/{applicationId}:
    get:
      operationId: getApplication
      summary: Cisco Voice Portal Get Application Details
      description: >-
        Retrieves detailed information about a deployed application, including
        deployment status on each server and configuration parameters.
      tags:
      - Application Management
      parameters:
      - $ref: '#/components/parameters/ApplicationId'
      responses:
        '200':
          description: Application details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: undeployApplication
      summary: Cisco Voice Portal Undeploy an Application
      description: >-
        Removes a deployed application from all associated VXML Servers. Active
        calls using the application are allowed to complete before removal.
      tags:
      - Application Management
      parameters:
      - $ref: '#/components/parameters/ApplicationId'
      responses:
        '202':
          description: Undeployment initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dialedNumberPattern:
    get:
      operationId: listDialedNumberPatterns
      summary: Cisco Voice Portal List Dialed Number Patterns
      description: >-
        Retrieves all configured dialed number patterns (DNPs). DNPs define
        how incoming calls are routed to specific applications or call
        treatments based on the dialed number.
      tags:
      - Dialed Number Patterns
      responses:
        '200':
          description: List of dialed number patterns
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DialedNumberPattern'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDialedNumberPattern
      summary: Cisco Voice Portal Create a Dialed Number Pattern
      description: >-
        Creates a new dialed number pattern to route incoming calls to the
        appropriate application or call treatment.
      tags:
      - Dialed Number Patterns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DialedNumberPatternCreate'
      responses:
        '201':
          description: Pattern created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DialedNumberPattern'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Pattern already exists
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dialedNumberPattern/{patternId}:
    get:
      operationId: getDialedNumberPattern
      summary: Cisco Voice Portal Get Dialed Number Pattern Details
      tags:
      - Dialed Number Patterns
      parameters:
      - name: patternId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Pattern details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DialedNumberPattern'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateDialedNumberPattern
      summary: Cisco Voice Portal Update a Dialed Number Pattern
      tags:
      - Dialed Number Patterns
      parameters:
      - name: patternId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DialedNumberPatternCreate'
      responses:
        '200':
          description: Pattern updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DialedNumberPattern'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteDialedNumberPattern
      summary: Cisco Voice Portal Delete a Dialed Number Pattern
      tags:
      - Dialed Number Patterns
      parameters:
      - name: patternId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Pattern deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sipserver:
    get:
      operationId: listSipServers
      summary: Cisco Voice Portal List Sip Server Groups
      description: >-
        Retrieves the configured SIP server groups used for call routing.
        Server groups define clusters of SIP endpoints (such as CUCM, SBCs,
        or gateways) that the CVP Call Server communicates with.
      tags:
      - SIP Configuration
      responses:
        '200':
          description: List of SIP server groups
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SipServerGroup'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createSipServerGroup
      summary: Cisco Voice Portal Create a Sip Server Group
      description: >-
        Creates a new SIP server group for call routing purposes. Server groups
        allow load balancing and failover across multiple SIP endpoints.
      tags:
      - SIP Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipServerGroupCreate'
      responses:
        '201':
          description: SIP server group created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipServerGroup'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /system/config:
    get:
      operationId: getSystemConfig
      summary: Cisco Voice Portal Get System-wide Configuration
      description: >-
        Retrieves global system configuration settings including logging levels,
        security settings, and system-wide defaults.
      tags:
      - System Configuration
      responses:
        '200':
          description: System configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateSystemConfig
      summary: Cisco Voice Portal Update System-wide Configuration
      tags:
      - System Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemConfig'
      responses:
        '200':
          description: Configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemConfig'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /system/license:
    get:
      operationId: getLicenseInfo
      summary: Cisco Voice Portal Get Licensing Information
      description: >-
        Retrieves current licensing information including licensed features,
        port capacity, and license expiration status.
      tags:
      - System Configuration
      responses:
        '200':
          description: License information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /user:
    get:
      operationId: listUsers
      summary: Cisco Voice Portal List Oamp Users
      description: >-
        Retrieves a list of users with access to the CVP OAMP management
        interface. Users are assigned roles that determine their access level.
      tags:
      - User Management
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createUser
      summary: Cisco Voice Portal Create an Oamp User
      tags:
      - User Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Username already exists
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployment:
    post:
      operationId: deployConfiguration
      summary: Cisco Voice Portal Deploy Configuration to Devices
      description: >-
        Pushes the current OAMP configuration to specified devices or all
        managed devices. This synchronizes the centrally managed configuration
        with the actual device configurations.
      tags:
      - Deployment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                targetDevices:
                  type: array
                  items:
                    type: string
                  description: >-
                    List of device IDs to deploy to. If empty, deploys to all
                    devices.
                restartAfterDeploy:
                  type: boolean
                  default: false
                  description: Whether to restart services after deploying
      responses:
        '202':
          description: Deployment initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployment/{operationId}:
    get:
      operationId: getDeploymentStatus
      summary: Cisco Voice Portal Get Deployment Operation Status
      description: >-
        Retrieves the status of an ongoing or completed deployment operation.
      tags:
      - Deployment
      parameters:
      - name: operationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deployment status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        HTTP Basic authentication using CVP OAMP administrative credentials.
        The default administrator account is configured during CVP installation.
    sessionCookie:
      type: apiKey
      in: cookie
      name: JSESSIONID
      description: >-
        Session-based authentication obtained after login. The JSESSIONID
        cookie is returned after successful basic authentication.
  parameters:
    DeviceId:
      name: deviceId
      in: path
      required: true
      description: Unique device identifier
      schema:
        type: string
    ServerId:
      name: serverId
      in: path
      required: true
      description: Server identifier
      schema:
        type: string
    ApplicationId:
      name: applicationId
      in: path
      required: true
      description: Application identifier
      schema:
        type: string
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Device:
      type: object
      properties:
        deviceId:
          type: string
          description: Unique identifier for the device
          example: '500123'
        hostname:
          type: string
          description: Hostname of the device
          example: example_value
        ipAddress:
          type: string
          format: ipv4
          description: IP address of the device
          example: example_value
        deviceType:
          type: string
          enum:
          - CallServer
          - VXMLServer
          - ReportingServer
          - MediaServer
          - OAMPServer
          description: Type of CVP component
          example: CallServer
        description:
          type: string
          description: Device description
          example: A sample description.
        status:
          type: string
          enum:
          - online
          - offline
          - maintenance
          - error
          description: Current operational status
          example: online
        version:
          type: string
          description: Software version installed on the device
          example: example_value
        lastContact:
          type: string
          format: date-time
          description: Last time the OAMP server contacted this device
          example: '2026-01-15T10:30:00Z'
    DeviceCreateRequest:
      type: object
      required:
      - hostname
      - ipAddress
      - deviceType
      properties:
        hostname:
          type: string
          example: example_value
        ipAddress:
          type: string
          format: ipv4
          example: example_value
        deviceType:
          type: string
          enum:
          - CallServer
          - VXMLServer
          - ReportingServer
          - MediaServer
          example: CallServer
        description:
          type: string
          example: A sample description.
        credentials:
          type: object
          properties:
            username:
              type: string
            password:
              type: string
              format: password
          example: example_value
    DeviceUpdateRequest:
      type: object
      properties:
        hostname:
          type: string
          example: example_value
        ipAddress:
          type: string
          format: ipv4
          example: example_value
        description:
          type: string
          example: A sample description.
    DeviceStatus:
      type: object
      properties:
        deviceId:
          type: string
          example: '500123'
        status:
          type: string
          enum:
          - online
          - offline
          - maintenance
          - error
          example: online
        services:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              status:
                type: string
                enum:
                - running
                - stopped
                - error
              uptime:
                type: string
                description: Service uptime duration
          example: []
        cpuUsage:
          type: number
          format: float
          description: CPU usage percentage
          example: 42.5
        memoryUsage:
          type: number
          format: float
          description: Memory usage percentage
          example: 42.5
        activeCalls:
          type: integer
          description: Number of active calls on this device
          example: 10
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    CallServer:
      type: object
      properties:
        serverId:
          type: string
          example: '500123'
        hostname:
          type: string
          example: example_value
        ipAddress:
          type: string
          format: ipv4
          example: example_value
        sipPort:
          type: integer
          default: 5060
          example: 10
        status:
          type: string
          enum:
          - online
          - offline
          - maintenance
          example: online
        activeCalls:
          type: integer
          example: 10
        maxCalls:
          type: integer
          example: 10
    CallServerConfig:
      type: object
      properties:
        serverId:
          type: string
          example: '500123'
        sip:
          type: object
          properties:
            port:
              type: integer
              default: 5060
            transport:
              type: string
              enum:
              - UDP
              - TCP
              - TLS
              default: UDP
            maxConnections:
              type: integer
            heartbeatInterval:
              type: integer
              description: SIP OPTIONS heartbeat interval in seconds
          example: example_value
        icm:
          type: object
          properties:
            primaryVruLabel:
              type: string
              description: Primary VRU label for ICM/UCCE integration
            secondaryVruLabel:
              type: string
              description: Secondary VRU label
            maxCallDuration:
              type: integer
              description: Maximum call duration in seconds
          example: example_value
        callRouting:
          type: object
          properties:
            defaultDnisPattern:
              type: string
            sendToVxmlServer:
              type: boolean
              default: true
            ringtoneApplication:
              type: string
            errorApplication:
              type: string
          example: example_value
    VxmlServer:
      type: object
      properties:
        serverId:
          type: string
          example: '500123'
        hostname:
          type: string
          example: example_value
        ipAddress:
          type: string
          format: ipv4
          example: example_value
        httpPort:
          type: integer
          default: 7000
          example: 10
        httpsPort:
          type: integer
          default: 7443
          example: 10
        status:
          type: string
          enum:
          - online
          - offline
          - maintenance
          example: online
        deployedApplications:
          type: integer
          description: Number of applications deployed on this server
          example: 10
    VxmlServerConfig:
      type: object
      properties:
        serverId:
          type: string
          example: '500123'
        http:
          type: object
          properties:
            port:
              type: integer
              default: 7000
            httpsPort:
              type: integer
              default: 7443
            enableHttps:
              type: boolean
              default: true
          example: example_value
        threadPool:
          type: object
          properties:
            minThreads:
              type: integer
              default: 5
            maxThreads:
              type: integer
              default: 500
          example: example_value
        vxmlBrowser:
          type: object
          properties:
            fetchTimeout:
              type: integer
              description: Default fetch timeout in milliseconds
              default: 30000
            maxDocumentSize:
              type: integer
              description: Maximum VXML document size in bytes
            defaultLanguage:
              type: string
              default: en-US
          example: example_value
        logging:
          type: object
          properties:
            level:
              type: string
              enum:
              - ERROR
              - WARN
              - INFO
              - DEBUG
              - TRACE
            maxLogFileSize:
              type: string
              description: Maximum log file size (e.g., 10MB)
          example: example_value
    Application:
      type: object
      properties:
        applicationId:
          type: string
          example: '500123'
        applicationName:
          type: string
          example: example_value
        applicationType:
          type: string
          enum:
          - vxml
          - callstudio
          - microapp
          example: vxml
        status:
          type: string
          enum:
          - deployed
          - undeployed
          - deploying
          - error
          example: deployed
        version:
          type: string
          example: example_value
        deployedServers:
          type: array
          items:
            type: object
            properties:
              serverId:
                type: string
              serverHostname:
                type: string
              deploymentStatus:
                type: string
                enum:
                - deployed
                - pending
                - error
          example: []
        createdAt:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    DialedNumberPattern:
      type: object
      properties:
        patternId:
          type: string
          example: '500123'
        pattern:
          type: string
          description: >-
            The dialed number pattern (supports wildcards). Example: 1800555*
          example: example_value
        description:
          type: string
          example: A sample description.
        callType:
          type: string
          enum:
          - preroute
          - translation_route
          - post_route
          description: Call type for ICM routing
          example: preroute
        applicationName:
          type: string
          description: Associated VXML application name
          example: example_value
        enabled:
          type: boolean
          default: true
          example: true
    DialedNumberPatternCreate:
      type: object
      required:
      - pattern
      - callType
      properties:
        pattern:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        callType:
          type: string
          enum:
          - preroute
          - translation_route
          - post_route
          example: preroute
        applicationName:
          type: string
          example: example_value
        enabled:
          type: boolean
          default: true
          example: true
    SipServerGroup:
      type: object
      properties:
        groupId:
          type: string
          example: '500123'
        groupName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        servers:
          type: array
          items:
            type: object
            properties:
              hostname:
                type: string
              ipAddress:
                type: string
                format: ipv4
              port:
                type: integer
                default: 5060
              priority:
                type: integer
              weight:
                type: integer
          example: []
        loadBalancing:
          type: string
          enum:
          - round_robin
          - top_down
          - weight_based
          default: round_robin
          example: round_robin
    SipServerGroupCreate:
      type: object
      required:
      - groupName
      - servers
      properties:
        groupName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        servers:
          type: array
          items:
            type: object
            required:
            - hostname
            - ipAddress
            properties:
              hostname:
                type: string
              ipAddress:
                type: string
                format: ipv4
              port:
                type: integer
                default: 5060
              priority:
                type: integer
                default: 1
              weight:
                type: integer
                default: 100
          example: []
        loadBalancing:
          type: string
          enum:
          - round_robin
          - top_down
          - weight_based
          default: round_robin
          example: round_robin
    SystemConfig:
      type: object
      properties:
        logging:
          type: object
          properties:
            globalLogLevel:
              type: string
              enum:
              - ERROR
              - WARN
              - INFO
              - DEBUG
              - TRACE
            syslogServer:
              type: string
            syslogPort:
              type: integer
              default: 514
          example: example_value
        security:
          type: object
          properties:
            enableTls:
              type: boolean
              default: true
            tlsVersion:
              type: string
              default: TLSv1.2
            sessionTimeout:
              type: integer
              description: Session timeout in minutes
              default: 30
            passwordPolicy:
              type: object
              properties:
                minLength:
                  type: integer
                  default: 8
                requireUppercase:
                  type: boolean
                  default: true
                requireSpecialChar:
                  type: boolean
                  default: true
                maxAge:
                  type: integer
                  description: Password max age in days
          example: example_value
        snmp:
          type: object
          properties:
            enabled:
              type: boolean
              default: false
            communityString:
              type: string
            trapDestination:
              type: string
          example: example_value
    LicenseInfo:
      type: object
      properties:
        licenseType:
          type: string
          enum:
          - standard
          - premium
          - enterprise
          example: standard
        maxPorts:
          type: integer
          description: Maximum number of concurrent call ports
          example: 10
        usedPorts:
          type: integer
          description: Currently used call ports
          example: 10
        features:
          type: array
          items:
            type: string
          description: Licensed feature list
          example: []
        expirationDate:
          type: string
          format: date
          example: '2026-01-15'
        status:
          type: string
          enum:
          - active
          - expired
          - grace_period
          example: active
    User:
      type: object
      properties:
        userId:
          type: string
          example: '500123'
        username:
          type: string
          example: example_value
        role:
          type: string
          enum:
          - administrator
          - operator
          - read_only
          example: administrator
        email:
          type: string
          format: email
          example: user@example.com
        lastLogin:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        enabled:
          type: boolean
          example: true
    UserCreate:
      type: object
      required:
      - username
      - password
      - role
      properties:
        username:
          type: string
          example: example_value
        password:
          type: string
          format: password
          example: example_value
        role:
          type: string
          enum:
          - administrator
          - operator
          - read_only
          example: administrator
        email:
          type: string
          format: email
          example: user@example.com
    OperationStatus:
      type: object
      properties:
        operationId:
          type: string
          example: '500123'
        status:
          type: string
          enum:
          - pending
          - in_progress
          - completed
          - failed
          example: pending
        message:
          type: string
          example: example_value
        startedAt:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        completedAt:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        progress:
          type: number
          format: float
          description: Progress percentage (0-100)
          example: 42.5
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
security:
- basicAuth: []
- sessionCookie: []
tags:
- name: Application Management
  description: Deploy and manage VXML and Call Studio applications
- name: Call Server Management
  description: Configure and manage CVP Call Servers
- name: Deployment
  description: Deploy configuration to managed devices
- name: Device Management
  description: Manage CVP devices (Call Servers, VXML Servers, Reporting Servers)
- name: Dialed Number Patterns
  description: Manage call routing dialed number patterns
- name: SIP Configuration
  description: Configure SIP server groups and settings
- name: System Configuration
  description: Global system settings and licensing
- name: User Management
  description: Manage OAMP user accounts
- name: VXML Server Management
  description: Configure and manage CVP VXML Servers