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
  • Understanding Kaleyra.io Interface
  • Creating an Account in Kaleyra.io
  • Onboarding onto Kaleyra
    • Completing the Know Your Customer (KYC)
    • Opt-in for Kaleyra Services
    • Creating Sender ID
    • Create Kaleyra.io API Key
    • View API Key and SID
    • Creating SMS Template
    • Adding TAN Number (Optional)
    • Adding Credits
  • User Profile Settings
  • Account Settings
    • Notification
    • Settings
    • Team
    • Documents
    • Callback Profiles

Campaigner

  • Overview
  • Launch your SMS Campaign
  • Replay Campaign
  • Request an SMS Report
    • Understanding SMS Summary Reports
    • Automate SMS Summary Report
  • Understanding SMS Analytics - Logs
  • Uploaded Reports
  • Verified SMS
  • Configuring SMS Settings
    • Opt-in Settings
    • Opt-out Settings
  • Automatic blacklisting of contacts on directory
  • Receive Message
    • Configure Receive Message
    • View Configurations and Logs

WhatsApp

  • Overview
  • Manual Signup
    • Adding Number
  • Embedded Signup
  • WhatsApp Business Messaging
  • Find your Facebook Business Manager ID
  • WhatsApp Business | Message Templates
  • Adding WhatsApp Templates
  • Product Catalog Messages
  • Kaleyra WhatsApp API
  • WhatsApp Business Message Limit
  • Opt-in
  • WhatsApp Pricing
  • Request a WhatsApp Report
    • Understanding WhatsApp Reports

Chatbot

  • Overview
  • Onboarding
  • Navigate Chatbot
  • Autoresponder
    • View Autoresponder Demo
    • Create an Autoresponder
    • Activate an Autoresponder
    • Edit an Autoresponder
  • Infobot
    • View Infobot Demo
    • Create an Infobot
    • Activate an Infobot
    • Edit Infobot's Intent
  • Databot
    • View Databot Demo
    • Create a Databot
    • Activate a Databot
    • Edit Databot's Intent
  • Enterprise Chatbot
    • View Enterprise Demo
    • Contact Us for Enterprise Chatbot
  • Understanding Chatbot Dashboard

Video

  • Overview
  • Getting Started
  • Technical Requirements
  • Environment Setup
  • Digital Signature
  • Inbound Call

Voice

  • Overview
  • Signing up with Kaleyra.io
  • Numbers
  • Adding Credits
  • Click to Call
  • Kaleyra Flow Builder
    • Dynamic Variables for FlowBuilder
  • Voice Manager
    • Sound Manager
    • Logs
    • Call Statuses
    • Reports
    • Sticky Agents
  • Generating the Report with Recording Details

Kaleyra Verify

  • Overview
  • Creating a Verify Templates
  • Creating a Verify Configuration
  • API Collection
  • Generate OTPs
  • Validate OTPs

Kaleyra Numbers

  • Overview
  • Subscribe Number
  • Number Statuses
  • Number Listing Page

Conversations

  • Overview

Subaccounts

  • Overview
  • Manage Subaccounts
    • Add Subaccount
    • View Subaccounts
    • Recharge Subaccount
    • Login to Subaccount
    • Edit Subaccount
    • Suspend 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

Kaleyra 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

Kaleyra Directory

  • Overview
  • Contacts
  • Tags
  • Lookup

Kaleyra APIs

  • Overview

SMS APIs

  • Overview
  • Send Your First SMS
  • Send OTP SMS
  • Send Bulk SMS
  • Send verified SMS
  • Send SMS with Unicode
  • Send Flash SMS
  • Schedule SMS API
  • SMS Status API
  • Understanding 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
  • URL Shortener APIs
    • Create URL Shortener
    • Get All URL List
    • Get Individual URL
    • Get URL Analytics Data
    • Delete Shortened URL
    • URL Shortener Callback
  • SMS Error Codes
  • SMS Status and Status Trace Codes

WhatsApp APIs

  • Overview
  • Send a Text Template Message through WhatsApp
  • Send a Media 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
  • Share Contact Information
  • Send Interactive Message and Media Template
  • WhatsApp Callbacks
  • Monitoring Stats
  • List Message API
  • Reply Button API
  • Product Catalog Message APIs
  • Automate your Kaleyra WhatsApp Flow
    • WhatsApp Registration
    • Add WhatsApp Number
    • Update WhatsApp Number Details
    • Add WhatsApp Template
  • WhatsApp Error Codes
    • Cloud API Error Codes
    • On-premise API Error Codes
  • WhatsApp Templates
    • Create WhatsApp Template with Text
    • Create WhatsApp Templates with Sample Media

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

Video APIs

  • Overview
  • Important Concepts
  • Integration Options
  • Authentication
  • User Registration
  • Make a Video Call with REST API
  • Make a Video Call with Web SDK
  • Customization

Lookup APIs

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

Failover APIs

  • Failover Messages

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
    • Create WhatsApp Campaign on WebEngage
  • ORACLE Eloqua SMS
    • Configure Kaleyra.io on ORACLE Eloqua
    • Login to Kaleyra.io 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
  • Braze SMS
    • Kaleyra SMS Integration with Braze
  • Zapier
    • Integrate Kaleyra account with Zapier
    • Create a Zap to send an SMS
    • Create a Zap to send WhatsApp Messages
  • Shopify SMS
    • Kaleyra with Shopify
    • Configure Kaleyra Settings with Shopify
    • Send SMS and Launch Campaign
  • HubSpot SMS
    • Kaleyra 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
    • Kaleyra.io Core Services
    • Communicate Pro
    • Kaleyra.io Campaigner
    • Kaleyra.io WhatsApp
    • GFTP

User

Suggest Edits

User Registration

In order to start testing your integration, create a few users.

For more information about user APIs and related features, see User.

Updated about 1 month ago


  • Table of Contents
    • User Registration



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