Using a custom configuration value in a Web Service Interface request

When using a Data Connector applet with a web service interface, the applet is sometimes referred to as a Web Service Data Connector or WSDC.

When you configure a Data Connector applet to get data from or send data to an external web service, you can send hard-coded values to that web service in the request object. You can also send custom configuration values that are encrypted and stored by Vonage Contact Center. For example, your web service might require a password to access it. Instead of hard-coding the password in the Data Connector applet for anyone with access to the applet to see, you can request that Vonage Contact Center encrypts and stores this password for you in a custom configuration setting. You can then send the password in the request to the configured web service.

You can use Data Source values in the following ways:

  • If you are defining the web service interaction using XML, to insert a custom configuration value into a request, use a placeholder in the Url element, Key or Value element of a header, or the CDATA section of the Body element.
  • If you are using a template to define the web service interaction, to insert a custom configuration value into a request, use a placeholder in any required request parameter fields.

Placeholders must be in the format #(CustomConfigurationKey). Replace CustomConfigurationKey with the name of the custom configuration setting that contains the value you want to use in the request.

 Example

For example, using the placeholder #(WebServicePassword) the value of the setting called WebServicePassword is decrypted and sent in the request. You can use the placeholder in the following places:

When the call reaches this applet, #(WebServicePassword) is replaced with the decrypted WebServicePassword and the web service uses the password accordingly.

If the custom configuration setting does not exist or has no value, the call is routed to the Interface Failure applet.

If the custom configuration setting is null, the placeholder is removed.

Support and documentation feedback

For general assistance, please contact Customer Support.

For help using this documentation, please send an email to docs_feedback@vonage.com. We're happy to hear from you. Your contribution helps everyone at Vonage! Please include the name of the page in your email.