Cisco Voice Portal website screenshot

Cisco Voice Portal

Cisco Voice Portal (CVP) is an enterprise-class Voice XML (VXML) browser and call control platform that enables self-service applications for voice, video, and multimodal interactions.

Cisco Voice Portal publishes 24 APIs on the APIs.io network, including Call Events API, Application Configuration API, Application Management API, and 21 more. Tagged areas include Contact Center, IVR, Telephony, Voice, and VXML.

The Cisco Voice Portal catalog on APIs.io includes 1 event-driven AsyncAPI specification, 4 JSON-LD contexts, and 3 Spectral governance rulesets.

Cisco Voice Portal’s developer surface includes authentication, support, documentation, getting-started guide, engineering blog, signup flow, release notes, and 14 more developer resources.

🌐 Visit website 📡 Source on GitHub
56.4/100 strong ▼ -6.2 Agent 36/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessEnterpriseSelf serve
24 APIs
Contact CenterIVRTelephonyVoiceVXML

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 56.4/100 · strong
Contract Quality 17.0 / 25
Developer Ergonomics 10.0 / 20
Commercial Clarity 10.0 / 20
Operational Transparency 7.5 / 13
Governance 7.0 / 12
Discoverability 7.2 / 10
Agent readiness — 36/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/cisco-voice-portal: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 24

Individual APIs this provider publishes, each with its own machine-readable definition.

Cisco Voice Portal Call Events API

Event-driven interface for consuming real-time CVP call lifecycle events, system alerts, device status changes, and operational notifications via JMS messaging and syslog.

Cisco Voice Portal Application Configuration API

Configure VXML application runtime settings

Cisco Voice Portal Application Management API

Deploy and manage VXML and Call Studio applications

Cisco Voice Portal Call Detail Records API

Access and query call detail records

Cisco Voice Portal Call Management API

Manage and control active calls

Cisco Voice Portal Call Routing API

Call routing lookup and testing

Cisco Voice Portal Call Server Management API

Configure and manage CVP Call Servers

Cisco Voice Portal Deployment API

Deploy configuration to managed devices

Cisco Voice Portal Device Management API

Manage CVP devices (Call Servers, VXML Servers, Reporting Servers)

Cisco Voice Portal Dialed Number Patterns API

Manage call routing dialed number patterns

Cisco Voice Portal Grammar Management API

Manage speech recognition grammar files

Cisco Voice Portal Health API

Call Server health and connectivity status

Cisco Voice Portal Historical Reports API

Aggregated historical reporting data

Cisco Voice Portal Media Management API

Manage audio media files and prompts

Cisco Voice Portal Micro-Applications API

Manage built-in CVP micro-applications

Cisco Voice Portal Real-Time Statistics API

Current call processing statistics

Cisco Voice Portal Report Templates API

Execute pre-defined report templates

Cisco Voice Portal Server Status API

VXML Server status and monitoring

Cisco Voice Portal Session Monitoring API

Monitor active VXML call sessions

Cisco Voice Portal SIP Configuration API

Configure SIP server groups and settings

Cisco Voice Portal SIP Sessions API

Monitor SIP session details

Cisco Voice Portal System Configuration API

Global system settings and licensing

Cisco Voice Portal User Management API

Manage OAMP user accounts

Cisco Voice Portal VXML Server Management API

Configure and manage CVP VXML Servers

Scroll for all 24

Postman Collections 23

Ready-to-run Postman collections for exercising this provider's APIs.

Cisco Voice Portal Administration Application Configuration API

POSTMAN

Cisco Voice Portal Administration Application Configuration Application Management API

POSTMAN

Cisco Voice Portal Administration Application Configuration Call Detail Records API

POSTMAN

Cisco Voice Portal Administration Application Configuration Call Management API

POSTMAN

Cisco Voice Portal Administration Application Configuration Call Routing API

POSTMAN

Cisco Voice Portal Administration Application Configuration Call Server Management API

POSTMAN

Cisco Voice Portal Administration Application Configuration Deployment API

POSTMAN

Cisco Voice Portal Administration Application Configuration Device Management API

POSTMAN

Cisco Voice Portal Administration Application Configuration Dialed Number Patterns API

POSTMAN

Cisco Voice Portal Administration Application Configuration Grammar Management API

POSTMAN

Cisco Voice Portal Administration Application Configuration Health API

POSTMAN

Cisco Voice Portal Administration Application Configuration Historical Reports API

POSTMAN

Cisco Voice Portal Administration Application Configuration Media Management API

POSTMAN

Cisco Voice Portal Administration Application Configuration Micro-Applications API

POSTMAN

Cisco Voice Portal Administration Application Configuration Real-Time Statistics API

POSTMAN

Cisco Voice Portal Administration Application Configuration Report Templates API

POSTMAN

Cisco Voice Portal Administration Application Configuration Server Status API

POSTMAN

Cisco Voice Portal Administration Application Configuration Session Monitoring API

POSTMAN

Cisco Voice Portal Administration Application Configuration SIP Configuration API

POSTMAN

Cisco Voice Portal Administration Application Configuration SIP Sessions API

POSTMAN

Cisco Voice Portal Administration Application Configuration System Configuration API

POSTMAN

Cisco Voice Portal Administration Application Configuration User Management API

POSTMAN

Cisco Voice Portal Administration Application Configuration VXML Server Management API

POSTMAN

Scroll for all 23

Open Collections 4

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Cisco Voice Portal Administration API

OPEN COLLECTION

Cisco Voice Portal Call Control API

OPEN COLLECTION

Cisco Voice Portal Reporting API

OPEN COLLECTION

Cisco Voice Portal VXML Services API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Cisco Voice Portal Plans Pricing

1 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Cisco Voice Portal Rate Limits

2 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Cisco Voice Portal Finops

FINOPS

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Cisco Voice Portal Call Events API

The Cisco Unified Customer Voice Portal (CVP) generates real-time events during call processing that can be consumed for monitoring, analytics, and integration purposes. CVP pub...

ASYNCAPI

Semantic Vocabularies 4

JSON-LD contexts and semantic vocabularies used across these APIs.

Cisco Voice Portal Administration Context

0 classes · 0 properties

JSON-LD

Cisco Voice Portal Call Control Context

0 classes · 0 properties

JSON-LD

Cisco Voice Portal Reporting Context

0 classes · 0 properties

JSON-LD

Cisco Voice Portal Vxml Services Context

0 classes · 0 properties

JSON-LD

Spectral Rules 3

Spectral governance rulesets for linting and validating these APIs.

Cisco Voice Portal API Rules

6 rules · 5 warnings 1 info

SPECTRAL

Cisco Voice Portal API Rules

6 rules · 4 warnings 2 info

SPECTRAL

Cisco Voice Portal API Rules

17 rules · 8 errors 7 warnings 2 info

SPECTRAL

JSON Schema 61

Standalone JSON Schema definitions for this provider's data models.

Application

8 properties

JSON SCHEMA

CallServerConfig

4 properties

JSON SCHEMA

CallServer

7 properties

JSON SCHEMA

DeviceCreateRequest

5 properties

JSON SCHEMA

Device

8 properties

JSON SCHEMA

DeviceStatus

7 properties

JSON SCHEMA

DeviceUpdateRequest

3 properties

JSON SCHEMA

DialedNumberPatternCreate

5 properties

JSON SCHEMA

DialedNumberPattern

6 properties

JSON SCHEMA

Error

4 properties

JSON SCHEMA

LicenseInfo

6 properties

JSON SCHEMA

OperationStatus

6 properties

JSON SCHEMA

SipServerGroupCreate

4 properties

JSON SCHEMA

SipServerGroup

5 properties

JSON SCHEMA

SystemConfig

3 properties

JSON SCHEMA

UserCreate

4 properties

JSON SCHEMA

User

6 properties

JSON SCHEMA

VxmlServerConfig

5 properties

JSON SCHEMA

VxmlServer

7 properties

JSON SCHEMA

Cisco Voice Portal Application

16 properties

JSON SCHEMA

ActiveCallDetail

14 properties

JSON SCHEMA

ActiveCall

7 properties

JSON SCHEMA

CallOperationResult

5 properties

JSON SCHEMA

CallVariables

4 properties

JSON SCHEMA

CallVariablesUpdate

3 properties

JSON SCHEMA

ConnectivityStatus

2 properties

JSON SCHEMA

Error

4 properties

JSON SCHEMA

HealthStatus

10 properties

JSON SCHEMA

RoutingResult

6 properties

JSON SCHEMA

SipSessionDetail

14 properties

JSON SCHEMA

SipSession

8 properties

JSON SCHEMA

TransferRequest

4 properties

JSON SCHEMA

Cisco Voice Portal Call Detail Record

20 properties

JSON SCHEMA

Cisco Voice Portal Device

10 properties

JSON SCHEMA

Cisco Voice Portal Dialed Number Pattern

11 properties

JSON SCHEMA

ApplicationStatistics

3 properties

JSON SCHEMA

CallDetailRecord

17 properties

JSON SCHEMA

CallLeg

10 properties

JSON SCHEMA

CallSummaryStatistics

4 properties

JSON SCHEMA

CdrQueryResult

4 properties

JSON SCHEMA

Error

4 properties

JSON SCHEMA

RealtimeStatistics

6 properties

JSON SCHEMA

ReportExecutionRequest

3 properties

JSON SCHEMA

ReportResult

9 properties

JSON SCHEMA

ReportTemplate

5 properties

JSON SCHEMA

ServerStatistics

3 properties

JSON SCHEMA

ApplicationConfig

7 properties

JSON SCHEMA

ApplicationConfigUpdate

6 properties

JSON SCHEMA

CallFlowElement

6 properties

JSON SCHEMA

Error

4 properties

JSON SCHEMA

GrammarFile

6 properties

JSON SCHEMA

LogEntry

6 properties

JSON SCHEMA

MediaFile

6 properties

JSON SCHEMA

MicroAppConfig

3 properties

JSON SCHEMA

MicroApplication

4 properties

JSON SCHEMA

OperationResult

3 properties

JSON SCHEMA

VxmlApplicationDetail

12 properties

JSON SCHEMA

VxmlApplication

6 properties

JSON SCHEMA

VxmlServerStatus

11 properties

JSON SCHEMA

VxmlSessionDetail

11 properties

JSON SCHEMA

VxmlSession

8 properties

JSON SCHEMA

Scroll for all 61

JSON Structure 57

JSON Structure definitions describing this provider's data shapes.

Cisco Voice Portal Administration Application Structure

8 properties

JSON STRUCTURE

Cisco Voice Portal Administration Call Server Config Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Administration Call Server Structure

7 properties

JSON STRUCTURE

Cisco Voice Portal Administration Device Create Request Structure

5 properties

JSON STRUCTURE

Cisco Voice Portal Administration Device Status Structure

7 properties

JSON STRUCTURE

Cisco Voice Portal Administration Device Structure

8 properties

JSON STRUCTURE

Cisco Voice Portal Administration Device Update Request Structure

3 properties

JSON STRUCTURE

Cisco Voice Portal Administration Dialed Number Pattern Create Structure

5 properties

JSON STRUCTURE

Cisco Voice Portal Administration Dialed Number Pattern Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Administration Error Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Administration License Info Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Administration Operation Status Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Administration Sip Server Group Create Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Administration Sip Server Group Structure

5 properties

JSON STRUCTURE

Cisco Voice Portal Administration System Config Structure

3 properties

JSON STRUCTURE

Cisco Voice Portal Administration User Create Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Administration User Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Administration Vxml Server Config Structure

5 properties

JSON STRUCTURE

Cisco Voice Portal Administration Vxml Server Structure

7 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Active Call Detail Structure

14 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Active Call Structure

7 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Call Operation Result Structure

5 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Call Variables Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Call Variables Update Structure

3 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Connectivity Status Structure

2 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Error Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Health Status Structure

10 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Routing Result Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Sip Session Detail Structure

14 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Sip Session Structure

8 properties

JSON STRUCTURE

Cisco Voice Portal Call Control Transfer Request Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Application Statistics Structure

3 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Call Detail Record Structure

17 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Call Leg Structure

10 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Call Summary Statistics Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Cdr Query Result Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Error Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Realtime Statistics Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Report Execution Request Structure

3 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Report Result Structure

9 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Report Template Structure

5 properties

JSON STRUCTURE

Cisco Voice Portal Reporting Server Statistics Structure

3 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Application Config Structure

7 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Application Config Update Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Call Flow Element Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Error Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Grammar File Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Log Entry Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Media File Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Micro App Config Structure

3 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Micro Application Structure

4 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Operation Result Structure

3 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Vxml Application Detail Structure

12 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Vxml Application Structure

6 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Vxml Server Status Structure

11 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Vxml Session Detail Structure

11 properties

JSON STRUCTURE

Cisco Voice Portal Vxml Services Vxml Session Structure

8 properties

JSON STRUCTURE

Scroll for all 57

Examples 57

Example request and response payloads for these APIs.

Cisco Voice Portal Administration Application Example

8 fields

EXAMPLE

Cisco Voice Portal Administration Call Server Config Example

4 fields

EXAMPLE

Cisco Voice Portal Administration Call Server Example

7 fields

EXAMPLE

Cisco Voice Portal Administration Device Create Request Example

5 fields

EXAMPLE

Cisco Voice Portal Administration Device Example

8 fields

EXAMPLE

Cisco Voice Portal Administration Device Status Example

7 fields

EXAMPLE

Cisco Voice Portal Administration Device Update Request Example

3 fields

EXAMPLE

Cisco Voice Portal Administration Dialed Number Pattern Create Example

5 fields

EXAMPLE

Cisco Voice Portal Administration Dialed Number Pattern Example

6 fields

EXAMPLE

Cisco Voice Portal Administration Error Example

4 fields

EXAMPLE

Cisco Voice Portal Administration License Info Example

6 fields

EXAMPLE

Cisco Voice Portal Administration Operation Status Example

6 fields

EXAMPLE

Cisco Voice Portal Administration Sip Server Group Create Example

4 fields

EXAMPLE

Cisco Voice Portal Administration Sip Server Group Example

5 fields

EXAMPLE

Cisco Voice Portal Administration System Config Example

3 fields

EXAMPLE

Cisco Voice Portal Administration User Create Example

4 fields

EXAMPLE

Cisco Voice Portal Administration User Example

6 fields

EXAMPLE

Cisco Voice Portal Administration Vxml Server Config Example

5 fields

EXAMPLE

Cisco Voice Portal Administration Vxml Server Example

7 fields

EXAMPLE

Cisco Voice Portal Call Control Active Call Detail Example

14 fields

EXAMPLE

Cisco Voice Portal Call Control Active Call Example

7 fields

EXAMPLE

Cisco Voice Portal Call Control Call Operation Result Example

5 fields

EXAMPLE

Cisco Voice Portal Call Control Call Variables Example

4 fields

EXAMPLE

Cisco Voice Portal Call Control Call Variables Update Example

3 fields

EXAMPLE

Cisco Voice Portal Call Control Connectivity Status Example

2 fields

EXAMPLE

Cisco Voice Portal Call Control Error Example

4 fields

EXAMPLE

Cisco Voice Portal Call Control Health Status Example

10 fields

EXAMPLE

Cisco Voice Portal Call Control Routing Result Example

6 fields

EXAMPLE

Cisco Voice Portal Call Control Sip Session Detail Example

14 fields

EXAMPLE

Cisco Voice Portal Call Control Sip Session Example

8 fields

EXAMPLE

Cisco Voice Portal Call Control Transfer Request Example

4 fields

EXAMPLE

Cisco Voice Portal Reporting Application Statistics Example

3 fields

EXAMPLE

Cisco Voice Portal Reporting Call Detail Record Example

17 fields

EXAMPLE

Cisco Voice Portal Reporting Call Leg Example

10 fields

EXAMPLE

Cisco Voice Portal Reporting Call Summary Statistics Example

4 fields

EXAMPLE

Cisco Voice Portal Reporting Cdr Query Result Example

4 fields

EXAMPLE

Cisco Voice Portal Reporting Error Example

4 fields

EXAMPLE

Cisco Voice Portal Reporting Realtime Statistics Example

6 fields

EXAMPLE

Cisco Voice Portal Reporting Report Execution Request Example

3 fields

EXAMPLE

Cisco Voice Portal Reporting Report Result Example

9 fields

EXAMPLE

Cisco Voice Portal Reporting Report Template Example

5 fields

EXAMPLE

Cisco Voice Portal Reporting Server Statistics Example

3 fields

EXAMPLE

Cisco Voice Portal Vxml Services Application Config Example

7 fields

EXAMPLE

Cisco Voice Portal Vxml Services Application Config Update Example

6 fields

EXAMPLE

Cisco Voice Portal Vxml Services Call Flow Element Example

6 fields

EXAMPLE

Cisco Voice Portal Vxml Services Error Example

4 fields

EXAMPLE

Cisco Voice Portal Vxml Services Grammar File Example

6 fields

EXAMPLE

Cisco Voice Portal Vxml Services Log Entry Example

6 fields

EXAMPLE

Cisco Voice Portal Vxml Services Media File Example

6 fields

EXAMPLE

Cisco Voice Portal Vxml Services Micro App Config Example

3 fields

EXAMPLE

Cisco Voice Portal Vxml Services Micro Application Example

4 fields

EXAMPLE

Cisco Voice Portal Vxml Services Operation Result Example

3 fields

EXAMPLE

Cisco Voice Portal Vxml Services Vxml Application Detail Example

12 fields

EXAMPLE

Cisco Voice Portal Vxml Services Vxml Application Example

6 fields

EXAMPLE

Cisco Voice Portal Vxml Services Vxml Server Status Example

11 fields

EXAMPLE

Cisco Voice Portal Vxml Services Vxml Session Detail Example

11 fields

EXAMPLE

Cisco Voice Portal Vxml Services Vxml Session Example

8 fields

EXAMPLE

Scroll for all 57

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Cisco Voice Portal Authentication

apiKey/http · 2 schemes

SECURITY

Cisco Voice Portal Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Cisco Voice Portal Vulnerability Disclosure

security.txt · contact published

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Cisco Voice Portal Agentic Access

68 operations · 24 acting · 1 human-in-the-loop

68 operations · 24 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

DeveloperPortal
DeveloperPortal
 GettingStarted
GettingStarted
 Signup
Signup

Documentation 5

Reference material describing how the API behaves

Documentation
Documentation
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Build 2

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace
PostmanWorkspace
 GitHubOrganization
GitHubOrganization

Access & Security 4

Authentication, authorization, and security posture

VulnerabilityDisclosure
VulnerabilityDisclosure
 DomainSecurity
DomainSecurity
 Authentication
Authentication
 Authentication
Authentication

Operate 3

Status, limits, changes, and where to get help

StatusPage
StatusPage
 Support
Support
 ReleaseNotes
ReleaseNotes

Commercial 2

Pricing, plans, and the legal terms of use

TermsOfService
TermsOfService
 PrivacyPolicy
PrivacyPolicy

Company 1

The organization behind the API

Blog
Blog

Source (apis.yml)

apis.yml Raw ↑ 
name: Cisco Voice Portal
description: Cisco Voice Portal (CVP) is an enterprise-class Voice XML (VXML) browser and call control platform that enables
  self-service applications for voice, video, and multimodal interactions.
accessModel:
  pricing: enterprise
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Enterprise · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://www.cisco.com/c/en/us/products/customer-collaboration/unified-contact-center-enterprise/index.html
tags:
- Contact Center
- IVR
- Telephony
- Voice
- VXML
created: '2024'
modified: '2026-05-19'
specificationVersion: '0.18'
url: https://www.cisco.com/c/en/us/products/customer-collaboration/voice-portal/index.html
apis:
- name: Cisco Voice Portal Call Events API
  description: Event-driven interface for consuming real-time CVP call lifecycle events, system alerts, device status changes,
    and operational notifications via JMS messaging and syslog.
  image: https://www.cisco.com/c/en/us/products/customer-collaboration/voice-portal/index.html
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: tcp://cvp-callserver.example.com:61616
  tags:
  - Call Lifecycle
  - Events
  - JMS
  - Monitoring
  - Notifications
  properties:
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
  - type: AsyncAPI
    url: asyncapi/cisco-voice-portal-call-events-asyncapi.yml
- aid: cisco-voice-portal:cisco-voice-portal-application-configuration-api
  name: Cisco Voice Portal Application Configuration API
  description: Configure VXML application runtime settings
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Application Configuration
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-application-configuration-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-application-management-api
  name: Cisco Voice Portal Application Management API
  description: Deploy and manage VXML and Call Studio applications
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Application Management
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-application-management-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-call-detail-records-api
  name: Cisco Voice Portal Call Detail Records API
  description: Access and query call detail records
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Call Detail Records
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-call-detail-records-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-call-management-api
  name: Cisco Voice Portal Call Management API
  description: Manage and control active calls
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Call Management
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-call-management-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-call-routing-api
  name: Cisco Voice Portal Call Routing API
  description: Call routing lookup and testing
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Call Routing
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-call-routing-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-call-server-management-api
  name: Cisco Voice Portal Call Server Management API
  description: Configure and manage CVP Call Servers
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Call Server Management
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-call-server-management-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-deployment-api
  name: Cisco Voice Portal Deployment API
  description: Deploy configuration to managed devices
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Deployment
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-deployment-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-device-management-api
  name: Cisco Voice Portal Device Management API
  description: Manage CVP devices (Call Servers, VXML Servers, Reporting Servers)
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Device Management
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-device-management-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-dialed-number-patterns-api
  name: Cisco Voice Portal Dialed Number Patterns API
  description: Manage call routing dialed number patterns
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Dialed Number Patterns
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-dialed-number-patterns-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-grammar-management-api
  name: Cisco Voice Portal Grammar Management API
  description: Manage speech recognition grammar files
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Grammar Management
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-grammar-management-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-health-api
  name: Cisco Voice Portal Health API
  description: Call Server health and connectivity status
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Health
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-health-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-historical-reports-api
  name: Cisco Voice Portal Historical Reports API
  description: Aggregated historical reporting data
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Historical Reports
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-historical-reports-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-media-management-api
  name: Cisco Voice Portal Media Management API
  description: Manage audio media files and prompts
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Media Management
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-media-management-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-micro-applications-api
  name: Cisco Voice Portal Micro-Applications API
  description: Manage built-in CVP micro-applications
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Micro-Applications
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-micro-applications-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-real-time-statistics-api
  name: Cisco Voice Portal Real-Time Statistics API
  description: Current call processing statistics
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Real-Time Statistics
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-real-time-statistics-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-report-templates-api
  name: Cisco Voice Portal Report Templates API
  description: Execute pre-defined report templates
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Report Templates
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-report-templates-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-server-status-api
  name: Cisco Voice Portal Server Status API
  description: VXML Server status and monitoring
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Server Status
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-server-status-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-session-monitoring-api
  name: Cisco Voice Portal Session Monitoring API
  description: Monitor active VXML call sessions
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - Session Monitoring
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-session-monitoring-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-sip-configuration-api
  name: Cisco Voice Portal SIP Configuration API
  description: Configure SIP server groups and settings
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - SIP Configuration
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-sip-configuration-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-sip-sessions-api
  name: Cisco Voice Portal SIP Sessions API
  description: Monitor SIP session details
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - SIP Sessions
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-sip-sessions-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-system-configuration-api
  name: Cisco Voice Portal System Configuration API
  description: Global system settings and licensing
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - System Configuration
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-system-configuration-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-user-management-api
  name: Cisco Voice Portal User Management API
  description: Manage OAMP user accounts
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - User Management
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-user-management-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
- aid: cisco-voice-portal:cisco-voice-portal-vxml-server-management-api
  name: Cisco Voice Portal VXML Server Management API
  description: Configure and manage CVP VXML Servers
  humanURL: https://developer.cisco.com/docs/voice-portal/
  baseURL: https://cvp-callserver.example.com:8000/cvp/rest
  tags:
  - VXML Server Management
  properties:
  - type: OpenAPI
    url: openapi/cisco-voice-portal-vxml-server-management-api-openapi.yml
  - type: Documentation
    url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-programming-reference-guides-list.html
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/cisco-voice-portal/overview
- type: AgenticAccess
  url: agentic-access/cisco-voice-portal-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/cisco-voice-portal-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/cisco-voice-portal-domain-security.yml
- type: Authentication
  url: authentication/cisco-voice-portal-authentication.yml
- type: DeveloperPortal
  url: https://developer.cisco.com/
- type: Authentication
  url: https://developer.cisco.com/docs/voice-portal/#!authentication
- type: StatusPage
  url: https://status.cisco.com/
- type: Support
  url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/tsd-products-support-series-home.html
- type: TermsOfService
  url: https://www.cisco.com/c/en/us/about/legal/terms-conditions.html
- type: PrivacyPolicy
  url: https://www.cisco.com/c/en/us/about/legal/privacy-full.html
- type: Documentation
  url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/tsd-products-support-series-home.html
- type: GettingStarted
  url: https://developer.cisco.com/site/devnet/
- type: Blog
  url: https://blogs.cisco.com/developer
- type: GitHubOrganization
  url: https://github.com/CiscoDevNet
- type: Signup
  url: https://developer.cisco.com/join/devnet
- type: ReleaseNotes
  url: https://www.cisco.com/c/en/us/support/customer-collaboration/voice-portal/products-release-notes-list.html
- type: JSONSchema
  url: json-schema/cisco-voice-portal-call-detail-record.json
- type: JSONSchema
  url: json-schema/cisco-voice-portal-device.json
- type: JSONSchema
  url: json-schema/cisco-voice-portal-application.json
- type: JSONSchema
  url: json-schema/cisco-voice-portal-dialed-number-pattern.json
- type: Features
  url: https://www.cisco.com/c/en/us/products/customer-collaboration/voice-portal/index.html
- type: UseCases
  url: https://www.cisco.com/c/en/us/products/customer-collaboration/voice-portal/index.html
- type: Integrations
  url: https://developer.cisco.com/ecosystem/
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
  url: https://apievangelist.com