Cisco Voice Portal VXML Services API — Micro-Applications

naftiko: 1.0.0-alpha2
info:
  label: Cisco Voice Portal VXML Services API — Micro-Applications
  description: 'Cisco Voice Portal VXML Services API — Micro-Applications. 2 operations. Lead operation: Cisco Voice Portal
    List Available Micro-applications. Self-contained Naftiko capability covering one Cisco Voice Portal business surface.'
  tags:
  - Cisco Voice Portal
  - Micro-Applications
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CISCO_VOICE_PORTAL_API_KEY: CISCO_VOICE_PORTAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: vxml-services-micro-applications
    baseUri: https://{vxml-server}:7443/CVP/rest
    description: Cisco Voice Portal VXML Services API — Micro-Applications business capability. Self-contained, no shared
      references.
    resources:
    - name: microapp
      path: /microapp
      operations:
      - name: listmicroapplications
        method: GET
        description: Cisco Voice Portal List Available Micro-applications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: microapp-microAppName-config
      path: /microapp/{microAppName}/config
      operations:
      - name: getmicroappconfig
        method: GET
        description: Cisco Voice Portal Get Micro-application Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: microAppName
          in: path
          type: string
          description: Micro-application identifier (e.g., PlayMedia, GetDigits, Menu, PlayData, ExternalVXML)
          required: true
    authentication:
      type: basic
      username: '{{env.CISCO_VOICE_PORTAL_USER}}'
      password: '{{env.CISCO_VOICE_PORTAL_PASS}}'
  exposes:
  - type: rest
    namespace: vxml-services-micro-applications-rest
    port: 8080
    description: REST adapter for Cisco Voice Portal VXML Services API — Micro-Applications. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/microapp
      name: microapp
      description: REST surface for microapp.
      operations:
      - method: GET
        name: listmicroapplications
        description: Cisco Voice Portal List Available Micro-applications
        call: vxml-services-micro-applications.listmicroapplications
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/microapp/{microappname}/config
      name: microapp-microappname-config
      description: REST surface for microapp-microAppName-config.
      operations:
      - method: GET
        name: getmicroappconfig
        description: Cisco Voice Portal Get Micro-application Configuration
        call: vxml-services-micro-applications.getmicroappconfig
        with:
          microAppName: rest.microAppName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vxml-services-micro-applications-mcp
    port: 9090
    transport: http
    description: MCP adapter for Cisco Voice Portal VXML Services API — Micro-Applications. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: cisco-voice-portal-list-available
      description: Cisco Voice Portal List Available Micro-applications
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vxml-services-micro-applications.listmicroapplications
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-get-micro
      description: Cisco Voice Portal Get Micro-application Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vxml-services-micro-applications.getmicroappconfig
      with:
        microAppName: tools.microAppName
      outputParameters:
      - type: object
        mapping: $.