Cisco Voice Portal Dialed Number Patterns API

openapi: 3.1.0
info:
  title: Cisco Voice Portal Administration Application Configuration Dialed Number Patterns 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: Dialed Number Patterns
  description: Manage call routing dialed number patterns
paths:
  /dialedNumberPattern:
    get:
      operationId: listDialedNumberPatterns
      summary: Cisco Voice Portal List Dialed Number Patterns
      description: Retrieves all configured dialed number patterns (DNPs). DNPs define how incoming calls are routed to specific applications or call treatments based on the dialed number.
      tags:
      - Dialed Number Patterns
      responses:
        '200':
          description: List of dialed number patterns
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DialedNumberPattern'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDialedNumberPattern
      summary: Cisco Voice Portal Create a Dialed Number Pattern
      description: Creates a new dialed number pattern to route incoming calls to the appropriate application or call treatment.
      tags:
      - Dialed Number Patterns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DialedNumberPatternCreate'
      responses:
        '201':
          description: Pattern created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DialedNumberPattern'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Pattern already exists
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dialedNumberPattern/{patternId}:
    get:
      operationId: getDialedNumberPattern
      summary: Cisco Voice Portal Get Dialed Number Pattern Details
      tags:
      - Dialed Number Patterns
      parameters:
      - name: patternId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Pattern details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DialedNumberPattern'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateDialedNumberPattern
      summary: Cisco Voice Portal Update a Dialed Number Pattern
      tags:
      - Dialed Number Patterns
      parameters:
      - name: patternId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DialedNumberPatternCreate'
      responses:
        '200':
          description: Pattern updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DialedNumberPattern'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteDialedNumberPattern
      summary: Cisco Voice Portal Delete a Dialed Number Pattern
      tags:
      - Dialed Number Patterns
      parameters:
      - name: patternId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Pattern deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    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'
    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'
  schemas:
    DialedNumberPatternCreate:
      type: object
      required:
      - pattern
      - callType
      properties:
        pattern:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        callType:
          type: string
          enum:
          - preroute
          - translation_route
          - post_route
          example: preroute
        applicationName:
          type: string
          example: example_value
        enabled:
          type: boolean
          default: true
          example: true
    DialedNumberPattern:
      type: object
      properties:
        patternId:
          type: string
          example: '500123'
        pattern:
          type: string
          description: 'The dialed number pattern (supports wildcards). Example: 1800555*'
          example: example_value
        description:
          type: string
          example: A sample description.
        callType:
          type: string
          enum:
          - preroute
          - translation_route
          - post_route
          description: Call type for ICM routing
          example: preroute
        applicationName:
          type: string
          description: Associated VXML application name
          example: example_value
        enabled:
          type: boolean
          default: true
          example: true
    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.