Cisco Voice Portal Micro-Applications API

Manage built-in CVP micro-applications

Operations 2

GET /microapp Cisco Voice Portal List Available Micro-applications #
GET /microapp/{microAppName}/config Cisco Voice Portal Get Micro-application Configuration #

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-micro-applications-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-micro-applications-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Voice Portal VXML Services Micro Applications API
  description: The Cisco Unified Customer Voice Portal (CVP) VXML Services API provides management and monitoring capabilities for the CVP VXML Server component. The VXML Server hosts and executes VoiceXML applications built with Cisco Unified Call Studio. This API enables deployment and management of VXML applications, access to element configurations, and monitoring of the VXML execution environment. The VXML Server exposes its management interface on the HTTP/HTTPS ports (default 7000/7443) alongside the application serving endpoints.
  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: Micro-Applications
  description: Manage built-in CVP micro-applications
paths:
  /microapp:
    get:
      operationId: listMicroApplications
      summary: Cisco Voice Portal List Available Micro-applications
      description: Retrieves a list of built-in CVP micro-applications. Micro-applications are pre-built VXML applications for common IVR tasks such as playing media, collecting digits, and external VXML retrieval. These are invoked through ICM scripting via the Run External Script node.
      tags:
      - Micro-Applications
      responses:
        '200':
          description: List of micro-applications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MicroApplication'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /microapp/{microAppName}/config:
    get:
      operationId: getMicroAppConfig
      summary: Cisco Voice Portal Get Micro-application Configuration
      description: Retrieves the configuration for a specific built-in micro-application such as PlayMedia (PM), GetDigits (GD), Menu, PlayData (PD), CaptureCurrentCallerInfo, or ExternalVXML (EV).
      tags:
      - Micro-Applications
      parameters:
      - name: microAppName
        in: path
        required: true
        description: Micro-application identifier (e.g., PlayMedia, GetDigits, Menu, PlayData, ExternalVXML)
        schema:
          type: string
          enum:
          - PlayMedia
          - GetDigits
          - Menu
          - PlayData
          - ExternalVXML
          - CaptureCurrentCallerInfo
          - AgentGreeting
      responses:
        '200':
          description: Micro-application configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroAppConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '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'
    MicroApplication:
      type: object
      properties:
        name:
          type: string
          description: Micro-application name
          example: Example Title
        description:
          type: string
          example: A sample description.
        type:
          type: string
          enum:
          - PlayMedia
          - GetDigits
          - Menu
          - PlayData
          - ExternalVXML
          - CaptureCurrentCallerInfo
          - AgentGreeting
          example: PlayMedia
        configurable:
          type: boolean
          example: true
    MicroAppConfig:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        description:
          type: string
          example: A sample description.
        parameters:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
              required:
                type: boolean
              defaultValue:
                type: string
              description:
                type: string
          description: Configuration parameters for the micro-application
          example: []
  responses:
    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'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using CVP VXML Server credentials