Kaleyra Cloud API Documentation



Once you have successfully activated your Kaleyra account and set up the numbers you want to call customers from, you can start building an automated sequence of voice messages for IVR, or as we call it, a flow.

Kaleyra’s Flowbuilder module on the left menu allows you to design the flow of an incoming call with easy drag-and-drop widgets, such as:

Call Forward
Forward an incoming call to a number of your choice.

  1. Select the number to forward the call.
  2. Add the Caller ID to the calls originating from the flow.
  3. Play a ring to the customer while forwarding the call.
  4. Select a dial time out if the call doesn’t connect.

Hang up the call when your call is completed.

IVR Menu
Create an interactive input option for your customers.

  • Create and play an IVR message to your customer by using text to speech, audio selection, or sound file upload.
  • Control the speech rate and language.
  • Choose the inputs that can be given by the customer as a keypress during the call.
  • Choose the delay or duration between the keypresses.

Play an introductory or descriptive message for your customers.

  • Configure a welcome message or any other message to add in the flow using this widget.
  • Use text-to-speech, audio selection, or sound file upload for configuring the message. The speech rate and language can be chosen.

Record the user keypress inputs using this widget. The use cases may involve doing surveys, taking inputs like OTP, pins, etc.

  • Configure a message to be played to the customer.
  • Regulate the delay between the individual keypress.

Make use of this widget to repeat an action in the flow builder. You can configure the following:

  • Number of repetitions.
  • An entry message to let the customer know the reason for repeating the option.
  • An exit message, if the number of retries expires.

Users will now be able to send SMS via Flowbuilder to multiple numbers using their Sender ID.

Users will now be able to use the API to determine the call flow trajectory. You can configure the different actions based on the API responses.

  • Choose the API method type as POST or GET.
  • Choose the response type as either an HTTP status or a response variable.

Below is a sample flow where the call made on the subscribed number will land. A message will be played, and then the call will be forwarded to another number.

Updated about a month ago


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.