Cisco Voice Portal Real-Time Statistics API

openapi: 3.1.0
info:
  title: Cisco Voice Portal Administration Application Configuration Real-Time Statistics 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: Real-Time Statistics
  description: Current call processing statistics
paths:
  /statistics/realtime:
    get:
      operationId: getRealtimeStatistics
      summary: Cisco Voice Portal Get Real-time Call Statistics
      description: Retrieves current real-time statistics across the CVP deployment, including active calls, calls per second, and resource utilization metrics. Data is refreshed at the reporting server polling interval.
      tags:
      - Real-Time Statistics
      parameters:
      - name: serverId
        in: query
        description: Filter by specific server ID. If omitted, returns aggregate.
        schema:
          type: string
      responses:
        '200':
          description: Real-time statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealtimeStatistics'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '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'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    RealtimeStatistics:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        activeCalls:
          type: integer
          description: Current number of active calls
          example: 10
        callsInProgress:
          type: object
          properties:
            selfService:
              type: integer
              description: Calls currently in self-service IVR
            queued:
              type: integer
              description: Calls currently queued
            connected:
              type: integer
              description: Calls connected to agents
          example: example_value
        callsPerSecond:
          type: number
          format: float
          description: Current calls per second rate
          example: 42.5
        peakActiveCalls:
          type: integer
          description: Peak active calls in current period
          example: 10
        serverMetrics:
          type: array
          items:
            type: object
            properties:
              serverId:
                type: string
              hostname:
                type: string
              serverType:
                type: string
              activeCalls:
                type: integer
              cpuUsage:
                type: number
                format: float
              memoryUsage:
                type: number
                format: float
          example: []
    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'
  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.