Getting Started with Kaleyra.io APIs

Kaleyra.io APIs are completely RESTful and all our responses are returned in JSON.

Introduction

Welcome to the Kaleyra.io APIs Guide. The purpose of this guide is to provide in-depth knowledge for developers on creating and working with APIs such as SMS, Voice, Lookup, and WhatsApp.

Different Types of Kaleyra.io APIs

Below is the list of Kaleyra.io APIs:

SMS API

Kaleyra.io Programmable SMS API helps you to add robust messaging capabilities to your application. It is a simple REST interface for sending and receiving SMS messages to/from over 300 countries globally. Also, it uses HTTP verbs and standard HTTP status codes to make it easier for you to integrate communications into your code.

Using Kaleyra SMS API, you can send,

  • Bulk SMS
  • OTP SMS
  • Verified SMS (vSMS)
  • Flash SMS
  • SMS with Unicode

You can also Search, Retrieve, Modify, and Track the delivery status of messages using the SMS API.

Visit our SMS page to know more about the feature and its benefits.

Lookup API

Obtain comprehensive information about phone numbers listed in your database using our Lookup APIs. The GET and POST methods allow you to Lookup information for single and multiple numbers, respectively. Lookup is processed in real-time, and the response returned provides information such as carrier, geographical location, line type data, number porting, roaming carriers, and so on.
With the Lookup APIs, you can determine if the numbers are,

  • Invalid
  • Inactive
  • Unreachable
  • Ported

Visit our Lookup page to know more about the feature and its benefits.

Voice API

Kaleyra Voice provides the most secure and scalable voice calling capabilities to enhance the customer’s communication experience.

Using Kaleyra Voice API, you can perform the following functions:

  • Schedule reminder calls such as appointments and many more
  • Configure text-to-speech (TTS) for outgoing calls in English and Italian languages for up to 100 numbers at a time
  • Play recorded audio file or any audio file of choice during outgoing calls for up to 100 numbers at a time
  • Trigger a flow made in Flow Builder via the Outgoing call API
  • Route data related to incoming calls such as Caller Number, Call Timing, Keypresses, etc. over callback API
  • Initiate an outgoing call between two numbers and bridge them (Click-to-call)

Visit our Voice Page to know more about the feature and its benefits.

WhatsApp API

WhatsApp is a simple, secure, and reliable way for businesses to reach their customers worldwide. Kaleyra.io WhatsApp API sends the messages via WhatsApp from the Kaleyra.io Platform. Using WhatsApp API, you can set up your WhatsApp Business API client, register your phone number, and send a text message.

The WhatsApp Business API client offers many of the features provided by the WhatsApp applications from Android, iOS, and Web. The difference is that this application can be deployed on a server, providing a local API that allows you to programmatically send and receive messages and integrate this workflow with your systems (For example, CRMs, contact center platforms, etc.).

Below are some of the WhatsApp messages:

  • Template Message
  • Media Template Message
  • Text Message
  • Media Message
  • Location
  • Contacts

WhatsApp Business provides a platform for organizations to keep their customers better informed. Since its introduction, organizations globally also leverage this communication channel to connect with their customers in a simple, secure, and reliable way.

This guide will help organizations onboard and build their first official WhatsApp messaging experience using the Kaleyra.io WhatsApp Business API.

The first step for businesses is to communicate with customers on WhatsApp, create a WhatsApp Business Profile. Once WhatsApp approves your documents and verifies your account, the unique profile for your business with relevant information will be visible to customers communicating with you.

Having an official business account on WhatsApp comes with the following benefits:

  • Stronger global presence
  • Introduces your brand image among customers
  • Engages in interactive customer communications
  • Builds trust among customers
  • Facilitates two-way communication
  • Paves the way for long-term customer relationships
  • Connects with customers on a platform of their choice

Visit our WhatsApp page to know more about the feature and its benefits.

Verify API

Kaleyra’s Verify automates the generation and verification of OTPs sent to the end-user for your business. You can authenticate users during sign up or any transaction process by sending OTP and confirming their ownership of the account or phone number. Further, you can also customize the OTP generation flow as per your needs and even regulate the permission for only specific IP addresses to accept responses.

Visit our Verify page to know more about the feature and its benefits.

Updated 4 months ago


Getting Started with Kaleyra.io APIs


Kaleyra.io APIs are completely RESTful and all our responses are returned in JSON.

Suggested Edits are limited on API Reference Pages

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