Cisco Voice Portal Health API

openapi: 3.1.0
info:
  title: Cisco Voice Portal Administration Application Configuration Health 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
security:
- basicAuth: []
- sessionCookie: []
tags:
- name: Health
  description: Call Server health and connectivity status
paths:
  /health:
    get:
      operationId: getCallServerHealth
      summary: Cisco Voice Portal Get Call Server Health Status
      description: Retrieves the health and resource status of the Call Server, including active call count, SIP stack status, and connectivity to upstream components (ICM, CUCM, VXML Server).
      tags:
      - Health
      responses:
        '200':
          description: Call Server health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /health/connectivity:
    get:
      operationId: getConnectivityStatus
      summary: Cisco Voice Portal Get Connectivity Status to Upstream Components
      description: Checks and reports the connectivity status to all configured upstream components including ICM/UCCE, CUCM clusters, VXML Servers, and Reporting Server.
      tags:
      - Health
      responses:
        '200':
          description: Connectivity status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectivityStatus'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    HealthStatus:
      type: object
      properties:
        serverName:
          type: string
          example: example_value
        status:
          type: string
          enum:
          - healthy
          - degraded
          - unhealthy
          example: healthy
        uptime:
          type: string
          description: Server uptime duration
          example: example_value
        version:
          type: string
          example: example_value
        activeCalls:
          type: integer
          example: 10
        maxCalls:
          type: integer
          description: Maximum concurrent call capacity
          example: 10
        sipStackStatus:
          type: string
          enum:
          - running
          - stopped
          - error
          example: running
        cpuUsage:
          type: number
          format: float
          example: 42.5
        memoryUsage:
          type: number
          format: float
          example: 42.5
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    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'
    ConnectivityStatus:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        connections:
          type: array
          items:
            type: object
            properties:
              component:
                type: string
                enum:
                - ICM
                - CUCM
                - VXMLServer
                - ReportingServer
                - MediaServer
              hostname:
                type: string
              ipAddress:
                type: string
              port:
                type: integer
              status:
                type: string
                enum:
                - connected
                - disconnected
                - timeout
                - error
              latency:
                type: integer
                description: Connection latency in milliseconds
              lastSuccessfulContact:
                type: string
                format: date-time
          example: []
  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.