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
Contact UsKaleyra.io Sign InSupport

Home

  • Welcome
  • Glossary
  • Support

Getting started

  • Overview
  • Kaleyra.io Interface
  • Create a Kaleyra.io Account
  • 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
    • Create an SMS Template
    • Add a TAN Number (Optional)
    • Add Credits
  • User Profile Settings
  • Account Settings
    • Notification
    • Notification - SMS Automated Reports
    • Notification - SMS Automated Performance Report
    • Notification - SMS Count Report
    • Notification - Callback Report
    • Settings
    • Team
    • Documents
  • Callback Profiles
    • Callback Encryption
    • Create SMS Callback Profiles using Dynamic Variables
    • Create Callback Profile for WhatsApp Template Status Update

SMS

  • Request an SMS Report
    • Overview
    • SMS Summary Reports
    • SMS Tabular Report
    • Automate SMS Summary Report
  • SMS Analytics - Logs
  • Uploaded Reports
  • Configure SMS Settings
    • Opt-in Settings
    • Opt-out Settings
    • Daily Limit
  • Automatic blacklisting of contacts on directory
  • Receive Message
    • Configure Receive Message
    • View Configurations and Logs

WhatsApp

  • Overview
  • Manual Signup
    • Add a Number
  • Embedded Signup
  • WhatsApp Business Messaging
  • Find your Facebook Business Manager ID
  • WhatsApp Business | Message Templates
  • Add WhatsApp Templates
  • Edit WhatsApp Template
  • Product Catalog Messages
  • Kaleyra WhatsApp API
  • WhatsApp Business Message Limit
  • Opt-in
  • WhatsApp Number Messaging Limits and Quality Rating
    • Receive Updates about Messaging Limits using Webhooks
  • WhatsApp Conversations
  • Request a WhatsApp Report
    • WhatsApp Reports

Campaigns

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

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
  • 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

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

Video

  • Overview
  • Technical Requirements
  • Environment Setup
  • Inbound Call

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

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
  • Shared Short Code

Conversations

  • Overview

Subaccounts

  • Overview
  • 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

Failover

  • Overview
  • Configuration
  • Logs

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

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

Directory

  • Overview
  • Contacts
  • Tags
  • Lookup

APIs

  • Overview

SMS APIs

  • Overview
  • Send the First SMS
  • Send OTP SMS
  • Send Bulk SMS
  • Send SMS with Unicode
  • Send Flash SMS
  • Schedule SMS API
  • SMS Status API
  • SMS Route Types
  • SMS Length and Encoding
  • SMS Callback
    • Callback Request using Callback Profiles
  • SMS URL Shortening API
  • Send SMS (JSON/XML)
  • Send SMS Over IP (SOIP)
    • Capability Check API
    • Set up Callback Profile ID
  • 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
    • Get a WhatsApp Template Status
  • Send a Text Template Message through WhatsApp
  • Send a Media Template Message through WhatsApp
  • Receive an incoming message and reply
  • Send a Text Message through WhatsApp
  • Preview of the URL
  • Send a Media Message through WhatsApp
  • Share Contact Information
  • Send Interactive Message and Media Template
  • Monitoring Stats
  • List Message API
  • Reply Button API
  • Product Catalog Message APIs
  • Automate Kaleyra WhatsApp Flow
    • WhatsApp Registration
    • Add a WhatsApp Number
    • Update a WhatsApp Number Details
    • Add a WhatsApp Template
    • Configure WhatsApp Callback
  • WhatsApp Error Codes
    • Cloud API Error Codes
    • On-premise API Error Codes

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
  • 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

Lookup APIs

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

Failover APIs

  • Failover Messages
    • Use Client Callback for Failover
    • Set up Callback Profile ID
  • Failover 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

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
    • Kaleyra SMS Integration with CleverTap
  • 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
  • MoEngage SMS
    • Kaleyra SMS Integration with MoEngage
  • 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 Automated SMS
  • HubSpot SMS
    • Kaleyra SMS with HubSpot CRM
    • Configure Kaleyra Settings with HubSpot
    • Send SMS
    • HubSpot Automation
  • Oracle Responsys MMS
    • Integrate Kaleyra with Oracle Responsys
    • Send MMS using Oracle Responsys Programs

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

Campaigns

Suggest Edits

You have the option to create and launch campaigns using Communicate Pro. To send a message, a campaign is required in Communicate Pro. Also, you can edit campaigns and delete campaigns.

The Communicate Pro campaigns include:

  • Creating Campaigns
  • Campaign Details
  • Campaign Maintenance

Updated 3 months ago





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