Cisco Voice Portal Call Routing API

openapi: 3.2.0
info:
  title: Cisco Voice Portal Call Control Call Routing API
  description: The Cisco Unified Customer Voice Portal (CVP) Call Control API provides programmatic access to call control functions on the CVP Call Server. The Call Server is the SIP-based call control component that manages call routing, transfers, and session management within the CVP deployment. It integrates with Cisco Unified ICM/UCCE for intelligent call routing and with Cisco Unified Communications Manager (CUCM) for agent delivery. This API exposes management and monitoring operations for active call sessions and call routing configuration on the Call Server component, typically accessible on port 8000.
  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://{call-server}:8000/cvp/rest
  description: CVP Call Server REST management interface
  variables:
    call-server:
      default: cvp-callserver.example.com
      description: Hostname or IP of the CVP Call Server
security:
- basicAuth: []
tags:
- name: Call Routing
  description: Call routing lookup and testing
paths:
  /routing/lookup:
    post:
      operationId: routingLookup
      summary: Cisco Voice Portal Perform a Routing Lookup
      description: Performs a routing lookup to determine the call treatment for a given dialed number. This queries the configured dialed number patterns and returns the routing decision without initiating an actual call. Useful for testing and validation.
      tags:
      - Call Routing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - dialedNumber
              properties:
                dialedNumber:
                  type: string
                  description: The dialed number to look up
                callingNumber:
                  type: string
                  description: Optional calling number for context
      responses:
        '200':
          description: Routing lookup result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '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'
    RoutingResult:
      type: object
      properties:
        dialedNumber:
          type: string
          example: example_value
        matched:
          type: boolean
          description: Whether a matching pattern was found
          example: true
        matchedPattern:
          type: string
          description: The dialed number pattern that matched
          example: example_value
        callType:
          type: string
          enum:
          - preroute
          - translation_route
          - post_route
          example: preroute
        applicationName:
          type: string
          description: Application that would handle the call
          example: example_value
        routeDestination:
          type: string
          description: Resulting route destination
          example: example_value
  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 Call Server credentials