Cisco Voice Portal Session Monitoring API

Monitor active VXML call sessions

Operations 2

GET /application/{applicationName}/sessions Cisco Voice Portal List Active Application Sessions #
GET /session/{sessionId} Cisco Voice Portal Get Vxml Session Details #

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/cisco-voice-portal-session-monitoring-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.

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

OpenAPI Specification

cisco-voice-portal-session-monitoring-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Voice Portal VXML Services Session Monitoring API
  description: The Cisco Unified Customer Voice Portal (CVP) VXML Services API provides management and monitoring capabilities for the CVP VXML Server component.
  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://{vxml-server}:7443/CVP/rest
  description: CVP VXML Server REST management interface
  variables:
    vxml-server:
      default: cvp-vxmlserver.example.com
      description: Hostname or IP of the CVP VXML Server
security:
- basicAuth: []
tags:
- name: Session Monitoring
  description: Monitor active VXML call sessions
paths:
  /application/{applicationName}/sessions:
    get:
      operationId: listApplicationSessions
      summary: Cisco Voice Portal List Active Application Sessions
      description: Retrieves a list of active call sessions currently being handled by the specified VXML application.
      tags:
      - Session Monitoring
      parameters:
      - $ref: '#/components/parameters/ApplicationName'
      - name: limit
        in: query
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: Active sessions
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSessions:
                    type: integer
                  sessions:
                    type: array
                    items:
                      $ref: '#/components/schemas/VxmlSession'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /session/{sessionId}:
    get:
      operationId: getSessionDetails
      summary: Cisco Voice Portal Get Vxml Session Details
      description: Retrieves detailed information about an active VXML session, including the current element being executed, session variables, and execution history.
      tags:
      - Session Monitoring
      parameters:
      - name: sessionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Session details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VxmlSessionDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Session not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    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'
    VxmlSessionDetail:
      type: object
      properties:
        sessionId:
          type: string
          example: '500123'
        callGuid:
          type: string
          example: '500123'
        applicationName:
          type: string
          example: example_value
        startTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        duration:
          type: integer
          example: 10
        currentElement:
          type: string
          example: example_value
        callingNumber:
          type: string
          example: example_value
        calledNumber:
          type: string
          example: example_value
        sessionVariables:
          type: object
          additionalProperties:
            type: string
          description: VXML session-level variables
          example: example_value
        elementHistory:
          type: array
          items:
            type: object
            properties:
              elementName:
                type: string
              enteredAt:
                type: string
                format: date-time
              exitedAt:
                type: string
                format: date-time
              exitState:
                type: string
          description: History of elements visited in this session
          example: []
        lastUserInput:
          type: string
          description: Last input received from the caller (DTMF or ASR result)
          example: example_value
    VxmlSession:
      type: object
      properties:
        sessionId:
          type: string
          example: '500123'
        callGuid:
          type: string
          description: Associated CVP call GUID
          example: '500123'
        applicationName:
          type: string
          example: example_value
        startTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        duration:
          type: integer
          description: Session duration in seconds
          example: 10
        currentElement:
          type: string
          description: Currently executing call flow element
          example: example_value
        callingNumber:
          type: string
          example: example_value
        calledNumber:
          type: string
          example: example_value
  responses:
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    ApplicationName:
      name: applicationName
      in: path
      required: true
      description: Name of the deployed VXML application
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using CVP VXML Server credentials