vania-janet/multiturn-rag-retrieval-data huggingface dataset:
How can I help you?"
}
]
}
}
],
"selection_policy": "sequential"
}
]
}
Show more







 text_to_speech 

Sends a command to the Text to Speech service instance used by the phone integration. These commands can dynamically change the configuration or behavior of the service during a conversation.



 Integration channel support 



 Phone 

 ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) 







 Fields 



 Name Type Description Required? 

 response_type string text_to_speech Y 
 command_info object Information specifying the command to send to the Text to Speech. Y 
 command_info.type string The command to send (configure, disable_barge_in, or enable_barge_in). Y 
 command_info.parameters object See [Applying advanced settings to the Text to Speech service](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-phone-actionsphone-actions-text-advanced) N 



The command_info.type field can specify any of the following supported commands:



* configure: Dynamically updates the Text to Speech configuration. Configuration changes can be applied only to the next conversation turn, or for the rest of the session.
* disable_barge_in: Disables speech barge-in so that playback from the phone integration is not interrupted when the customer speaks.
* enable_barge_in: Enables speech barge-in so that the customer can interrupt playback from the phone integration by speaking.



For detailed information about how to use each of these commands, see [Applying advanced settings to the Text to Speech service](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-phone-actionsphone-actions-text-advanced).





 Example
This documentation for the classic Watson Assistant experience has moved. For the most up-to-date version, see [Integrating with WhatsApp](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-deploy-whatsapp). To see all documentation for the new Watson Assistant, please go [here](https://cloud.ibm.com/docs/watson-assistant).



 Integrating with WhatsApp 

Integrate with WhatsApp messaging so your assistant can exchange messages with your customers where they are.

Many customers use WhatsApp because it provides fast, simple, secure messaging for free, and is available on phones all over the world. WhatsApp uses the phone Internet connection to send messages so customers can avoid SMS fees.

This integration creates a connection between your assistant and WhatsApp by using Twilio as a provider.



 Before you begin 

If you don't have one, set up a Twilio messaging account and get a phone number.



1. Go to the [Twilio website](https://www.twilio.com/).
2. Create an account.
3. From the All Products and Services menu ![Twilio All products and services icon](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/twilio-products.png), click Phone numbers.
4. Follow the instructions to get a phone number.

When you get a Twilio phone number, it supports voice, SMS, and MMS automatically. Your new phone number is listed as an active number.







 Ask WhatsApp for permission to enable your Twilio number for WhatsApp. 

WhatsApp has a rigorous process that they use to review all businesses that want to interact with customers over their network. WhatsApp, which is owned by Facebook, requires that you register your business with the Facebook business directory.



1.
dtmf 

Sends commands to the phone integration to control input or output using dual-tone multi-frequency (DTMF) signals. (DTMF is a protocol used to transmit the tones that are generated when a user presses keys on a push-button phone.)



 Fields 



 Name Type Description Required? 

 response_type string dtmf Y 
 command_info object Information specifying the DTMF command to send to the phone integration. Y 
 command_info.type string The DTMF command to send (collect, disable_barge_in, enable_barge_in, or send). Y 
 command_info.parameters object See [Handling phone interactions](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-voice-actions) N 



The command_info.type field can specify any of the following supported commands:



* collect: Collects DTMF keypad input.
* disable_barge_in: Disables DTMF barge-in so that playback from the phone integration is not interrupted when the customer presses a key.
* enable_barge_in: Enables DTMF barge-in so that the customer can interrupt playback from the phone integration by pressing a key.
* send: Sends DTMF signals.



For detailed information about how to use each of these commands, see [Handling phone interactions](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-voice-actions).





 Example 

This example shows the dtmf response type with the collect command, used to collect DTMF input. For more information, including examples of other DTMF commands, see [Handling phone interactions](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-voice-actions).

{
"output": {
"generic": [
{
"response_type": "dtmf",
"command_info": {
"type": "collect",
"parameters": {
"termination_key": "",
"count": 16,
"ignore_speech": true
}
In this case, you can use the [startup options](https://cloud.ibm.com/docs/services/SecureGateway?topic=SecureGateway-client-interactingstartup-args)--service when starting up the Secure Gateway client, such that the parent process of the Secure Gateway client will restart within 60s if all child clients are terminated. Beside that, you can also use the startup options --reconnect to define the reconnect attempts after the connection between Secure Gateway client and Secure Gateway server drop, --reconnect='-1' means retry forever.

Normally, the service downtime will be equal to or less than 10 minutes, the Secure Gateway client (after version v180) should be able to reconnect to the Secure Gateway server automatically.
* How do I run the Secure Gateway client as a daemon on AIX?

To run the Secure Gateway client as a daemon, you use forever along with a script to start the Secure Gateway client as a background process on AIX. Steps and details are in the [AIX](https://cloud.ibm.com/docs/SecureGateway?topic=SecureGateway-auto-start-confauto-start-aix) section of [Configuring Auto-start for the Client](https://cloud.ibm.com/docs/SecureGateway?topic=SecureGateway-auto-start-conf).
* How can I capture the Secure Gateway Client logs on DataPower?

The event category of Secure Gateway Client logs is sgclient. You can create a [log target](https://www.ibm.com/support/knowledgecenter/en/SS9H2Y_7.7.0/com.ibm.dp.doc/logtarget_logs.html) to write the logs with specific event category to a file on DataPower. Following is an example:



* From the default domain:



* GUI side panel select Object → Logging Configuration → Log Target. Or search for Log Target in the Search field.
* Select the Add button to add a log target



* In the Main tab:



* Fill in Name
* Target Type of File
* Log format of Text
Name Type Description Required? 

 response_type string date Y 







 Example 

This example sends a text response asking the user to specify a date, and then shows an interactive date picker.

{
"generic": [
{
"response_type": "text",
"text": "What day will you be checking in?"
},
{
"response_type": "date"
}
]
}







 dtmf 

Sends commands to the phone integration to control input or output using dual-tone multi-frequency (DTMF) signals. (DTMF is a protocol used to transmit the tones that are generated when a user presses keys on a push-button phone.)



 Integration channel support 



 Phone 

 ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) 







 Fields 



 Name Type Description Required? 

 response_type string dtmf Y 
 command_info object Information specifying the DTMF command to send to the phone integration. Y 
 command_info.type string The DTMF command to send (collect, disable_barge_in, enable_barge_in, or send). Y 
 command_info.parameters object See [Handling phone interactions](https://cloud.ibm.com/docs/watson-assistant?topic=phone-actions) N 



The command_info.type field can specify any of the following supported commands:



* collect: Collects DTMF keypad input.
* disable_barge_in: Disables DTMF barge-in so that playback from the phone integration is not interrupted when the customer presses a key.
* enable_barge_in: Enables DTMF barge-in so that the customer can interrupt playback from the phone integration by pressing a key.
* send: Sends DTMF signals.
For Secure Gateway client, if you are using version v180fp9 or former, please upgrade the Secure Gateway client and ensure your Secure Gateway client does not fall more than 3 versions behind.





 Where can I receive Secure Gateway notifications, especially for disruptive maintenance? 

You can get notifications via our [status page](https://cloud.ibm.com/status?selected=maintenance).



* To get the notifications about completed disruptive maintenance, please search Secure Gateway in the tab [History](https://cloud.ibm.com/status?query=Secure+Gateway&selected=history).
* To get the notifications about on going or planned disruptive maintenance, please search Secure Gateway in the tab [Planned maintenance](https://cloud.ibm.com/status?query=Secure+Gateway&selected=maintenance).



When the Secure Gateway client disconnected unexpectedly, please go to the status page to check whether there is disruptive maintenance at that time.





 How can we avoid manually restart after the disruptive maintenance? 

If the maintenance needs to have disruption over 10 minutes, then you might need to manually restart the Secure Gateway client to reconnect to the Secure Gateway server after the maintenance. In this case, you can use the [startup options](https://cloud.ibm.com/docs/services/SecureGateway?topic=SecureGateway-client-interactingstartup-args)--service when starting up the Secure Gateway client, such that the parent process of the Secure Gateway client will restart within 60s if all child clients are terminated. Beside that, you can also use the startup options --reconnect to define the reconnect attempts after the connection between Secure Gateway client and Secure Gateway server drop, --reconnect='-1' means retry forever.

Normally, the service downtime will be equal to or less than 10 minutes, the Secure Gateway client (after version v180) should be able to reconnect to the Secure Gateway server automatically.





 How do I run the Secure Gateway client as a daemon on AIX? 

To run the Secure Gateway client as a daemon, you use forever along with a script to start the Secure Gateway client as a background process on AIX.
"channel": "voice_telephony"
}
]
}
]
}
}
Show more







 text_to_speech 

Sends a command to the Text to Speech service instance used by the phone integration. These commands can dynamically change the configuration or behavior of the service during a conversation.



 Fields 



 Name Type Description Required? 

 response_type string text_to_speech Y 
 command_info object Information specifying the command to send to the Text to Speech. Y 
 command_info.type string The command to send (configure, disable_barge_in, or enable_barge_in). Y 
 command_info.parameters object See [Applying advanced settings to the Text to Speech service](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-voice-actionsdialog-voice-actions-text-advanced) N 



The command_info.type field can specify any of the following supported commands:



* configure: Dynamically updates the Text to Speech configuration. Configuration changes can be applied only to the next conversation turn, or for the rest of the session.
* disable_barge_in: Disables speech barge-in so that playback from the phone integration is not interrupted when the customer speaks.
* enable_barge_in: Enables speech barge-in so that the customer can interrupt playback from the phone integration by speaking.



For detailed information about how to use each of these commands, see [Applying advanced settings to the Text to Speech service](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-voice-actionsdialog-voice-actions-text-advanced).





 Example 

This example uses the text_to_speech response type with the configure command to change the voice used by the Text to Speech service.

{
"output": {
"generic": [
{
"response_type": "text_to_speech",
"command_info": {
"type": "configure",
"parameters" : {
"synthesize": {
Beside that, you can also use the startup options --reconnect to define the reconnect attempts after the connection between Secure Gateway client and Secure Gateway server drop, --reconnect='-1' means retry forever.

Normally, the service downtime will be equal to or less than 10 minutes, the Secure Gateway client (after version v180) should be able to reconnect to the Secure Gateway server automatically.





 How do I run the Secure Gateway client as a daemon on AIX? 

To run the Secure Gateway client as a daemon, you use forever along with a script to start the Secure Gateway client as a background process on AIX. Steps and details are in the [AIX](https://cloud.ibm.com/docs/SecureGateway?topic=SecureGateway-auto-start-confauto-start-aix) section of [Configuring Auto-start for the Client](https://cloud.ibm.com/docs/SecureGateway?topic=SecureGateway-auto-start-conf).





 How can I capture the Secure Gateway Client logs on DataPower? 

The event category of Secure Gateway Client logs is sgclient. You can create a [log target](https://www.ibm.com/support/knowledgecenter/en/SS9H2Y_7.7.0/com.ibm.dp.doc/logtarget_logs.html) to write the logs with specific event category to a file on DataPower. Following is an example:



* From the default domain:



* GUI side panel select Object → Logging Configuration → Log Target. Or search for Log Target in the Search field.
* Select the Add button to add a log target



* In the Main tab:



* Fill in Name
* Target Type of File
* Log format of Text
* Fill in File Name to define the output location, for example: logtemp:///sgclient.log
* Select Archive Mode to Rotate



* In the Event Subscription Tab, select the Add button to add following target event subscription



* Fill in the Event Category selecting sgclient and the Minimum Event Priority of debug
Connecting Workload Protection 

When you integrate an instance of IBM Cloud® Security and Compliance Center Workload Protection with Security and Compliance Center, you can run scans that validate your level of compliance to a specific predefined profile. Then, you can view all the results and a history of those results in a single location.

To learn more about how the integration is configured, check out the following diagram.

Zoom

![The image shows the sequence of events that a user and the services follow as part of setting up the integration.](https://cloud.ibm.com/docs-content/v1/content/a6478671e8f845a84102d9cf49bf28ee7f4f3227/security-compliance/images/workload-protection.svg)

Figure 1. Workload Protection integration flow



1. In your IBM Cloud Security and Compliance Center Workload Protection instance, create a connection that contains the compliance data that you want to see in IBM Cloud so that you can see both IBM Cloud and Workload Protection results in one view.
2. In your IBM Cloud account, register your integration with the Security and Compliance Center.
3. Define a scope to link the connection that you created in Workload Protection with the Security and Compliance Center.
4. In the background, the Security and Compliance Center creates the backend connection when the scope is created.
5. Based on the schedule that you defined in your connection, Workload Protection pulls the data in your account to the Security and Compliance Center.
6. You can navigate to the Dashboard in the Security and Compliance Center UI to view your results.





 Before you begin 

Before you get started, be sure that you have the following prerequisites.



* An IBM Cloud account.
* An instance of IBM Cloud Security and Compliance Center Workload Protection that is already configured to run scans. For more information about creating an instance from the IBM Cloud catalog, see [Getting started with Workload Protection](https://cloud.ibm.com/docs/workload-protection?topic=workload-protection-getting-started).
You can use this response type to restart any activity you previously stopped using the stop_activities response type.



 Integration channel support 



 Phone 

 ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) 







 Fields 



 Name Type Description Required? 

 response_type string start_activities Y 
 activities list A list of objects identifying the activities to start. Y 
 activities[].type string The name of the activity to start. Y 



Currently, the following activities for the phone integration can be started:



* speech_to_text_recognition: Starts recognizing speech. Streaming audio to the Speech to Text service is resumed.
* dtmf_collection: Starts processing of inbound DTMF signals.







 Example 

This example uses the start_activities response type to restart recognizing speech. Because this command is specific to the phone integration, the channels property specifies voice_telephony only.

{
"generic": [
{
"response_type": "start_activities",
"activities":
{
"type": "speech_to_text_recognition"
}
],
"channels":
{
"channel": "voice_telephony"
}
]
}
]
}
Show more







 stop_activities 

Sends a command to a channel integration to stop one or more activities that are specific to that channel. The activities remain stopped until they are restarted using the start_activities response type.



 Integration channel support 



 Phone 

 ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) 







 Fields 



 Name Type Description Required? 

 response_type string stop_activities Y
The security token could be regenerated in the edit board of the gateway panel, you can click the link Regenerate Token which next to Token Expiration to regenerate the token. The Save button cannot be used to regenerate the token. For additional information, see [Regenerate security token](https://cloud.ibm.com/docs/SecureGateway?topic=SecureGateway-add-sg-gwregen-sectoken)





 Why connection is getting error after HTTP(S) redirect? 

When HTTP(S) connection is sent from the requesting application to the defined resource via Secure Gateway service but the defined resource return a redirect response, it will trigger another HTTP(S) connection which will be sent from the requesting application to the redirect resource directly but not via Secure Gateway service, such that the connection will get error if the requesting application do not have direct access to the redirect resource.





 Why I can't use dynamic port service via Secure Gateway? 

Secure Gateway only support one request/resource port for each destination, even you can't define the cloud port in sequence. If the defined resource require connections on dynamic port, then Secure Gateway can't support it.

For example:

Regular FTP connections use port 21 for command channel but use other port for data channel, which cause control connection could be sent via Secure Gateway service to the command channel port 21 of the FTP server, but data flow connection is not able to be sent to the data channel port of the FTP server, even most of the FTP client get the data channel host/port information via the response of the control connection from the FTP server, which means you can't force the FTP client to send data flow connection via Secure Gateway service instead of send to FTP server directly.
With this model came the ability to mark both Gateways and Destinations as 'Active' or 'Inactive'. Part of the new plan billing structure charges the user for the number of Gateways and Destinations that they have.



* Inactive items are not billed
* Inactive Destinations do not have a provisioned cloud port.
* All Destinations within an inactive gateway will also be inactive and cannot be reactivated until their Gateway is also set Active.
* Inactive items are considered Non Functional. Inactive items cannot be in any of the Functional states.



When you [downgrade the plan](https://cloud.ibm.com/docs/SecureGateway?topic=SecureGateway-secure-gateway-service-planschanging-plans), it will update all gateways to be inactive, all provisioned cloud port of the destinations will be reset. If you want to reactivate your gateway, you can click the wrench button in the gateway panel to configure the Non-functional State. For details, see [Reactivate gateway](https://cloud.ibm.com/docs/SecureGateway?topic=SecureGateway-add-sg-gwreactivate).





 Functional States 

When a gateway or destination is marked active it will be billed. Active states for Gateways and Destinations are below:



* Enabled - the gateway or destination is ready for use under normal circumstances.
* Disabled - the gateway or destination has been disabled.



* Gateways - clients will be unable to flow data to the disabled gateway.
* Destinations - clients will be unable to create connections to these disabled destinations.







* How do I know the data activities on the Secure Gateway Client?

On SecureGateway Client, change the log level to TRACE to know the data activities on the client. The following information will be displayed after requests are sent.

Data size sent from request application:

[TRACE] Connection <connection ID> transmitted data: <size> bytes

Data size sent from destination:

[TRACE] Connection <connection ID> received data: <size> bytes
* How do I get the amount of the real-time connections on Secure Gateway?
The Secure Gateway client uses outbound port 443 and port 9000 to connect to npm registry and the IBM Cloud® environment as mentioned in the [network requirement](https://cloud.ibm.com/docs/services/SecureGateway?topic=SecureGateway-client-requirementsnetwork-requirements). If the Secure Gateway client use the proxy for the outbound request, you can use following option to define the proxy configuration.



 Port 443 for gateway authentication connection and port 9000 for WSS connection 

You can use the [startup option](https://cloud.ibm.com/docs/SecureGateway?topic=SecureGateway-client-interactingstartup-args)--proxy to define the proxy agent for the outbound request to the Secure Gateway server, for example, if you are using the auto-start [configuration file](https://cloud.ibm.com/docs/services/SecureGateway?topic=SecureGateway-auto-start-confauto-start-linux):

SECGW_ARGS="--no_license --l $LOGLEVEL -x <proxy_info> --service"

Note:

For the Secure Gateway client v182fp2 and former, the proxy option only support for the port 9000 wss connection, if you want to define the proxy for the port 443 gateway authentication connection, you can add the environment variable http_proxy or https_proxy to the configuration file, for example:

SECGW_ARGS="--no_license --l $LOGLEVEL -x http://prox-server:3128 --service"
export http_proxy=http://prox-server:3128

Or you can define the environment variable before starting the interactive command line interface.





 Port 443 for npm module installation 

For the Secure Gateway client v185 and later, You can define the proxy option for the npm module installation during the Secure Gateway client installation. For example (MacOX):

Enter the gateway IDs, separated by spaces: <gateway_id>
INFO: The gateway ID for this install is: <gateway_id>