For AI agents: visit https://developers.kaleyra.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
SMS
WhatsApp
Voice
Video
API
Integration
Release Notes
FAQs
Home
Guides
API Reference
SMS
WhatsApp
Voice
Video
API
Integration
Release Notes
FAQs
Contact Us
Kaleyra.io Sign In
Support
Guides
Contact Us
Kaleyra.io Sign In
Support
Guides
Email Error Codes
Email Error Codes
Home
Welcome
Glossary
Support
Getting started
Overview
Kaleyra Platform Interface
Create a Kaleyra Platform Account
Sign In to Kaleyra Platform 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
Notifications
Low Balance Alert
SMS Automated Reports
SMS Automated Performance Report
SMS Count Report
Credit History Report
Callback Report
WhatsApp Message Based Summary Report
WhatsApp Conversation Based Summary Report
Daily Sender Wise Report
Daily Campaign Wise Report
Monthly Day Wise Summary Report
SMS Location wise
Links Detailed Report
URLs Summary Report
SMS Subaccount Blocked Countries Report
Team
Login History
Documents
Callback Profiles
Callback Encryption
Create SMS Callback Profiles using Dynamic Variables
Create Callback Profile for Incoming SMS Messages
Create WhatsApp Callback Profiles using Dynamic Variables
Create Callback Profile for Incoming WhatsApp Messages
Create Callback Profile for WhatsApp Template Status Update
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
RCS
Overview
Brands
Brands Dashboard Overview
Search Brand
Add a New Brand
Brand Details
Agents
Agent Dashboard Overview
Search and Filter Agents
Add a New Agent
Edit Agent Details
Add New Test Device
Tasks for Test Device
Send Test Message
Search Test Device
Delete a Test Device
Add Template
RCS Text Template
RCS Rich Multimedia Template
RCS Rich Card Template
RCS Rich Card Carousel Template
Test Template
View Template Details
Preview Template Details
Download Template
Template History
Edit Template Details
Send Template for Approval
Delete Template
Verify and Launch Agent
Request an RCS Report
RCS Tabular Report
RCS MT Summary Report
RCS MO Summary Report
RCS Campaign Summary Report
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
Add a new WABA ID
Add a Number
Upload Media
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 API V1 Configuration for Callback
WhatsApp API V2 Configuration for Callback
WhatsApp Templates
Create WhatsApp Marketing Template
Marketing Template - Sub-category: Default
Marketing Template - Sub-category: Order Details
Marketing Template - Sub-category: Order Status
Marketing Template - Sub-category: Carousel
Marketing Template - Sub-category: Calling Permissions Request
Create WhatsApp Authentication Template
Create WhatsApp Utility Template
Utility Template - Sub-category: Default
Utility Template - Sub-category: Order Details
Utility Template - Sub-category: Order Status
Utility Template - Sub-category: Calling Permissions Request
Edit WhatsApp Template
Email
Overview
Email 1.0
Enable Email Channel Widget
Request an Email Report
Email Reports
Email Logs
Email 2.0
Add and Manage Domain
Search and Filter Domains
Configure DNS to Domain Provider
Add Email Address
Add Dedicated IPs
Domian and Email Warmup
Create Email Templates
Email Logs
Request an Email 2.0 Report
Email 2.0 Detailed Report
Email 2.0 Summary Report
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 for V1 WABA
Launch a WhatsApp Campaign for V1 WABA
Draft WhatsApp Campaign
View WhatsApp Campaign
Request WhatsApp Campaign Report
WhatsApp Campaign for V2 WABA
Launch a WhatsApp Campaign for V2 WABA
Add Contacts by Uploading a File
Add Contacts from Directory
Copy Paste the Contacts
Launch a Drafted Campaign
Add Contacts in Batch for Campaign
Reschedule Campaign
Search and Filter WhatsApp Campaign
View WhatsApp Campaign Details
View Batch Details
Download and Regenerate Report
Delete a Campaign
Voice Campaign
Launch a Voice Campaign
Draft Voice Campaign
RCS Campaign
Campaign List
Launch an RCS Campaign
Add Contacts by Uploading a File
Add Contacts from Directory
Copy Paste the Contacts
Launch Campaign in Batches
Draft RCS Campaign
View RCS Campaign
View Batch Details
Reschedule RCS Campaign
Request an RCS Campaign Report
Directory
Overview
Blocklist
Contacts
Import Tags for your Contacts in Bulk
Tags
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
Download File with Bulk Shortened URLs
Search or Filter Files containing Bulk Shortened URLs
Bulk Upload URL Features
Delete File with Bulk Shortened URLs
Delete Files with Bulk Shortened URLs
URL Shortener in SMS
URL Shortener in WhatsApp
URL Shortener in Email
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
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
Credits Usage
View Credits Usage
Reports
View Downloaded Reports
Generate Summary Report
Download Credits History Report
Download Credits Usage 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
SMS URL Shortening API
Send SMS (JSON/XML)
SMS Callback
Callback Request using Callback Profiles
SMS Error Codes
SMS Status and Status Trace Codes
RCS APIs
Overview
RCS Messages APIs
RCS Suggestions
Send a File Message
RCS Payload Specification
Send Template Message with Static Content
Send Template Message with Dynamic Variables
Send a Plain Text Message
Send a Plain Text Message with URL
Send a Plain Text Message with URL and ChipList
Send a Plain Text Message with ChipList
Send a Rich Text Message
Send a Rich Text Message with Chiplist
Send Rich Card Standalone Message
Send a Rich Card Standalone Message with Chiplist
Send a Rich Card Standalone Message with Suggestion
Send a Rich Multimedia Text Message
Send a Rich Card Carousel Message
Send a Rich Card Carousel Message with Chiplist
Send a Rich Card Carousel Message with Suggestion
RCS Typing Indicator (Agent to User)
RCS Delivery Receipt (DR) Callback Events
RCS Mobile Originated (MO) Callback Events
RCS Mobile Originated (MO) Events
RCS Number Capability Check
Single Number Capability Check
Bulk Number Capability Check
RCS Tester APIs
Get Tester By Agent
Register Tester
RCS Management APIs
Brand APIs
Create a Brand
Get Brand Details by Brand Number
Get all Brands Detail
Update a Brand
Delete a Brand
Agent APIs
Create an Agent
Get Agent by Agent Number
Get all Agents Detail
Update an Agent
Delete an Agent
Submit an Agent Verification
Get an Agent Verification Status
Launch an Agent
Launch Carrier
Get Launch Status
Master APIs
Get an Agent's Regions
Get Masters
Get Master List
Device Lookup APIs
Single Device Lookup
Bulk Device Lookup
RCS Template APIs
RCS Create Template
RCS Update Template
RCS Get Template
RCS Delete Template
RCS Get Template History
RCS Error Codes
Messages API – Error Responses
Brand
Agent
Agent Launch
Master
Device Lookup
WhatsApp APIs
Overview
WhatsApp API V1
WhatsApp Templates API V1
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
Create a WhatsApp Template with Quick-Reply Button
WhatsApp Message API V1
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
Share Location Information
Send a Media Message through WhatsApp
Send WhatsApp Pay Messages
Preview of the URL
Share Contact Information
Send Interactive Message and Media Template
Send a Quick-reply Template with Dynamic Button Payload
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
Get Payment Status API
WhatsApp Status
WhatsApp Error Codes API V1
Cloud API Error Codes
On-premise API Error Codes
WhatsApp API V2
WhatsApp Template API V2
Create Template
Edit Template
Get Templates
Delete Template
Delete Message Templates in Bulk
Template Analytics
WhatsApp Message API V2
Send Text Messages
Send Reaction Messages
Send Media Messages
Send Location Messages
Send a Single-Product Messages
Send Multi-Product Messages
Send Catalog Messages
Send Flow Messages
Send Interactive List Messages
Send an Interactive Reply Button Message
Send Location Request Messages
Send Contacts Message
Send Template Messages
Send Reply to Messages
Send Audio Messages
Send Document Messages
Send Image Messages
Send Interactive Call-to-Action URL Button Messages
Send Sticker Messages
Send Authentication Template Messages
Send Catalogue Link Messages
Send Carousel Template Messages
Send Coupon Code Template Messages
Send Limited Time Offer Template Messages
Send Multi-Product Template Messages
Send Flow Template Messages
Send Catalog Template Messages
Send Video Messages
Send Read Receipt Messages
Send Address Messages
Upload Media Files
Send Order Details Template Message
Send Order Status Template Message
Send Interactive Order Status Message
Send Call Permission Template Message
Single Product Template Message
Product Card Carousel Template Message
WhatsApp Resumable Media API V2
Get Resumable Media
Upload Resumable Media
WhatsApp Flow API V2
Create Flow
Update Flow Metadata
Update Flow JSON
Delete Flow
Publish Flow
Deprecate Flow
Set Encryption Public Key
Get Encryption Public Key
Migrate Flow
Get Flow Details by Flow ID
Get Flows by WABA ID
Get Flow Assets by Flow ID
WhatsApp Incoming Messages Webhook Payload V2
Text Message
Image Message
Audio Message
Video and GIF Message
Document Message
Sticker Message
Reply - Text Message
Reply - Media Message
Reaction Message (Reacted to some message)
Media Message with Caption
Current Location Message
Address Location Message
Contact Message
Imagine Message
Avatar Message
Interactive- Button Reply Message
Interactive- Button Reply Image Message
Interactive- Button Reply Video Message
Interactive- Button Reply Document Message
Interactive- List Reply Message
Interactive- Address Message
Interactive- Template Message
Interactive- Catalogue Message
Interactive- Location Request Message
Carousel
WhatsApp Status Update Webhook Payload V2
Sent
Delivered
Read
Failed
Not Sent - Number Opted Out
Not Sent - Daily Limit Reached
Not Sent - To Number or Type Missing
Not Sent - Template details Not found
Not Sent - Country traffic blocked
Not Sent - Missing slug value for URL tracking
Submit - Success
Submit - Success (for typing indicator and read receipts)
Submit - Failure
WhatsApp Payment API V2
WhatsApp Payments Webhook
WhatsApp Voice Call Permission API V2
Get Call Consent Status
WhatsApp Phone Number API
Add Phone Number
Verify Phone Number
Retry OTP for Phone Number
Get Phone Number Details
Update Phone Number Details
WhatsApp Group Management API
WhatsApp Error Codes API V2
WhatsApp V2 Error Codes for Send Message APIs
WhatsApp V2 Error Codes for Template APIs
WhatsApp Block Users API
Block WhatsApp User Numbers
Unblock WhatsApp User Numbers
Get List of Blocked WhatsApp User Numbers
Fetch Phone Number Details API
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 V1
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
Email APIS V2
Overview
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
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
Consent Management APIs
Overview
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
Genesys SMS
Sample Trigger URL Data for Genesys
Finalizing Onboarding
View Integrated Setup in Genesys Cloud
Launch Two-way MO Messaging
Data Actions Integration for Non-conversational or One-way conversation
View Conversation History
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
Customer Plane
GFTP
Email Error Codes
Email error codes and messages for email APIs.
Copy Page
