Cisco Voice Portal · AsyncAPI Specification

Cisco Voice Portal Call Events API

Version 12.6.0

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 publishes call lifecycle events, system alerts, and operational notifications through multiple channels including JMS messaging, SNMP traps, and syslog. This specification documents the event-driven interfaces for consuming CVP call processing events and system notifications.

View Spec View on GitHub Contact CenterIVRTelephonyVoiceVXMLAsyncAPIWebhooksEvents

Channels

cvp/calls/started
subscribe onCallStarted
Receive call started events
Published when a new call is received by the CVP Call Server. This event is generated after the initial SIP INVITE is processed and a call GUID is assigned.
cvp/calls/ended
subscribe onCallEnded
Receive call ended events
Published when a call is terminated. Includes the final call disposition, duration, and summary of the call treatment.
cvp/calls/transferred
subscribe onCallTransferred
Receive call transfer events
Published when a call is transferred to another destination, such as an agent queue, external number, or another application.
cvp/calls/queued
subscribe onCallQueued
Receive call queued events
Published when a call enters a queue waiting for an agent. This event is generated when ICM/UCCE routes the call to a skill group and the call is placed in queue.
cvp/calls/application-invoked
subscribe onApplicationInvoked
Receive application invocation events
Published when a VXML application is invoked to handle a call. This occurs when the Call Server sends the call to a VXML Server for self-service treatment.
cvp/calls/error
subscribe onCallError
Receive call error events
Published when a call processing error occurs, such as a SIP failure, VXML application error, or ICM communication failure.
cvp/system/device-status-changed
subscribe onDeviceStatusChanged
Receive device status change events
Published when the status of a managed CVP device changes, such as transitioning from online to offline or entering maintenance mode.
cvp/system/threshold-exceeded
subscribe onThresholdExceeded
Receive threshold exceeded alerts
Published when a monitored system threshold is exceeded, such as concurrent call limits, CPU usage, memory usage, or disk space. These events correspond to SNMP traps that CVP generates.
cvp/system/service-state-changed
subscribe onServiceStateChanged
Receive service state change events
Published when a CVP service starts, stops, or encounters an error. Monitors service health across the deployment.
cvp/deployment/config-deployed
subscribe onConfigDeployed
Receive deployment completion events
Published when a configuration deployment operation completes, either successfully or with errors.

Messages

✉
CallStartedEvent
Call Started
A new call has been received by CVP
✉
CallEndedEvent
Call Ended
A call has been terminated
✉
CallTransferredEvent
Call Transferred
A call has been transferred to a new destination
✉
CallQueuedEvent
Call Queued
A call has been placed in an agent queue
✉
ApplicationInvokedEvent
Application Invoked
A VXML application has been invoked to handle a call
✉
CallErrorEvent
Call Error
A call processing error has occurred
✉
DeviceStatusChangedEvent
Device Status Changed
A managed device status has changed
✉
ThresholdExceededEvent
Threshold Exceeded
A system monitoring threshold has been exceeded
✉
ServiceStateChangedEvent
Service State Changed
A CVP service has changed state
✉
ConfigDeployedEvent
Configuration Deployed
A configuration deployment operation has completed

Servers

jms
jms tcp://{cvp-server}:61616
CVP JMS message broker for call event notifications. The CVP Call Server and VXML Server publish events to JMS topics that can be consumed by external applications.
syslog
syslog udp://{syslog-server}:514
Syslog endpoint for receiving CVP system events and alerts. CVP components forward structured syslog messages for operational events.