Purpose

With Text-To-Speech plugin your application can interact with users on a much more personal level

Features

Verbalize your customer’s message over call.
Option to save the message and playback when the customer calls back on your number.
Option to repeat the message based on your configuration.
You can use any number of custom parameters in the message.
Option to customize the message

Getting Started

Initial Set Up

Reach Kaleyra support to get Voice account.

Plugin Configuration

Follow the below steps to configure.

Login to your Voice account.
Click on User Plugins in the main menu and then select Text To Speech.

$C:\Users\preethi.k\Desktop\screenshots\tts1.png$

Figure 1: User Plugins

Click on Config and select Add new configuration.

$C:\Users\preethi.k\Desktop\screenshots\fd2.png$

Figure 2: Add new configuration

Activate the plugin by checking the status option
Provide a unique Title to the configuration.
Provide a unique Name to the configuration.
If one time message is checked, user can listen to the message only once. If unchecked, and the user calls back on the same number the most recent message against his phone number is read out.
If Auto call generation is checked, the user will automatically receive a call and his message is read out.

$C:\Users\preethi.k\Desktop\screenshots\tts2.png$

Figure 3: configuration

Click on Save
Your configuration then lists under the Text To Speech section of user plugins.

$C:\Users\preethi.k\Desktop\screenshots\tts3.png$

Figure 4: Edit/delete configuration

You can edit or delete your configuration from here.

IVR Configuration

Once you save the Text to Speech plugin configuration explained above, an IVR is created in your account

To view/edit the same, follow the below procedure.

Click on IVR Studio in the main menu.

$C:\Users\preethi.k\Desktop\screenshots\tts5.png$

Figure 5: Text to speech IVR

Click on the Edit icon under the IVR ASSIGNED TO column and assign a Voice number for your requirement.
Click on $C:\Users\preethi.k\Desktop\screenshots\fd6.png$ to duplicate the IVR Flow, in case you want to create a slightly different flow assigned to a different number.
Click on $C:\Users\preethi.k\Desktop\screenshots\fd8.png$ to edit the IVR title and delete the IVR flow respectively.
Click on $C:\Users\preethi.k\Desktop\screenshots\fd7.png$ to track your customer’s keypress over call.

$C:\Users\preethi.k\Desktop\screenshots\fd9.png$

Figure 6: IVR keypress

Click on the Edit icon under EDIT/CREATE CALL FLOW, to edit the default IVR flow created.

3.4 Text To Speech Integration

Click on API Code against your Text To Speech configuration.

$C:\Users\preethi.k\Desktop\screenshots\tts4.png$

Figure 7: Get API Code

Text To Speech API based on the configuration made by you as explained above is listed here.
Copy this API.
Trigger this API with your API key and proper caller and message parameters.
There are 2 formats of API available.

You pass us mobile number and message
You pass us mobile number and various other custom parameters.

Choose one of the above formats based on your requirement and paste it in your application.

Working

You trigger the API as per your functional requirement.
We receive the message and mobile number details.
We then initiate a call to that mobile number and verbalize your message.
If the user calls back on the Voice number and the option one time message is unchecked, he will be able to listen to the recent message against his number. If the option is checked we will hangup by playing a message “Sorry, There is no message available for you”.
If an unknown number (Number for which data is not available with us) calls on the Voice number we will hangup by playing a message “Sorry, There is no message available for you”.

Note: The above flow is created for you by default. You can modify the flow as per your requirement.

Text-to-Speech Plugin Print