The Kaleyra connector lets your AI agent act in each user's Kaleyra account. Each user connects their own Kaleyra API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 25 · 25 · 1025 read25 write10 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Kaleyra connection
In AgentKit > Connections, create a Kaleyra connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'kaleyra'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Kaleyra:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'kaleyra_balance_get',toolInput: { sid: 'YOUR_SID' },})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "kaleyra"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Kaleyra:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={"sid":"YOUR_SID"},tool_name="kaleyra_balance_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Kaleyra credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolkaleyra_balance_getGet your Kaleyra account's balance and usage details.Read-onlyGet Account Balance
Get your Kaleyra account's balance and usage details. Returns the current balance and currency. Use this before large sends.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_blocklist_getList numbers on your account's blocklist for SMS, WhatsApp or voice.Read-onlyList Blocklisted Numbers
List numbers on your account's blocklist for SMS, WhatsApp or voice. Returns blocklisted numbers with their channel and status, up to 100 per page. Use this to see which numbers your account will not message.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
channelstring- Channel to list. Example: smsone of
smswhatsappvoice limitinteger- Numbers per page, up to 100. Example: 100
offsetinteger- Numbers to skip. Example: 0
kaleyra_consent_listList consent records for a channel, filtered by status, dates, category, sender or contact.Read-onlyList Consent Records
List consent records for a channel, filtered by status, dates, category, sender or contact. Returns consent records with paging. Use this for audits and exports. Use kaleyra_consent_validate for a quick check on specific numbers.
Inputs
channelstringrequired- Channel, for example sms. Example: sms
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
consent_categorystring- Message category. Example: Marketing
contact_identifierstring- Customer's mobile number. Example: 919812345678
from_datestring- Start date, YYYY-MM-DD. Example: 2026-10-01
limitinteger- Records per page. Example: 50
pageinteger- Page number. Example: 1
sender_identifierstring- Sender ID. Example: KLRHXA
sort_bystring- Field to sort by, for example created_at. Example: created_at
sort_orderstring- Sort direction. Example: descone of
ascdesc statusinteger- -1 not found, 0 opted out, 1 opted in, 2 deactivated. Example: 1one of
-1012 to_datestring- End date, YYYY-MM-DD. Example: 2026-11-13
kaleyra_consent_validateCheck the current consent status of one or more mobile numbers for a channel and sender ID.Read-onlyCheck Consent
Check the current consent status of one or more mobile numbers for a channel and sender ID. Returns each number's status: opted in, opted out, deactivated or not found. Use this before sending marketing messages. It changes nothing.
Inputs
channelstringrequired- Channel, for example sms. Example: sms
contact_identifiersarrayrequired- Mobile numbers to check. Example: ["919812345678"]
sender_identifierstringrequired- Sender ID or short code. Example: KLRHXA
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
consent_categorystring- Category to check. Defaults to all. Example: Marketing
consent_topicstring- Topic to check. Defaults to all. Example: Offers
kaleyra_rcs_capability_checkCheck whether one phone number can receive RCS messages.Read-onlyCheck RCS Capability
Check whether one phone number can receive RCS messages. Returns the number's RCS capability. Use this before kaleyra_rcs_message_send. It sends nothing.
Inputs
device_addressstringrequired- Phone number in E.164 format with the country code and no plus sign. Example: 919812345678
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_rcs_template_getGet one RCS template with its content and status.Read-onlyGet RCS Template
Get one RCS template with its content and status. Returns the template. Use this to check approval status. Use kaleyra_rcs_template_history_get for its change history.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
template_idstringrequired- RCS template ID. Example: 3a7370e5-ebcd-4fc3-95cc-6d1234567e8e
kaleyra_rcs_template_history_getGet the change and status history of an RCS template.Read-onlyGet RCS Template History
Get the change and status history of an RCS template. Returns the history entries. Use this to see why a template was rejected or when it changed.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
template_idstringrequired- RCS template ID. Example: 3a7370e5-ebcd-4fc3-95cc-6d1234567e8e
kaleyra_sender_ids_listList the SMS sender IDs on your Kaleyra account.Read-onlyList Sender IDs
List the SMS sender IDs on your Kaleyra account. Returns sender IDs with description, country and status. Use this to pick a sender for kaleyra_sms_send.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_sms_logs_listList the SMS logs of your Kaleyra account.Read-onlyList SMS Logs
List the SMS logs of your Kaleyra account. Returns recent messages with recipient, sender, status and timestamps. Use this to browse sent SMS. Use kaleyra_sms_status_get for specific message IDs.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_sms_status_getGet the delivery status of sent SMS messages by message ID.Read-onlyGet SMS Status
Get the delivery status of sent SMS messages by message ID. Returns each message's status (Delivered, UnDelivered, NotSent or Sent) and status details. Use this after kaleyra_sms_send. Use kaleyra_sms_logs_list to browse all recent SMS.
Inputs
message_idsstringrequired- Message ID returned by kaleyra_sms_send; separate several with commas. Example: ee8a1234-5678-90ab-cdef-9b7171234d30:1
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_sms_templates_listList the SMS templates registered on your Kaleyra account.Read-onlyList SMS Templates
List the SMS templates registered on your Kaleyra account. Returns templates with their IDs, content and sender IDs. Use this to find a template_id for kaleyra_sms_send.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_voice_call_logs_listList voice call logs from the last 7 days, filtered by status, call ID, time or bridge number.Read-onlyList Voice Call Logs
List voice call logs from the last 7 days, filtered by status, call ID, time or bridge number. Returns calls with type, numbers, start time, bridge, status, duration and credits. Use this to check call outcomes and find recording IDs.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
bridgestring- Only calls through this DID number. Example: 13235550000
call_idstring- Call IDs, comma-separated. Example: 75a1b2c3-d4e5-f6a7-b8c9-d0e1f2a3b4c5-1
end_timestring- Up to this time, Y-m-dTH:i:sP. Example: 2026-11-13T23:59:59+05:30
limitinteger- Records per call. Defaults to 25. Sent as a header, as documented. Example: 25
offsetinteger- Records to skip. Example: 0
pageinteger- Page number. Example: 1
start_timestring- From this time (within the last 7 days), Y-m-dTH:i:sP. Example: 2026-11-10T00:00:00+05:30
statusstring- Call statuses, comma-separated, for example ANSWER or NOANSWER. Example: ANSWER
kaleyra_voice_recording_link_getGet a signed, time-limited link to a call recording.Read-onlyGet Voice Recording Link
Get a signed, time-limited link to a call recording. Returns a JSON object with the recording link. Use this with a recording ID from Kaleyra's detailed voice report.
Inputs
idstringrequired- Recording ID from the detailed voice report. Example: 1abcd2345efgh6789giu587==
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
validityinteger- Minutes the link stays valid. Defaults to 5. Example: 10
kaleyra_whatsapp_blocked_users_listList the WhatsApp users blocked on your business number.Read-onlyList Blocked WhatsApp Users
List the WhatsApp users blocked on your business number. Returns the blocked users. Use this to audit blocks.
Inputs
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_call_permissions_getCheck whether customers have given your WhatsApp Business numbers permission to call them.Read-onlyGet WhatsApp Call Permissions
Check whether customers have given your WhatsApp Business numbers permission to call them. Returns the call consent status for each business number and user pair. Use this before placing WhatsApp calls.
Inputs
business_phone_numberstringrequired- Your WhatsApp Business numbers, comma-separated, E.164. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
user_phone_numberstringrequired- Customer numbers, comma-separated, E.164. Example: +919812345678
limitinteger- Records to return. Example: 25
offsetinteger- Records to skip. Example: 0
kaleyra_whatsapp_flow_getGet one WhatsApp Flow's details: validation errors, JSON and data API versions, endpoint, health status and preview.Read-onlyGet WhatsApp Flow
Get one WhatsApp Flow's details: validation errors, JSON and data API versions, endpoint, health status and preview. Returns the flow's details. Use this to check whether a flow can be published.
Inputs
flow_idstringrequired- WhatsApp Flow ID. Example: 1157612345678900
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
fieldsstring- Comma-separated fields to return, for example validation_errors,json_version,endpoint_uri,health_status. Example: validation_errors,json_version
kaleyra_whatsapp_flows_listList the WhatsApp Flows of a WhatsApp Business Account.Read-onlyList WhatsApp Flows
List the WhatsApp Flows of a WhatsApp Business Account. Returns flows with ID, name, status, categories and validation errors. Use this to find a flow ID. Use kaleyra_whatsapp_flow_get for one flow's details.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
fieldsstring- Comma-separated fields to return: id, name, status, categories, validation_errors. Example: id,name,status
kaleyra_whatsapp_group_join_requests_listList pending requests to join a WhatsApp group.Read-onlyList WhatsApp Group Join Requests
List pending requests to join a WhatsApp group. Returns join requests with their IDs and requester numbers. Use this before kaleyra_whatsapp_group_join_requests_accept or _reject.
Inputs
group_idstringrequired- WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_groups_listList the WhatsApp groups of your business number, or get one group with its participants.Read-onlyList WhatsApp Groups
List the WhatsApp groups of your business number, or get one group with its participants. Returns groups with ID, subject, status, invite link and participants. Use this to find group IDs and members.
Inputs
from_numberstringrequired- WhatsApp Business number in 91xxxxxxxxxx format. Example: 919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
all_participantsboolean- true to include inactive participants as well. Example: false
group_idstring- Only return this group. Example: 120363025246125486@g.us
limitinteger- Groups to return. Defaults to 25. Example: 25
offsetinteger- Groups to skip. Example: 0
statusstring- Only groups with this status. Example: activeone of
activesuspendeddeleted
kaleyra_whatsapp_payment_getGet the status and transaction details of a payment for an order sent in a WhatsApp order_details message.Read-onlyGet WhatsApp Payment Status
Get the status and transaction details of a payment for an order sent in a WhatsApp order_details message. Returns the payment status and transaction details. Use this to confirm a WhatsApp Pay order was paid.
Inputs
payment_config_idstringrequired- Payment configuration used for the order. Example: acme-razorpay
phone_numberstringrequired- Customer's phone number in E.164 format with country code. Example: +918123455920
reference_idstringrequired- Your unique, case-sensitive order or invoice reference. Example: ORD-1042
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_phone_number_getGet one WhatsApp Business phone number's details, such as quality rating, messaging limit and verified name.Read-onlyGet WhatsApp Phone Number Details
Get one WhatsApp Business phone number's details, such as quality rating, messaging limit and verified name. Returns the number's details. Use this to check a number's health before large sends.
Inputs
business_phone_numberstringrequired- WhatsApp Business phone number with country code. Example: 919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_phone_numbers_listList the WhatsApp Business phone numbers of a WhatsApp Business Account, filtered by name, status, number or voice status.Read-onlyList WhatsApp Phone Numbers
List the WhatsApp Business phone numbers of a WhatsApp Business Account, filtered by name, status, number or voice status. Returns numbers with status, profile details, callback profiles and voice-calling flag. Use this to find your sending numbers. Use kaleyra_whatsapp_phone_number_get for one number's Meta details.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
limitinteger- Numbers to return. Defaults to 25. Example: 25
namestring- Only numbers with this display name. Example: Acme Support
offsetinteger- Numbers to skip. Defaults to 0. Example: 0
phone_numberstring- Only this number, with country code. Example: +919876543210
statusstring- Only numbers with this status. Example: APPROVEDone of
APPROVEDPENDINGREJECTED voice_statusstring- Only numbers with WhatsApp calling in this state. Example: Enabledone of
EnabledDisabled
kaleyra_whatsapp_pricing_analytics_getGet daily WhatsApp conversation pricing analytics for a WhatsApp Business Account over a time range.Read-onlyGet WhatsApp Pricing Analytics
Get daily WhatsApp conversation pricing analytics for a WhatsApp Business Account over a time range. Returns cost and volume data points per day. Use this to track WhatsApp spend. Use kaleyra_balance_get for the account balance.
Inputs
endstringrequired- End of the range as a UTC timestamp. Example: 1763078400
granularitystringrequired- Granularity; only DAILY is supported. Example: DAILYone of
DAILYdefaultDAILY sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
startstringrequired- Start of the range as a UTC timestamp. Example: 1761955200
waba_idstringrequired- WhatsApp Business Account ID. Example: 109012345678901
kaleyra_whatsapp_template_analytics_getGet daily sent, delivered, read, clicked and replied counts for up to 10 WhatsApp templates over a date range.Read-onlyGet WhatsApp Template Analytics
Get daily sent, delivered, read, clicked and replied counts for up to 10 WhatsApp templates over a date range. Returns data points per template and day with paging. Use this to compare template performance. Use kaleyra_whatsapp_pricing_analytics_get for costs.
Inputs
end_datestringrequired- End date, YYYY-MM-DD. Example: 2026-11-13
granularitystringrequired- Granularity; only DAILY is supported. Example: DAILYone of
DAILYdefaultDAILY sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
start_datestringrequired- Start date, YYYY-MM-DD. Example: 2026-11-01
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
whatsapp_template_idsstringrequired- Up to 10 WhatsApp template IDs, comma-separated. Example: 1317123456789067,1561234567890011
afterstring- Paging cursor from the previous response. Example: MjQZD
limitinteger- Template entries to return. Example: 10
metric_typesstring- Metrics to return, comma-separated: SENT, DELIVERED, READ, CLICKED, REPLIED. Defaults to all. Example: SENT,DELIVERED,READ
product_typestring- Product to report on. Defaults to CLOUD_API. Example: CLOUD_APIone of
CLOUD_APIMARKETING_MESSAGES_LITE_API
kaleyra_whatsapp_templates_listList the WhatsApp message templates of a WhatsApp Business Account, filtered by name, ID, status or category.Read-onlyList WhatsApp Templates
List the WhatsApp message templates of a WhatsApp Business Account, filtered by name, ID, status or category. Returns templates with name, language, status, category, components and whatsapp_template_id. Use this to find templates to send or edit.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
categorystring- Only return templates in these categories, comma-separated: MARKETING, UTILITY, AUTHENTICATION. Example: UTILITY
fieldsstring- Comma-separated fields to return, for example name,language,status,category,components,whatsapp_template_id. Example: name,status,category
limitinteger- Templates to return. Defaults to 25. Example: 25
namestring- Only return the template with this name. Example: order_shipped
offsetinteger- Templates to skip. Defaults to 0. Example: 0
statusstring- Only return templates with these statuses, comma-separated: APPROVED, PENDING, REJECTED, PAUSED, DISABLED. Example: APPROVED
whatsapp_template_idstring- Only return the template with this WhatsApp template ID. Example: 1317123456789067
kaleyra_consent_updateRecord a customer's opt-in or opt-out for a channel and sender ID.WriteUpdate Consent
Record a customer's opt-in or opt-out for a channel and sender ID. Returns the consent update result. Use this to keep consent in sync with your systems. Use kaleyra_consent_validate to check consent before sending.
Inputs
channelstringrequired- Channel, for example sms or whatsapp. Example: sms
consent_statusstringrequired- New consent status. Example: OPT_INone of
OPT_INOPT_OUT contact_identifierstringrequired- Customer's mobile number. Example: 919812345678
sender_identifierstringrequired- Sender ID or short code the consent applies to. Example: KLRHXA
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
sourcestringrequired- Where the consent came from, for example API. Example: API
consent_categorystring- Message category, for example Marketing, Transactional or Promotional. Example: Marketing
consent_topicstring- Topic, for example Offers, Loan or Insurance. Example: Offers
inbound_message_identifierstring- Sender ID the customer's opt-in or opt-out message was sent to. Example: KLRHXA
request_identifierstring- Unique ID of your request. Example: req-7f3a
source_identifierstring- ID of the source request, for example the MO message ID. Example: MO_12345
timestampstring- When the consent was given, YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T10:30:00
x_callback_urlstring- URL that receives processing updates. Example: https://api.acme.com/kaleyra/consent
kaleyra_rcs_message_sendSend an RCS message from your RCS agent to up to 100 numbers: plain text, text with suggestion chips, a file, a rich card, a carousel, or an approved template.WriteSend RCS Message
Send an RCS message from your RCS agent to up to 100 numbers: plain text, text with suggestion chips, a file, a rich card, a carousel, or an approved template. Returns a message ID for each recipient. Use this for RCS. Use kaleyra_rcs_capability_check first to see which numbers can receive RCS.
Inputs
contentobjectrequired- Message content, merged into the request: text (with optional suggestions); file; richCardStandalone (cardOrientation and content with title, description, media and suggestions); richCardCarousel (cardWidth and cardContents); or templateId with messageParams for a template. Example: {"text": "Your order ORD-1042 has shipped."}
fromstringrequired- Your RCS agent's service code. Example: rcs-acme-IN
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
toarrayrequired- Recipient numbers with country code and no plus sign (up to 100). Example: ["919812345678"]
refstring- Your reference for this message. Example: order-1042
ttl_secondsstring- Seconds before an undelivered message expires. Example: 3600
kaleyra_rcs_template_createCreate an RCS template (text, file, rich card or carousel) under an RCS agent.WriteCreate RCS Template
Create an RCS template (text, file, rich card or carousel) under an RCS agent. Returns the new template ID and status. Use this for reusable RCS messages; send with kaleyra_rcs_message_send using templateId.
Inputs
agent_numberstringrequired- Agent number the template belongs to. Example: 48400
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
statusstringrequired- Initial status, usually DRAFT or SUBMITTEDFORAPPROVAL. Example: DRAFTone of
DRAFTCREATEDSUBMITTEDFORAPPROVAL template_namestringrequired- Unique name, up to 20 letters, digits or underscores. Example: order_update
template_typestringrequired- 1 text, 3 file, 4 rich card, 5 carousel. Example: 1one of
1345 content_messageobject- Suggestions (reply and action chips) for the template. Example: {"suggestions": [{"reply": {"text": "Track", "postback_data": "track"}}]}
fileobject- File for file templates: file_url, thumbnail_url, content_description. Example: {"file_url": "https://acme.com/brochure.pdf"}
rich_card_carouselobject- Carousel: card_width and card_contents (title, description, media, suggestions per card). Example: {"card_width": "MEDIUM", "card_contents": [{"title": "Shoes", "description": "From 999"}]}
rich_card_standaloneobject- Rich card: card_orientation, thumbnail_image_alignment and content with title, description, media and suggestions. Example: {"card_orientation": "VERTICAL", "content": {"title": "Diwali sale", "description": "Up to 50% off"}}
textstring- Message text for text templates, up to 2000 characters. Example: Hi {name}, your order has shipped.
kaleyra_rcs_template_updateUpdate the text of an RCS template that is still in DRAFT or CREATED status, or submit it for approval by changing its status.WriteUpdate RCS Template
Update the text of an RCS template that is still in DRAFT or CREATED status, or submit it for approval by changing its status. Returns the updated template. Use this before the template is approved. Get template_number and the current values from kaleyra_rcs_template_get.
- Idempotent
Inputs
agent_numberstringrequired- Agent number the template belongs to. Example: 48400
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
statusstringrequired- Status to set; SUBMITTEDFORAPPROVAL sends it to the carrier. Example: SUBMITTEDFORAPPROVALone of
DRAFTCREATEDSUBMITTEDFORAPPROVAL template_idstringrequired- RCS template ID. Example: 3a7370e5-ebcd-4fc3-95cc-6d1234567e8e
template_namestringrequired- Template name (cannot be changed after creation). Example: order_update
template_numberstringrequired- The template's reference number from kaleyra_rcs_template_get; it cannot be changed. Example: MN6123456789
template_typestringrequired- 1 text, 3 file, 4 rich card, 5 carousel. Example: 1one of
1345 textstring- New message text for text templates. Example: Hi {name}, your order is out for delivery.
kaleyra_sender_ids_createRegister one or more SMS sender IDs for approval.WriteCreate Sender IDs
Register one or more SMS sender IDs for approval. Returns the created sender IDs and their status. Use this to add a new sender. In India the sender must also be registered on DLT, with its entity_id.
Inputs
dataarrayrequired- Sender IDs to create: each has the sender, a description, the iso_code of the country and, in India, the DLT entity_id. Example: [{"sender": "ACMEIN", "description": "Acme order updates", "iso_code": "in", "entity_id": "1201161234567890123"}]
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_sms_sendSend an SMS from an approved sender ID to one or more numbers, as free text or a registered template with variables, optionally scheduled or as flash SMS.WriteSend SMS
Send an SMS from an approved sender ID to one or more numbers, as free text or a registered template with variables, optionally scheduled or as flash SMS. Returns message IDs per recipient, which you pass to kaleyra_sms_status_get. Use this for SMS. Indian customers must use a DLT template_id; use kaleyra_verify_otp_send for OTP flows Kaleyra should generate and check.
Inputs
bodystringrequired- Message text. Kaleyra requires it even when a template_id is given. Example: Your order ORD-1042 has shipped.
senderstringrequired- Approved alphanumeric sender ID shown to recipients. Example: KLRHXA
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
tostringrequired- Recipient phone number in E.164 format with country code; separate several numbers with commas. Example: +919876543210
callback_profile_idstring- Callback profile that receives delivery status webhooks. Example: IN_09b3dfa7-e05d-4d84-ab2d-6ed654272abc
flashstring- 1 to send as a flash SMS. Example: 0one of
01 prefixstring- Country code to prepend to numbers that lack one. Example: +91
ref_customarray- Up to 5 custom values (50 characters each) shown in reports and callbacks. Example: ["campaign-diwali"]
template_dataobject- Values for the template's placeholders, keyed by placeholder name. Example: {"name": "John", "order_id": "ORD-1042"}
template_idstring- Registered template ID (12 to 30 digits; mandatory in India). Example: 1107161234567890123
timestring- Schedule time in ISO format YYYY-MM-DDTHH:MM:SS+HH:MM. Leave empty to send now. Example: 2026-11-20T10:30:00+05:30
typestring- Route type. India: OTP, TXN (transactional), TXND (transactional DND) or MKT (marketing). Other regions: OTP or DEFAULT. Example: TXNone of
OTPTXNTXNDMKTDEFAULT unicodestring- Encoding: 1 for unicode text, 0 for plain, Auto to detect. Example: Autoone of
Auto01
kaleyra_verify_otp_sendGenerate an OTP and send it to a mobile number (and optionally an email) using a Kaleyra Verify configuration.WriteSend Verification OTP
Generate an OTP and send it to a mobile number (and optionally an email) using a Kaleyra Verify configuration. Returns a verify_id to pass to kaleyra_verify_otp_validate. Use this for login and signup verification; Kaleyra handles channels, expiry and retries per the configuration.
Inputs
mobilestringrequired- Recipient phone number in E.164 format with country code; separate several with commas. Example: +919812345678
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
emailstring- Email address to also send the OTP to. Example: john@example.com
flow_idstring- Verify configuration ID. Optional when a configuration is set as default. Example: d9901234-6946-4b12-ac18-51c123452344a
kaleyra_verify_otp_validateCheck the OTP a user entered against a Kaleyra Verify request.WriteValidate Verification OTP
Check the OTP a user entered against a Kaleyra Verify request. Returns OTP verified successfully, or an error such as expired, invalid, already verified or too many attempts. Use this when the user submits the code from kaleyra_verify_otp_send.
Inputs
otpstringrequired- Code the user entered. Example: 482913
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
verify_idstringrequired- verify_id from kaleyra_verify_otp_send. Example: 4d3d1234-80ab-43cd-be12-5815ce0795a1
kaleyra_voice_click_to_callCall a first number, then a second, and bridge them through your Kaleyra DID number.WriteStart Click-to-Call
Call a first number, then a second, and bridge them through your Kaleyra DID number. Returns the call request ID. Use this to connect an agent with a customer. Use kaleyra_voice_outbound_call to play a message.
Inputs
fromstringrequired- First number to call, with country code. Example: 13235551234
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
tostringrequired- Second number to call, with country code. Example: 13235555678
bridgestring- Your active DID number used for the call. Example: 13235550000
callbackstring- Callback profile IDs or URLs, as JSON text. Example: {"profile_id":"IN_09b3dfa7-e05d-4d84-ab2d-6ed654272abc"}
dlrurlstring- URL that receives call details. Example: https://api.acme.com/kaleyra/voice-dlr
prefixstring- Country code to prepend when missing, 1 to 4 digits. Example: 1
retrystring- Retries if the call fails (0 to 2), or JSON with count and statuses. Example: 1
timestring- Schedule time, Y-m-dTH:i:sP, at least 15 minutes ahead. Example: 2026-11-20T10:30:00+05:30
kaleyra_voice_outbound_callCall up to 100 numbers and play text-to-speech, a recorded sound or a Flow Builder flow, now or at a scheduled time.WriteMake Outbound Voice Call
Call up to 100 numbers and play text-to-speech, a recorded sound or a Flow Builder flow, now or at a scheduled time. Returns the call request ID; outcomes arrive on the DLR URL or callback and in kaleyra_voice_call_logs_list. Use this for voice notifications and OTPs. Use kaleyra_voice_click_to_call to connect two people.
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
targetstringrequired- What to play, as JSON text: a Flow Builder flow ID, a Sound Manager sound ID, or text with a speech rate and language, or a combination, as described in Kaleyra's Outbound Calling API. Example: [{"message":{"text":"Your order has shipped","speech_rate":1,"language":"en"}}]
tostringrequired- Number(s) to call with country code; separate up to 100 with commas. Example: +919812345678
bridgestring- Your active DID number used as caller ID, with country code. Example: +918071234567
callbackstring- Callback profile IDs or URLs, as JSON text. Example: {"profile_id":"IN_09b3dfa7-e05d-4d84-ab2d-6ed654272abc"}
customstring- Your own reference ID, up to 100 characters. Example: order-1042
delayinteger- Seconds to wait before calling, 0 to 900. Example: 0
dlrurlstring- URL that receives call details when the call ends. Example: https://api.acme.com/kaleyra/voice-dlr
intervalinteger- Seconds between retries, 15 to 60. Example: 30
prefixstring- Country code to prepend to to and bridge when missing. Example: +91
retrystring- Retries if the call fails (0 to 2), or JSON with count and statuses. Example: 1
timestring- Schedule time, Y-m-dTH:i:sP, 15 minutes to 90 days ahead. Example: 2026-11-20T10:30:00+05:30
timeoutstring- Call timeout in seconds (30 to 172800), or JSON with a schedule window. Example: 60
kaleyra_whatsapp_flow_createCreate a draft WhatsApp Flow on a WhatsApp Business Account.WriteCreate WhatsApp Flow
Create a draft WhatsApp Flow on a WhatsApp Business Account. Returns the new flow ID. Use this to start a flow; build its screens in Meta's Flow builder, then publish it with kaleyra_whatsapp_flow_publish.
Inputs
categoriesarrayrequired- Flow categories, for example SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, SURVEY or OTHER. Example: ["APPOINTMENT_BOOKING"]
namestringrequired- Flow name (not shown to users). Example: Appointment booking
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
endpoint_uristring- Your endpoint that WhatsApp calls for the flow's data exchange. Example: https://api.acme.com/whatsapp/flows
kaleyra_whatsapp_flow_publishPublish a draft WhatsApp Flow so it can be sent to customers; a published flow can no longer be edited.WritePublish WhatsApp Flow
Publish a draft WhatsApp Flow so it can be sent to customers; a published flow can no longer be edited. Returns the publish status. Use this after kaleyra_whatsapp_flow_get shows no validation errors.
Inputs
flow_idstringrequired- WhatsApp Flow ID. Example: 1157612345678900
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_group_createCreate a WhatsApp group under your business number.WriteCreate WhatsApp Group
Create a WhatsApp group under your business number. Returns the new group's ID and invite link. Use this to start a group; invite people with kaleyra_whatsapp_group_invite_send.
Inputs
descriptionstringrequired- Group description. Example: Early access to offers
from_numberstringrequired- WhatsApp Business number in 91xxxxxxxxxx format. Example: 919876543210
join_approval_modestringrequired- Whether people joining by link need approval. Example: approval_requiredone of
auto_approveapproval_required sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
subjectstringrequired- Group name. Example: Acme VIP customers
kaleyra_whatsapp_group_invite_link_resetReset a WhatsApp group's invite link so the old one stops working.WriteReset WhatsApp Group Invite Link
Reset a WhatsApp group's invite link so the old one stops working. Returns the new invite link. Use this when a link has leaked.
Inputs
group_idstringrequired- WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_group_invite_sendSend a WhatsApp user an invitation to join a group, using an approved template that carries the invite.WriteSend WhatsApp Group Invite
Send a WhatsApp user an invitation to join a group, using an approved template that carries the invite. Returns the request status. Use this to grow a group created with kaleyra_whatsapp_group_create.
Inputs
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
templateobjectrequired- Approved invite template: name, language with code, and components (header, body, button parameters). Example: {"name": "group_invite", "language": {"code": "en"}, "components": [{"type": "body", "parameters": [{"type": "text", "text": "Acme VIP"}]}]}
tostringrequired- User to invite, phone number in E.164 format with country code. Example: +919812345678
extra_infoobject- Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}
kaleyra_whatsapp_group_join_requests_acceptApprove pending requests to join a WhatsApp group.WriteAccept WhatsApp Group Join Requests
Approve pending requests to join a WhatsApp group. Returns the result per request. Use this after kaleyra_whatsapp_group_join_requests_list.
Inputs
group_idstringrequired- WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
join_requestsarrayrequired- Join request IDs to approve. Example: ["MTIwMzYzMDI1MjQ2"]
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_group_message_pinPin a message in a WhatsApp group for a number of days, or unpin it.WritePin or Unpin WhatsApp Group Message
Pin a message in a WhatsApp group for a number of days, or unpin it. Returns the request status. Use this to keep an announcement at the top of a group.
Inputs
actionstringrequired- pin or unpin. Example: pinone of
pinunpin group_idstringrequired- WhatsApp group ID. Example: 120363025246125486@g.us
message_idstringrequired- ID of the group message. Example: wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTE=
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
expiration_daysinteger- Days to keep the pin (required to pin). Example: 7
kaleyra_whatsapp_group_message_sendSend a text or approved template message to a WhatsApp group from your business number.WriteSend WhatsApp Group Message
Send a text or approved template message to a WhatsApp group from your business number. Returns the request status with the message ID. Use this to post in groups you created. Use kaleyra_whatsapp_group_message_pin to pin it.
Inputs
group_idstringrequired- WhatsApp group ID. Example: 120363025246125486@g.us
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
typestringrequired- Message type. Example: textone of
texttemplate extra_infoobject- Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}
templateobject- Approved template (when type is template): name, language with code, and components. Example: {"name": "event_reminder", "language": {"code": "en"}, "components": []}
textstring- Message text (when type is text). Example: Doors open at 10 AM tomorrow.
kaleyra_whatsapp_message_mark_readMark an incoming WhatsApp message as read, which shows blue ticks to the customer.WriteMark WhatsApp Message Read
Mark an incoming WhatsApp message as read, which shows blue ticks to the customer. Returns the request status. Use this after processing an inbound message.
Inputs
message_idstringrequired- WhatsApp message ID of the incoming message. Example: wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTE=
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
extra_infoobject- Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}
kaleyra_whatsapp_message_sendSend any WhatsApp Cloud API message type from your business number: image, video, audio, document, sticker, location, contacts, reaction, interactive (buttons, list, CTA URL, flow, product, location request) or a direct-send utility message.WriteSend WhatsApp Message
Send any WhatsApp Cloud API message type from your business number: image, video, audio, document, sticker, location, contacts, reaction, interactive (buttons, list, CTA URL, flow, product, location request) or a direct-send utility message. Returns the request status with the WhatsApp message ID. Use this for message types other than plain text and templates. Use kaleyra_whatsapp_text_message_send or kaleyra_whatsapp_template_message_send for those.
Inputs
messaging_objectobjectrequired- The message in Meta's Cloud API format: to (recipient number), type, and the object named after the type (for example image with a link and caption, or interactive with type, body and action). messaging_product whatsapp and recipient_type individual are added when missing. Example: {"to": "+919812345678", "type": "image", "image": {"link": "https://acme.com/banner.jpg", "caption": "New arrivals"}}
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
extra_infoobject- Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}
kaleyra_whatsapp_template_createCreate a WhatsApp message template on a WhatsApp Business Account and submit it to Meta for approval.WriteCreate WhatsApp Template
Create a WhatsApp message template on a WhatsApp Business Account and submit it to Meta for approval. Returns the new template's ID and status. Use this to add a template; check approval with kaleyra_whatsapp_templates_list.
Inputs
categorystringrequired- Template category. Example: UTILITYone of
MARKETINGUTILITYAUTHENTICATION componentsarrayrequired- Template parts in Meta's format: optional HEADER (format TEXT, IMAGE, VIDEO, DOCUMENT or LOCATION), a BODY with text, optional FOOTER, and BUTTONS (QUICK_REPLY, PHONE_NUMBER or URL). Parts with variables need an example with sample values. Example: [{"type": "BODY", "text": "Hi {{1}}, your order {{2}} has shipped.", "example": {"body_text": [["John", "ORD-1042"]]}}]
languagestringrequired- Template language code. Example: en_US
namestringrequired- Template name: lowercase letters, numbers and underscores. Example: order_shipped
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
message_send_ttl_secondsinteger- Delivery time-to-live in seconds: 30 to 900 for authentication, 30 to 43200 for utility templates. Example: 3600
kaleyra_whatsapp_template_message_sendSend an approved WhatsApp template message from your business number, with header, body and button parameters.WriteSend WhatsApp Template Message
Send an approved WhatsApp template message from your business number, with header, body and button parameters. Returns the request status with the WhatsApp message ID. Use this to start conversations. Use kaleyra_whatsapp_templates_list to find template names and languages.
Inputs
language_codestringrequired- Template language code. Example: en
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
template_namestringrequired- Approved template name. Example: order_shipped
tostringrequired- Recipient's WhatsApp phone number in E.164 format with country code. Example: +919812345678
componentsarray- Template parameters in Meta's format: a list of header, body and button components, each with its parameters (text, image, document, video, currency or date_time values). Example: [{"type": "body", "parameters": [{"type": "text", "text": "John"}, {"type": "text", "text": "ORD-1042"}]}]
extra_infoobject- Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}
kaleyra_whatsapp_template_updateEdit a WhatsApp template's category or components; the change is sent to Meta for review.WriteEdit WhatsApp Template
Edit a WhatsApp template's category or components; the change is sent to Meta for review. Returns the update status. Use this to fix or recategorise a template. Get the template ID from kaleyra_whatsapp_templates_list.
- Idempotent
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
template_idstringrequired- WhatsApp template ID (whatsapp_template_id). Example: 1317123456789067
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
categorystring- New category. Example: UTILITYone of
MARKETINGUTILITYAUTHENTICATION componentsarray- New template components in Meta's format. Example: [{"type": "BODY", "text": "Hello {{1}}, your code is {{2}}.", "example": {"body_text": [["John", "1234"]]}}]
kaleyra_whatsapp_text_message_sendSend a free-form WhatsApp text message from your business number.WriteSend WhatsApp Text Message
Send a free-form WhatsApp text message from your business number. Returns the request status with the WhatsApp message ID. Use this inside the 24-hour window. Use kaleyra_whatsapp_template_message_send to start a conversation, and kaleyra_whatsapp_message_send for media, interactive and other types.
Inputs
bodystringrequired- Message text. Example: Hi John, your order has shipped.
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
tostringrequired- Recipient's WhatsApp phone number in E.164 format with country code. Example: +919812345678
extra_infoobject- Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}
preview_urlboolean- Show a link preview for the first URL in the text. Example: true
kaleyra_whatsapp_users_blockBlock WhatsApp users so they cannot message your business number and you cannot message them.WriteBlock WhatsApp Users
Block WhatsApp users so they cannot message your business number and you cannot message them. Returns the blocked and failed users. Use this for abusive users. Use kaleyra_whatsapp_users_unblock to undo.
Inputs
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
usersarrayrequired- Users to block, each a phone number in E.164 format with country code. Example: ["+919812345678"]
kaleyra_rcs_template_deleteDelete an RCS template.DestructiveDelete RCS Template
Delete an RCS template. Returns the deletion status. Use this to remove unused templates.
- Idempotent
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
template_idstringrequired- RCS template ID. Example: 3a7370e5-ebcd-4fc3-95cc-6d1234567e8e
kaleyra_sender_ids_deleteDelete one or more SMS sender IDs from your Kaleyra account.DestructiveDelete Sender IDs
Delete one or more SMS sender IDs from your Kaleyra account. Returns the result for each sender ID. Use this to retire senders you no longer use. Deletion cannot be undone.
- Idempotent
Inputs
senderarrayrequired- Sender IDs to delete. Example: ["ACMEIN"]
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_flow_deleteDelete a draft WhatsApp Flow.DestructiveDelete WhatsApp Flow
Delete a draft WhatsApp Flow. Returns the deletion status. Use this for drafts only; published flows must be deprecated with kaleyra_whatsapp_flow_deprecate.
- Idempotent
Inputs
flow_idstringrequired- WhatsApp Flow ID. Example: 1157612345678900
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_flow_deprecateDeprecate a published WhatsApp Flow so it can no longer be sent.DestructiveDeprecate WhatsApp Flow
Deprecate a published WhatsApp Flow so it can no longer be sent. Returns the status. Use this to retire a published flow; drafts are removed with kaleyra_whatsapp_flow_delete instead.
Inputs
flow_idstringrequired- WhatsApp Flow ID. Example: 1157612345678900
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_group_deleteDelete a WhatsApp group.DestructiveDelete WhatsApp Group
Delete a WhatsApp group. Returns the deletion status. Use this to close a group. Use kaleyra_whatsapp_group_participants_remove to remove only some people.
- Idempotent
Inputs
group_idstringrequired- WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_group_join_requests_rejectReject pending requests to join a WhatsApp group.DestructiveReject WhatsApp Group Join Requests
Reject pending requests to join a WhatsApp group. Returns the result per request. Use this after kaleyra_whatsapp_group_join_requests_list.
- Idempotent
Inputs
group_idstringrequired- WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
join_requestsarrayrequired- Join request IDs to reject. Example: ["MTIwMzYzMDI1MjQ2"]
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_group_participants_removeRemove participants from a WhatsApp group.DestructiveRemove WhatsApp Group Participants
Remove participants from a WhatsApp group. Returns the result for each participant. Use this to remove members. Use kaleyra_whatsapp_groups_list to see members.
- Idempotent
Inputs
group_idstringrequired- WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
participantsarrayrequired- Participants to remove, each a phone number in E.164 format with country code. Example: ["+919812345678"]
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
kaleyra_whatsapp_template_deleteDelete a WhatsApp template by name, optionally only one language version by template ID.DestructiveDelete WhatsApp Template
Delete a WhatsApp template by name, optionally only one language version by template ID. Returns the deletion status. Use this to remove one template. Use kaleyra_whatsapp_templates_bulk_delete to delete many by date, status or name.
- Idempotent
Inputs
namestringrequired- Template name. Example: order_shipped
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
template_idstring- WhatsApp template ID, to delete only that language version. Example: 1317123456789067
kaleyra_whatsapp_templates_bulk_deleteDelete many WhatsApp templates at once, selected by creation date range, names, IDs, status or language.DestructiveDelete WhatsApp Templates in Bulk
Delete many WhatsApp templates at once, selected by creation date range, names, IDs, status or language. Returns the deletion result. Use this to clean up rejected or paused templates. Use kaleyra_whatsapp_template_delete for one template.
- Idempotent
Inputs
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
waba_idstringrequired- WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
end_datestring- Delete templates created up to this date, YYYY-MM-DD. Example: 2025-08-04
languagestring- Template language. Defaults to English. Example: en_US
namestring- Template names to delete, comma-separated. Example: promo_offer,promo_offer_1
start_datestring- Delete templates created from this date, YYYY-MM-DD. Example: 2025-08-01
statusstring- Template statuses to delete, comma-separated. Example: REJECTED,PAUSED
template_idstring- WhatsApp template IDs to delete, comma-separated. Example: 1121234567890566
kaleyra_whatsapp_users_unblockUnblock WhatsApp users on your business number.DestructiveUnblock WhatsApp Users
Unblock WhatsApp users on your business number. Returns the unblocked and failed users. Use this to reverse kaleyra_whatsapp_users_block. Use kaleyra_whatsapp_blocked_users_list to see who is blocked.
- Idempotent
Inputs
phone_numberstringrequired- Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
sidstringrequired- Your Kaleyra account SID (Security Identifier), shown with your API key in the Kaleyra console under Developers > API Keys. It goes in every request path. Example: HXAP16XXXXXX97IN
usersarrayrequired- Users to unblock, each a phone number in E.164 format with country code. Example: ["+919812345678"]
No tools match.