Frequently Asked Questions

Q.	What is a CVPAPI?
A.	CVP APIs are RESTful web services that can be used for managing CVP resources. They are classified into following categories: Service Fulfillment APIs Managing VXML Applications Managing Media Files Listing Configured CVP Severs Service Assurance APIs Managing Syslog Configurations Managing SNMP Configurations
Q.	How do I install CVP API?
A.	CVP APIs are installed as part of OAMP Server from Unified CVP 10.0(1) onwards as extension of Web Services Manger. They are deployed as separate web application in Web Services manager.
Q.	Are there any prerequisites to install CVP API?
A.	No. CVP APIs get installed only on OAMP Server not on CVP Servers or reporting servers.
Q.	Are there any post install configurations for CVP API?
A.	After installation or upgrade admin has to invoke synchronization for existing resource. Please refer Metadata Sync-Up section in Cisco Unified CVP API Guide.
Q.	What are synchronous/asynchronous CVP APIs?
A.	Asynchronous CVP APIs accept the request and return an interim response with a resource polling URL. The actual processing of the request is done in the background. Where as synchronous CVP APIs process request and returns final response immediately.
Q.	What protocol, server ip and port numbers do I need to use to invoke the CVP APIs?
A.	You need use https URI with OAMP server ip or host name with port no 8111. For example, https://cvpoamp.mycompany.com:8111//cvp-config/server?q=type:MEDIA
Q.	My OAMP server is deployed in a private network, which uses NAT to communicate client network. Will the CVP APIs work in NAT environment?
A.	Yes. CVP APIs support NAT.
Q.	What is the total number of concurrent calls allowed for CVP rest API?
A.	System has a built-in throttling mechanism which will control the number of concurrent requests. Please refer "Throttling Section" in API doc.
Q.	What are the serviceability tools available to debug CVP API?
A.	Debug levels can be set through SystemCLI under component cvp:OAMP and subcomponent cvp:CVPAPI. Detailed log messages will be written to C:\Cisco\CVP\logs\WSM folder.
Q.	Can these CVP APIs load media files on the gateways?
A.	No. CVP APIs do not load media files on the gateways.
Q.	What happens if a CVP API request is sent when one of the CVP servers is not reachable ?
A.	CVP API performs the operation on the CVP servers that are reachable and returns an error message with list of failed servers in response.

Q.	How do you locate or create the localization media files?
A.	The location where the IIS media hosts the media files are at c:/wwwroot/inetpub. You can specify the relative path from the location and upload the media files to c:/wwwroot/inetpub location. You can also create sub folders for localization media files and specify the path in in CREATE Mediafile API metadata, and the media file gets uploaded to the location.