The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Web services are a common way for any kind of application to communicate with externally hosted servers to retrieve information or send notification events in a standard manner. Voice applications that access a web service can use the Web Services element.
The Web Services element is an action element so it has the same features as the action element: it does not affect the call flow and has a single exit state. The Web Services element, however, has a more complex configuration than a standard action element. Call Studio renders this configuration with its own special interface.
One unique feature of the Web Services element is its ability to configure itself at design time. This is done by loading a Web Services Description Language (WSDL) file. A WSDL file is an XML file that defines the operations supported by the web services server. It is necessary in order to define the inputs required by the service that must be entered by the designer and the outputs returned by the service that can then be stored for use later in the application.
For much more detailed information about how to use the Web Services element, refer to the Call Studio online help.
Cisco Unified Call Studio includes a new element called the Rest_Client element. The Rest_Client element provides a flexible interface in order to interact with REST endpoints. The communication between the REST client and server is made completely secure using two-way Secure Sockets Layer (SSL). The Rest_Client element permits users to send GET, POST, PUT, or DELETE requests to application servers.
REST uses the boolean flag Ignore Certificate Validation to validate the certificate. The flag can be set to True or False. If the flag is set to False, the client checks for a valid server certificate in its keystore. If the certificate is not found, an error message appears.
Note | Before you validate, ensure that the required certificate is in the respective keystore. |
One-way secure communication imports the REST Server Certificate Authority (CA) certificate into the VXML server trust store, if CA is not available by default.
Perform the following steps to import the REST Server CA certificate into the VXML server:
Two-Way secure communication between VXML and REST Server involves importing the VXML Server CA certificate into the REST Server trust store.
Perform the following steps to import the VXML Server CA certificate on the REST Server:
Step 1 | Retrieve the keystore password from the security.properties file on the VXML Server. | ||
Step 2 | Use the Java
key tool to export the VXML Server CA certificate from the keystore.
File path to VXML keystore: %CVP_HOME%\conf\security\.ormKeystore. | ||
Step 3 | Copy the
exported certificate file from the managed Cisco Unified CVP VXML Server to the
REST Server.
For example: <VXMLca_cert_file> | ||
Step 4 | Use the
following Java key tool command to import the certificate into the REST Server
truststore
keytool –importcert
-keystore <Path to REST server Truststore> -alias <Alias_name>
-file <path to VXMLca_cert_file >
|
Cisco Unified Call Studio includes a new utility that allows you to use XPath expressions in JavaScript to return values from the XML. You can specify an XPath expression in the element setting. If the REST response is an XML, then the nodes which are returned are available as element data. Based on the XML result from the GET method, you can add XPath expression to get the value of a specific row.
For example, consider the following XML you get when you query WSM SNMP public:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <results> <communities> <community> <name>Hello</name> <snmpversion>V1</snmpversion> <acceptfromanyhost>true</acceptfromanyhost> <accessprivilege>readWrite</accessprivilege> <servers> <server>IP address</server> </servers> </community> </communities> <pageinfo> <resultsPerPage>25</resultsPerPage> <startIndex>0</startIndex> <totalResults>1</totalResults> </pageinfo> </results>
To get the value from one specific row, use the following XPath expression: /results/communities/community/snmpversion.
The output of the expression is V1.
If you use the following XPath expression:/results/communities/community/name.
The output of the expression is Hello.
Cisco Unified Call Studio includes a new utility that allows you to specify a JSONPath expression in the element setting. The nodes which are returned are available as element data if the REST response is a JSON.
{"community": {"name":"public","snmpversion":"V1","acceptfromanyhost":"true","accessprivilege":"readOnly","servers":{"server":"IP address}}" }