Jump to Content
Kaleyra.io, WhatsApp, SMS, Email, Voice, Video, Chatbot and OTP API: all you need to knowSMSWhatsAppVoiceVideoAPIIntegrationRelease NotesFAQs
HomeGuidesAPI Reference
SMSWhatsAppVoiceVideoAPIIntegrationRelease NotesFAQsContact UsKaleyra.io Sign InSupportKaleyra.io, WhatsApp, SMS, Email, Voice, Video, Chatbot and OTP API: all you need to know
Guides
Contact UsKaleyra.io Sign InSupport
Security

Home

  • Welcome
  • Glossary
  • Support

Getting started

  • Overview
  • Kaleyra.io Interface
  • Create a Kaleyra.io Account
  • Sign In to kaleyra.io Using Two Factor Authentication(2FA)
  • Onboarding onto Kaleyra
    • Complete the Know Your Customer (KYC) Procedure
    • Opt-in for Kaleyra Services
    • Create a Sender ID
    • Create Kaleyra.io API Key
    • View API Key and SID
    • Add a TAN Number (Optional)
    • Add Credits
  • Settings
    • General Settings
    • User
      • Profile
      • Notifications
    • Team
      • Team Members
      • Kaleyra Expert Role
      • Login History
    • Documents
  • Callback Profiles
    • Callback Encryption
    • Create SMS Callback Profiles using Dynamic Variables
    • Create Callback Profile for WhatsApp Template Status Update
    • Create Callback Profile for Incoming WhatsApp Messages
    • Create Callback Profile for Outgoing WhatsApp Messages
    • Create Email Callback Profiles with Dynamic Variables
    • Callback Basic Authentication
    • Callback Advanced Authentication

SMS

  • Overview
  • Templates Overview
    • Create an SMS Template
    • Search and Filter SMS Template
    • View SMS Template
    • Delete SMS Template
    • Download SMS Template
  • Request an SMS Report
    • SMS MT Summary Reports
    • SMS MO Summary Report
    • SMS Tabular MT and MO Reports
    • SMS Tabular only MT Report
    • SMS By Template Report
    • SMS BY Campaign Report
  • SMS Logs
  • Uploaded Reports
  • Configure SMS Settings
    • Daily Limit
  • Automatic blacklisting of contacts on directory
  • Receive Message
    • Configure Receive Message
    • View Configurations and Logs

WhatsApp

  • Overview
    • Kaleyra WhatsApp API
    • WhatsApp Conversations
    • WhatsApp Business Messaging
    • Product Catalog Messages
    • Opt-in
  • Find your Facebook Business Manager ID
    • Manual Signup
    • Embedded Signup
      • Automated WhatsApp Number Registration
  • Adding a new WABA ID
  • Add a Number
  • WhatsApp Business | Message Templates
    • WhatsApp Templates
      • Add WhatsApp Templates from UI
      • Template Bypass using Business Manager
    • Edit WhatsApp Template
    • Authentication Templates
    • Multi-Product Message Templates
  • WhatsApp Number Messaging Limits and Quality Rating
    • Messaging Limits
    • Quality Rating
    • Receive Updates about Messaging Limits using Webhooks
  • WhatsApp Address Message
  • WhatsApp Pay
  • WhatsApp Business Message Limit
  • Request a WhatsApp Report
    • WhatsApp Tabular Report
    • WhatsApp Summary Reports
  • WhatsApp Analytics - Logs
  • Manage your WhatsApp Channel
    • WhatsApp Dashboard

Email

  • Overview
  • Enable Email Channel Widget
  • Request an Email Report
    • Email Reports
  • Email Logs

Chatbot

  • Overview
  • Onboarding
  • Navigate Chatbot
  • Chatbot Dashboard
  • Autoresponder
    • View Autoresponder Demo
    • Create an Autoresponder
    • Publish an Autoresponder
    • Edit an Autoresponder
  • Infobot
    • View Infobot Demo
    • Create an Infobot
    • Publish an Infobot
    • Edit Infobot's Intent
  • Databot
    • View Databot Demo
    • Create a Databot
    • Publish a Databot
    • Edit a Databot's Intent
  • Enterprise Chatbot
    • View Enterprise Demo
    • Contact Us for Enterprise Chatbot
  • Advanced Chatbot
    • Create Chatbot with Advanced Features
    • Publish an Advanced Chatbot
    • Create Follow-up Questions
    • Create Flow Conditions
    • Create Flow Conditions - Routes
    • API Requests and Responses
    • API Requests and Responses - Callback and Callback Message
    • API Requests and Responses - Response Callback and Response Callback Message
    • Advanced Variable Features
    • Advanced Variable Features - Saved States
    • Advanced Variable Features - Map To
    • Advanced Variable Features - Save
    • Advanced Variable Features - Customize Bot Messages
    • Validate a User or an API Response
    • Validate a User or an API Response - Flag
    • Validate a User or an API Response - B.O.W. (Bag Of Words)
    • Measure Conversions
    • Measure Conversions - Milestone
  • Build Media and Interactive Messages in Chatbot
    • Media Messages
    • Reply Messages with no headers
    • Reply Messages with text headers
    • Reply Messages with image headers
    • Reply Messages with video headers
    • Reply Messages with document headers
    • List Messages with no headers
    • List Messages with text headers
    • Product Messages
      • Single Product Messages
      • Multi Product Messages
  • Request a Chatbot Report
    • Chatbot Tabular Reports

Video

  • Overview
  • Technical Requirements
  • Environment Setup
  • Inbound Call
  • Accessibility Report
    • Mobile SDK v3
    • Mobile SDK v4
    • Web & Widget

Voice

  • Overview
  • Numbers
  • Adding Credits
  • Click to Call
  • Kaleyra Flow Builder
    • Dynamic Variables for FlowBuilder
  • Voice Manager
    • Sound Manager
    • Logs
    • Call Statuses
    • Reports
    • Sticky Agents
  • Generate Report with Recording Details

Campaigns

  • Overview
  • SMS Campaign
    • Launch an SMS Campaign
    • Replay SMS Campaign
    • Cancel SMS Campaign
    • Request SMS Campaign Report
  • WhatsApp Campaign
    • Launch a WhatsApp Campaign
    • Draft WhatsApp Campaign
    • View WhatsApp Campaign
    • Request WhatsApp Campaign Report
  • Voice Campaign
    • Launch a Voice Campaign
    • Draft Voice Campaign

Directory

  • Overview
  • Blocklist
  • Contacts
    • Import Tags for your Contacts in Bulk
  • Tags
  • Lookup

URL Shortener

  • Overview
  • Single URL Shortener
    • Add URL or Upload File to Short URL
    • Search and Filter Shortened URLs
    • Request, Download, and View Shortened URL Report
    • Edit Shortened URL
    • Delete Shortened URL
  • Bulk URL Shortener
    • Upload Files to Short URL in Bulk
    • Search or Filter Files containing Bulk Shortened URLs
    • Bulk Upload URL Features
  • URL Shortener in SMS
  • URL Shortener in WhatsApp
  • URL Shortener in Email
  • Download or Delete Files with Bulk Shortened URLs

Flow Builder

  • Overview
  • Flow Builder Templates
  • Widget Library
    • Start
    • Play
    • Call Forward
    • IVR Menu
    • SMS
    • API
    • Keypress
    • Repeat
    • Date and Time
    • Jump
    • Voicemail
    • Choice
    • Hangup
  • Trigger Flow using Webhook and Voice Call
  • Trigger Flow using Outgoing Call
  • Missed Call Flow
  • Flow Builder Logs
  • Supported Text-to-Speech Languages

Verify

  • Overview
  • Create a Verify Template
  • Create a Verify Configuration
  • API Collection
  • Generate OTPs
  • Validate OTPs

Numbers

  • Overview
  • Subscribe Number
  • Number Statuses
  • Number Listing Page
  • Long Codes and Short Codes

Conversations

  • Overview

Subaccounts

  • Overview
    • Sub-account Services
  • Manage Subaccounts
    • Add a Subaccount
    • View Subaccounts
    • Recharge a Subaccount
    • Access a Subaccount
    • Edit a Subaccount
    • Suspend a Subaccount
    • Login to Subaccount
  • Credits History
    • View Credits History
    • Download Credits History Report
  • Credits Usage
    • View Credits Usage
    • Download Credits Usage Report
  • Reports
    • View Downloaded Reports
    • Generate Summary Report

Communicate Pro

  • Overview
    • Key Features
    • Key Concepts
    • Access Communicate Pro
    • Unlock Accounts
    • Error Handling
  • Campaigns
    • Create a Campaign
    • View Campaign Details
    • Maintain Campaigns
  • Lists
    • Mobile Phone Number Format
    • Create a List
    • Define Broadcast Eligibility for Lists
    • Upload a List
    • Download a List
    • Remove Mobile Numbers
    • Advanced Options
    • Manually Entering Mobile Numbers (Opt-Ins)
    • Upload or Mark Opt-Outs
    • Clear a List
    • Maintain Lists
    • List Assignment
    • Enable List Assignment
    • Assign Lists to Campaigns
  • Broadcasts
    • Create a Broadcast Message
    • Emojis in Broadcasts
    • Create a Quick Broadcast
    • Create and Manage Throttled Broadcasts
    • Use Targeting Rules
    • Queue Control
    • Create and Manage RCS Broadcasts
    • Message Body Text Editor
  • Multivariate Test Broadcast
    • Enable the Multivariate Test Broadcast
    • Create Multivariate Test Broadcast
    • Schedule Variable Configuration
    • Percent of List and Performance Tracking Configuration
    • Multi-Step Program Configuration
    • View Multivariate Test Broadcasts
    • View Broadcast Before Delivery and Performance Details
    • Queue Control for Multivariate Test Broadcasts
  • Interactive Programs
    • Text Response
    • Competition
    • Voting
    • Customer Care
    • Multi-Step Programs
  • View and Export Messages
  • Coupon Service
    • Create a Coupon
    • Name and Response Fields
    • Coupon Codes
    • Coupon Code Truncation
    • Design a Coupon
    • Deliver Mobile Wallet Coupons
  • Reports
    • List Upload or Update Results

APIs

  • Overview

SMS APIs

  • Overview
  • /message endpoint
    • Send the First SMS
    • Send SMS using Template
    • Send OTP SMS
    • Send Bulk SMS
    • Send SMS with Unicode
    • Send Flash SMS
    • Schedule SMS API
    • SMS Status API
    • Create Sender ID
    • Delete Sender ID
    • SMS Route Types
    • SMS Length and Encoding
    • SMS URL Shortening API
  • /sms endpoint
    • Send the First SMS
    • Send SMS using Template
    • Send OTP SMS
    • Send Bulk SMS
    • Send SMS with Unicode
    • Send Flash SMS
    • Schedule SMS API
    • SMS Status API
    • Create Sender ID
    • Delete Sender ID
    • Callback Request using Callback Profiles
    • Send SMS (JSON/XML)
  • SMS Callback
    • Callback Request using Callback Profiles
  • SMS Error Codes
  • SMS Status and Status Trace Codes

WhatsApp APIs

  • Overview
  • WhatsApp Templates
    • WhatsApp Template Category
    • Create a WhatsApp Template with Text
    • Create a WhatsApp Template with Sample Media
    • Create WhatsApp template with enabled Tracked URL
    • Get a WhatsApp Template Status
    • Create an Authentication Template Message
    • Create a Coupon Code Template
    • Create a Limited Time Offer (LTO) Code Template
    • Create a Multi-Product Message Template
    • Create WhatsApp Catalog Message Template
  • Send a Text Template Message through WhatsApp
  • Send a Media Template Message through WhatsApp
  • Send a Text Message through WhatsApp
  • Send an Interactive WhatsApp Address Message
  • Send a Catalog Message through WhatsApp Template
  • Send an Authentication Template Message
  • Send a Coupon Code Template Message
  • Send a Limited Time Offer (LTO) Code Template Message
  • Send a Multi-Product Message Template
  • Send a Media Message through WhatsApp
  • Send WhatsApp Pay Messages
  • Preview of the URL
  • Share Contact Information
  • Send Interactive Message and Media Template
  • Monitoring Stats
  • List Message API
  • Reply Button API
  • Product Catalog Message APIs
  • Receive an incoming message and reply
  • Automate Kaleyra WhatsApp Flow
    • Add a WhatsApp Number
    • Update a WhatsApp Number Details
    • Add a WhatsApp Template
    • Configure WhatsApp Callback URL
  • WhatsApp Error Codes
    • Cloud API Error Codes
    • On-premise API Error Codes
  • WhatsApp Status

Voice APIs

  • Overview
  • Click to Call API
  • Outbound Calling API
  • Call Recording Extraction API
  • Call Log Pull API
  • Dynamic Variables for DLRURL
  • Callback Profiles in Voice APIs
  • Voice Error Codes

Email APIs

  • Overview
  • Send Single Email
  • Short URL in Email API Request for a single contact
  • Send Batch and Bulk Emails
  • Add Dynamic Values in Email API Using Params field
  • Use Templates in Email API
  • Get stats and Get logs in Email API
  • Use Webhook in Email API
  • Email Error Codes

Platform APIs

  • Overview
  • Subaccounts
    • Create a Subaccount
    • Get All Subaccounts Detail
    • Get Subaccount Details
    • Edit and Update Subaccount Details
    • Recharge a Subaccount
    • Delete a Subaccount
    • Response Codes and Statuses
  • Billing
    • Get Account Billing or Usage Details
    • Response Codes and Statuses
  • Callback Profiles
    • Create Callback Profiles
    • Get Callback Profiles Detail
    • Get a Callback Profile by ID
    • Update a Callback Profile by ID
    • Delete a Callback Profile by ID
    • Response Codes and Statuses

NUMBER APIS

  • Overview
  • List the Available Numbers for Subscriptions
  • Subscribe a Number
  • List the Subscribed Numbers
  • Unsubscribe a Number
  • Resubscribe a Number
  • Documents ID and Description for Numbers

Blocklist APIs

  • Overview
  • Get Blocklist
  • Change Blocklist Status for Number
  • Blocklist Error Codes

Lookup APIs

  • Overview
  • HLR Lookup
  • GET API Lookup
  • POST API Lookup

URL Shortener APIs

  • Overview
  • Create a URL Shortener
  • Get All URL List
  • Get an Individual URL
  • Get URL Analytics Data
  • Delete a Shortened URL
  • URL Shortener Callback

Integration Partners

  • Overview
  • LeadSquared SMS
    • Kaleyra SMS with LeadSquared
    • Generate a Webhook URL
    • LeadSquared Automation
  • LeadSquared WhatsApp
    • Kaleyra WhatsApp with LeadSquared
  • WebEngage SMS
    • Configure Kaleyra SMS on WebEngage
    • Create SMS Campaign on WebEngage
  • WebEngage WhatsApp
    • Configure Kaleyra.io WhatsApp on WebEngage
    • Add WhatsApp Templates
    • Enable WhatsApp Delivery Callback URLs in Kaleyra
    • Create WhatsApp Campaign on WebEngage
  • ORACLE Eloqua SMS
    • Configure Kaleyra on ORACLE Eloqua
    • View Kaleyra.io Configuration on ORACLE Eloqua
    • Send SMS through Campaign Canvas
    • Send SMS through Contact Program Canvas
    • Send SMS through Custom Object Program Canvas
    • Sent SMS Custom Data Object on Eloqua
    • Received SMS Custom Data Object on Eloqua
  • ORACLE Eloqua WhatsApp
    • View Kaleyra.io Configuration on ORACLE Eloqua
    • Send WhatsApp Messages
  • CleverTap SMS
    • Configure Provider for SMS
    • Launch an SMS Campaign
  • CleverTap WhatsApp
    • Configure Provider for WhatsApp
    • Enable WhatsApp Delivery Callback URLs in Kaleyra
    • Enable Incoming Message URL in Kaleyra
    • Add WhatsApp Template to CleverTap
    • Launch WhatsApp Campaign
    • View WhatsApp Campaign Report
    • WhatsApp Conversations
  • Zoho CRM SMS
    • Kaleyra SMS with Zoho CRM
    • Configure Kaleyra SMS Settings with Zoho CRM
    • Send SMS to Leads, Contacts, or Accounts
    • Send SMS using Workflow Rules
    • Send SMS Campaign to Leads or Contacts
  • Zoho Desk SMS
    • Install the Kaleyra Plugin in Zoho Desk for SMS
    • Configure Kaleyra SMS Settings with Zoho Desk
    • Configure Workflow and Trigger SMS
  • Zoho SMS Campaigns
  • Zoho WhatsApp
    • Zoho CRM: Send WhatsApp messages with Workflow Rules
      • Configure Workflow Rules and Send WhatsApp
      • View Workflow Rules Usage
  • MoEngage SMS
    • Kaleyra SMS Integration with MoEngage
    • Create SMS Callback
  • MoEngage WhatsApp
    • Kaleyra WhatsApp Integration with MoEngage
    • Create WhatsApp Provider
    • Create WhatsApp Template
    • Enable WhatsApp Delivery Callback URLs in Kaleyra
    • Launch a WhatsApp Campaign
  • Braze SMS
    • Kaleyra SMS Integration with Braze
  • Zapier
    • Integrate Kaleyra SMS with Zapier
    • Create a Zap to send an SMS
    • Create a Zap to send WhatsApp Messages
  • Shopify SMS
    • Kaleyra SMS with Shopify
    • Configure Kaleyra Settings with Shopify
    • Send SMS and Launch Campaign
    • Send SMS in Shopify Flow Automation
    • Send Automated SMS
      • Automation use case: Add Customers
      • Automation use case: Orders Workflow
      • Shopify Marketing Automations
  • Shopify WhatsApp
    • Integrate Kaleyra plugin with Shopify
    • Configure Kaleyra Setting in Shopify
    • Send WhatsApp messages to Customer or group of Customers
  • HubSpot SMS
    • Kaleyra SMS with HubSpot CRM
    • Configure Kaleyra Settings with HubSpot
    • Send SMS
    • HubSpot Automation
  • HubSpot WhatsApp
    • Install Kaleyra Plugin in HubSpot CRM for WhatsApp Messaging
    • Configure Settings for WhatsApp within HubSpot
    • Send WhatsApp Message
  • Oracle Responsys MMS
    • Integrate Kaleyra with Oracle Responsys
    • Send MMS using Oracle Responsys Programs
    • Enable MMS Delivery Reports
  • Freshchat WhatsApp Connector
    • Integrate Freshchat with Kaleyra WhatsApp
    • Send WhatsApp Messages to Freshchat

FAQs

  • FAQs
    • Video API FAQs

Release Notes

  • Release Notes
    • Core Services
    • Campaigns
    • SMS
    • WhatsApp
    • Integrations
    • Email (API and GW)
    • Messaging Solutions
    • Chatbots
    • BFSI Solutions
    • Communicate Pro
    • GFTP

Security

Suggest Edits

Updated 12 months ago





© 2025 Kaleyra Inc. All rights reserved.
Trademarks, logos and service marks displayed on this site are registered and unregistered trademarks of Kaleyra Inc.