SOAP

This is an advanced module

Function

This module allows users to integrate with a SOAP webservice integration from within the application.

Its functionality is similar to the REST () module, but using the SOAP specification. Unlike REST, SOAP is fully discoverable. With REST, users must know precisely what information the the webservice should return. Conversely, with SOAP, users can essentially send a list of required information and the webservice will be able to return that information.

Inputs

The SOAP module has four different input sections.

WSDL URL

Enter the WSDL for the desired SOAP webservice. Click the refresh icon to load the WSDL methods for the webservice in the module.

SOAP Version

This indicates the SOAP version for the selected webservice. Options include SOAP 1.1 or SOAP 1.2.

Method

Drop-down menu that selects the method of the desired SOAP webservice.

Parameters

Set parameters for the desired SOAP webservice based on the method selected from the WSDL.

  • Parameter: The parameter name. The module automatically populates this field when selecting a method for the desired SOAP webservice.

  • Value: The value to be submitted for the parameter. This field accepts dynamic variables from within an application.

Module Settings

Enable this setting to play audio while an end-user is on hold. To upload a file for hold music, go to Application Settings > Connection Settings > Webservices > Webservice fetch audio.

This allows users to set the maximum time, in seconds, that elapse before returning a timeout error. This applies modules that fetch outside scripts, like the SOAP, REST, or subdialog modules. The default value for Timeout Length is 30 seconds. Acceptable number values range from 1 to 120.

Private

This setting controls the logging function of a module. Enabling the 'Private' setting instructs the module to not record, report, or retain the information input to that module for reporting or any other purposes. When enabled any information entered into a module during a call will be lost immediately when the call terminates. The 'Private' setting is critical for businesses that need to maintain PCI-DSS or HIPAA compliance. The module icon, in the upper left-hand corner, becomes grayed-out when this setting is enabled. See more details here.

This setting can be used to catch any error that occur during the SOAP call. The two common errors associated with a SOAP webservice are timeouts and faults. The latter are custom SOAP errors.

The two common errors associated with a SOAP webservice are timeouts and faults. The latter are custom SOAP errors.