Engage Voice | Configuring a SOAP web service
Last updated on February 01, 2021
When configuring a SOAP web service, you will specify all the necessary information about the inputs and configuration of the web service. The information you provide will include the SOAP configuration information for your service such as the port name, service name, and operation name. You will also specify a SOAP action that is to be performed, and a target namespace. You can use tags from our system to insert real-time system data into your SOAP message headers, or to set the values of your SOAP inputs.
Let’s review how you can create and configure a SOAP web service.
Configuring a SOAP web service
To configure a SOAP web service, follow the steps below.
- Navigate to Dev Tools > Web services via the left-hand navigation bar.
- Click New group to create a web services group if you don’t have one already.
- Enter a name for your web services group and click Save.
- Click Add new Web Service under your web services group.
- Check the Active box to enable the web service.
- Check the Mapping Replacement Enabled option if you want to forcefully replace mapped values.
- Click on the Service Type field and select SOAP from the dropdown menu.
- In the Endpoint URL field, specify the HTTP service location f the web service listener.
- In the SOAP Config tab, define the service’s Port Name, Service Name, Operation Name, SOAP Action, and Target Namespace for the service.
- In the Headers tab, click on Add Variable and enter a Name and Value to define any headers.
- On the SOAP Inputs tab, click on Add Variable and enter a Name and Value for the input.
- Set a Rank for the SOAP input.
- Select a Type for the web service client.
- Select a Data Type.
- Click Save to save your changes.
Understanding the SOAP configuration settings
Now that we’ve gone over how to configure a SOAP web service, let’s take a deeper look at the settings discussed in the steps above.
- Active: Enables the web service
- Debug?: Runs the web service in a debug-only mode to analyze SOAP/HTTP messages
- Mapping Replacements Enabled: Enables mapping replacements that you configure
- Send All Script Data: Include script data from a web service embedded in a script
- Service Type: Specify the type of web service as SOAP (or HTTP)
- Description: A description that you will see when selecting a service to invoke elsewhere
- Endpoint URL: The HTTP service location where the web service listener listens for incoming requests
- SOAP Config: Defines the SOAP web service actions and operations
- Port Name: The unique name for binding to the SOAP endpoint
- Service Name: The name of the web service containing the operations and actions
- Operation Name: The name of the operation to be invoked in the web service
- SOAP Action: The SOAP action to use in the header when invoking the operation via HTTP
- Target Namespace: The logical namespace for information about this service
- Headers: Specifies headers for web service requests
- Name: The name of the SOAP message header
- Value: The value of the SOAP message header. You can insert a tag with system data
- SOAP Inputs: Specifies information about the web client inputs for this service
- Rank: A rank which orders the processing of the web client inputs
- Name: The name of the web service input
- Type: The type of web service client to use this service
- Static: Specifies a static web service client
- Dynamic: Specifies a dynamic web service client
- Value: The value of the web service input. You can insert a tag with system data
- Data Type: The type of data for this input
- XSD:String: Specifies character string data type for the input
- XSD:Int: Specifies integer number data for the input
- XSD:Double: Specifies double-precision floating point data for the input
- XSD:Float: Specifies floating-point number data for the input
- XSD:Boolean: Specifies boolean (true/false) data for the input
© 1999-2022 RingCentral, Inc. All rights reserved.