Cisco Voice Portal Media Management API

openapi: 3.2.0
info:
  title: Cisco Voice Portal VXML Services Media Management 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: Media Management
  description: Manage audio media files and prompts
paths:
  /media:
    get:
      operationId: listMediaFiles
      summary: Cisco Voice Portal List Media Files
      description: Retrieves a list of media files (audio prompts) available on the VXML Server. Media files are used by VXML applications and micro-applications for playing prompts to callers.
      tags:
      - Media Management
      parameters:
      - name: path
        in: query
        description: Directory path to list media from
        schema:
          type: string
          default: /
      - name: type
        in: query
        description: Filter by media type
        schema:
          type: string
          enum:
          - wav
          - au
          - vox
      responses:
        '200':
          description: List of media files
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MediaFile'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /media/upload:
    post:
      operationId: uploadMediaFile
      summary: Cisco Voice Portal Upload a Media File
      description: Uploads an audio media file (WAV, AU, or VOX format) to the VXML Server for use in voice prompts and announcements.
      tags:
      - Media Management
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  format: binary
                  description: Audio file to upload
                path:
                  type: string
                  description: Target directory path
                  default: /
                overwrite:
                  type: boolean
                  default: false
                  description: Whether to overwrite existing file
      responses:
        '201':
          description: Media file uploaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaFile'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: File already exists and overwrite is false
        '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'
    MediaFile:
      type: object
      properties:
        fileName:
          type: string
          example: example_value
        filePath:
          type: string
          example: example_value
        fileType:
          type: string
          enum:
          - wav
          - au
          - vox
          example: wav
        fileSize:
          type: integer
          description: File size in bytes
          example: 10
        duration:
          type: number
          format: float
          description: Audio duration in seconds
          example: 42.5
        lastModified:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
  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'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using CVP VXML Server credentials