> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Kaleyra

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.

**Authentication:** API Key
**Categories:** Communication, Marketing
**Tools:** 60: 25 read, 25 write, 10 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=KALEYRA)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Kaleyra connection

   In **AgentKit > Connections**, create a Kaleyra connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'kaleyra'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'kaleyra_balance_get',
     toolInput: { sid: 'YOUR_SID' },
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "kaleyra"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={"sid":"YOUR_SID"},
       tool_name="kaleyra_balance_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Kaleyra credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'kaleyra_balance_get',
  toolInput: {
    sid: '<sid>',
  },
  connector: 'kaleyra',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="kaleyra_balance_get",
    tool_input={
        "sid": "<sid>",
    },
    connection_name="kaleyra",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `kaleyra_balance_get`

Get Account Balance · Read-only

Get your Kaleyra account's balance and usage details.
Returns the current balance and currency.
Use this before large sends.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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

Example input: `{"sid":"<sid>"}`

### `kaleyra_blocklist_get`

List Blocklisted Numbers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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
- `channel` (`string`, optional): Channel to list. Example: sms. One of: `sms`, `whatsapp`, `voice`.
- `limit` (`integer`, optional): Numbers per page, up to 100. Example: 100
- `offset` (`integer`, optional): Numbers to skip. Example: 0

Example input: `{"sid":"<sid>"}`

### `kaleyra_consent_list`

List Consent Records · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel` (`string`, required): Channel, for example sms. Example: sms
- `sid` (`string`, required): 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_category` (`string`, optional): Message category. Example: Marketing
- `contact_identifier` (`string`, optional): Customer's mobile number. Example: 919812345678
- `from_date` (`string`, optional): Start date, YYYY-MM-DD. Example: 2026-10-01
- `limit` (`integer`, optional): Records per page. Example: 50
- `page` (`integer`, optional): Page number. Example: 1
- `sender_identifier` (`string`, optional): Sender ID. Example: KLRHXA
- `sort_by` (`string`, optional): Field to sort by, for example created_at. Example: created_at
- `sort_order` (`string`, optional): Sort direction. Example: desc. One of: `asc`, `desc`.
- `status` (`integer`, optional): -1 not found, 0 opted out, 1 opted in, 2 deactivated. Example: 1. One of: `-1`, `0`, `1`, `2`.
- `to_date` (`string`, optional): End date, YYYY-MM-DD. Example: 2026-11-13

Example input: `{"channel":"<channel>","sid":"<sid>"}`

### `kaleyra_consent_validate`

Check Consent · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel` (`string`, required): Channel, for example sms. Example: sms
- `contact_identifiers` (`array`, required): Mobile numbers to check. Example: ["919812345678"]
- `sender_identifier` (`string`, required): Sender ID or short code. Example: KLRHXA
- `sid` (`string`, required): 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_category` (`string`, optional): Category to check. Defaults to all. Example: Marketing
- `consent_topic` (`string`, optional): Topic to check. Defaults to all. Example: Offers

Example input: `{"channel":"<channel>","contact_identifiers":["919812345678"],"sender_identifier":"<sender_identifier>","sid":"<sid>"}`

### `kaleyra_rcs_capability_check`

Check RCS Capability · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `device_address` (`string`, required): Phone number in E.164 format with the country code and no plus sign. Example: 919812345678
- `sid` (`string`, required): 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

Example input: `{"device_address":"<device_address>","sid":"<sid>"}`

### `kaleyra_rcs_template_get`

Get RCS Template · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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_id` (`string`, required): RCS template ID. Example: 3a7370e5-ebcd-4fc3-95cc-6d1234567e8e

Example input: `{"sid":"<sid>","template_id":"<template_id>"}`

### `kaleyra_rcs_template_history_get`

Get RCS Template History · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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_id` (`string`, required): RCS template ID. Example: 3a7370e5-ebcd-4fc3-95cc-6d1234567e8e

Example input: `{"sid":"<sid>","template_id":"<template_id>"}`

### `kaleyra_sender_ids_list`

List Sender IDs · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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

Example input: `{"sid":"<sid>"}`

### `kaleyra_sms_logs_list`

List SMS Logs · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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

Example input: `{"sid":"<sid>"}`

### `kaleyra_sms_status_get`

Get SMS Status · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_ids` (`string`, required): Message ID returned by kaleyra_sms_send; separate several with commas. Example: ee8a1234-5678-90ab-cdef-9b7171234d30:1
- `sid` (`string`, required): 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

Example input: `{"message_ids":"<message_ids>","sid":"<sid>"}`

### `kaleyra_sms_templates_list`

List SMS Templates · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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

Example input: `{"sid":"<sid>"}`

### `kaleyra_voice_call_logs_list`

List Voice Call Logs · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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
- `bridge` (`string`, optional): Only calls through this DID number. Example: 13235550000
- `call_id` (`string`, optional): Call IDs, comma-separated. Example: 75a1b2c3-d4e5-f6a7-b8c9-d0e1f2a3b4c5-1
- `end_time` (`string`, optional): Up to this time, Y-m-dTH:i:sP. Example: 2026-11-13T23:59:59+05:30
- `limit` (`integer`, optional): Records per call. Defaults to 25. Sent as a header, as documented. Example: 25
- `offset` (`integer`, optional): Records to skip. Example: 0
- `page` (`integer`, optional): Page number. Example: 1
- `start_time` (`string`, optional): From this time (within the last 7 days), Y-m-dTH:i:sP. Example: 2026-11-10T00:00:00+05:30
- `status` (`string`, optional): Call statuses, comma-separated, for example ANSWER or NOANSWER. Example: ANSWER

Example input: `{"sid":"<sid>"}`

### `kaleyra_voice_recording_link_get`

Get Voice Recording Link · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Recording ID from the detailed voice report. Example: 1abcd2345efgh6789giu587==
- `sid` (`string`, required): 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
- `validity` (`integer`, optional): Minutes the link stays valid. Defaults to 5. Example: 10

Example input: `{"id":"<id>","sid":"<sid>"}`

### `kaleyra_whatsapp_blocked_users_list`

List Blocked WhatsApp Users · Read-only

List the WhatsApp users blocked on your business number.
Returns the blocked users.
Use this to audit blocks.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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

Example input: `{"phone_number":"<phone_number>","sid":"<sid>"}`

### `kaleyra_whatsapp_call_permissions_get`

Get WhatsApp Call Permissions · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `business_phone_number` (`string`, required): Your WhatsApp Business numbers, comma-separated, E.164. Example: +919876543210
- `sid` (`string`, required): 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_number` (`string`, required): Customer numbers, comma-separated, E.164. Example: +919812345678
- `limit` (`integer`, optional): Records to return. Example: 25
- `offset` (`integer`, optional): Records to skip. Example: 0

Example input: `{"business_phone_number":"<business_phone_number>","sid":"<sid>","user_phone_number":"<user_phone_number>"}`

### `kaleyra_whatsapp_flow_get`

Get WhatsApp Flow · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `flow_id` (`string`, required): WhatsApp Flow ID. Example: 1157612345678900
- `sid` (`string`, required): 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
- `fields` (`string`, optional): Comma-separated fields to return, for example validation_errors,json_version,endpoint_uri,health_status. Example: validation_errors,json_version

Example input: `{"flow_id":"<flow_id>","sid":"<sid>"}`

### `kaleyra_whatsapp_flows_list`

List WhatsApp Flows · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `fields` (`string`, optional): Comma-separated fields to return: id, name, status, categories, validation_errors. Example: id,name,status

Example input: `{"sid":"<sid>","waba_id":"<waba_id>"}`

### `kaleyra_whatsapp_group_join_requests_list`

List WhatsApp Group Join Requests · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
- `sid` (`string`, required): 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

Example input: `{"group_id":"<group_id>","sid":"<sid>"}`

### `kaleyra_whatsapp_groups_list`

List WhatsApp Groups · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): WhatsApp Business number in 91xxxxxxxxxx format. Example: 919876543210
- `sid` (`string`, required): 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_participants` (`boolean`, optional): true to include inactive participants as well. Example: false
- `group_id` (`string`, optional): Only return this group. Example: 120363025246125486@g.us
- `limit` (`integer`, optional): Groups to return. Defaults to 25. Example: 25
- `offset` (`integer`, optional): Groups to skip. Example: 0
- `status` (`string`, optional): Only groups with this status. Example: active. One of: `active`, `suspended`, `deleted`.

Example input: `{"from_number":"<from_number>","sid":"<sid>"}`

### `kaleyra_whatsapp_payment_get`

Get WhatsApp Payment Status · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `payment_config_id` (`string`, required): Payment configuration used for the order. Example: acme-razorpay
- `phone_number` (`string`, required): Customer's phone number in E.164 format with country code. Example: +918123455920
- `reference_id` (`string`, required): Your unique, case-sensitive order or invoice reference. Example: ORD-1042
- `sid` (`string`, required): 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

Example input: `{"payment_config_id":"<payment_config_id>","phone_number":"<phone_number>","reference_id":"<reference_id>","sid":"<sid>"}`

### `kaleyra_whatsapp_phone_number_get`

Get WhatsApp Phone Number Details · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `business_phone_number` (`string`, required): WhatsApp Business phone number with country code. Example: 919876543210
- `sid` (`string`, required): 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

Example input: `{"business_phone_number":"<business_phone_number>","sid":"<sid>"}`

### `kaleyra_whatsapp_phone_numbers_list`

List WhatsApp Phone Numbers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `limit` (`integer`, optional): Numbers to return. Defaults to 25. Example: 25
- `name` (`string`, optional): Only numbers with this display name. Example: Acme Support
- `offset` (`integer`, optional): Numbers to skip. Defaults to 0. Example: 0
- `phone_number` (`string`, optional): Only this number, with country code. Example: +919876543210
- `status` (`string`, optional): Only numbers with this status. Example: APPROVED. One of: `APPROVED`, `PENDING`, `REJECTED`.
- `voice_status` (`string`, optional): Only numbers with WhatsApp calling in this state. Example: Enabled. One of: `Enabled`, `Disabled`.

Example input: `{"sid":"<sid>","waba_id":"<waba_id>"}`

### `kaleyra_whatsapp_pricing_analytics_get`

Get WhatsApp Pricing Analytics · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end` (`string`, required): End of the range as a UTC timestamp. Example: 1763078400
- `granularity` (`string`, required): Granularity; only DAILY is supported. Example: DAILY. One of: `DAILY`. Default: `DAILY`.
- `sid` (`string`, required): 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` (`string`, required): Start of the range as a UTC timestamp. Example: 1761955200
- `waba_id` (`string`, required): WhatsApp Business Account ID. Example: 109012345678901

Example input: `{"end":"<end>","granularity":"DAILY","sid":"<sid>","start":"<start>","waba_id":"<waba_id>"}`

### `kaleyra_whatsapp_template_analytics_get`

Get WhatsApp Template Analytics · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End date, YYYY-MM-DD. Example: 2026-11-13
- `granularity` (`string`, required): Granularity; only DAILY is supported. Example: DAILY. One of: `DAILY`. Default: `DAILY`.
- `sid` (`string`, required): 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_date` (`string`, required): Start date, YYYY-MM-DD. Example: 2026-11-01
- `waba_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `whatsapp_template_ids` (`string`, required): Up to 10 WhatsApp template IDs, comma-separated. Example: 1317123456789067,1561234567890011
- `after` (`string`, optional): Paging cursor from the previous response. Example: MjQZD
- `limit` (`integer`, optional): Template entries to return. Example: 10
- `metric_types` (`string`, optional): Metrics to return, comma-separated: SENT, DELIVERED, READ, CLICKED, REPLIED. Defaults to all. Example: SENT,DELIVERED,READ
- `product_type` (`string`, optional): Product to report on. Defaults to CLOUD_API. Example: CLOUD_API. One of: `CLOUD_API`, `MARKETING_MESSAGES_LITE_API`.

Example input: `{"end_date":"<end_date>","granularity":"DAILY","sid":"<sid>","start_date":"<start_date>","waba_id":"<waba_id>","whatsapp_template_ids":"<whatsapp_template_ids>"}`

### `kaleyra_whatsapp_templates_list`

List WhatsApp Templates · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `category` (`string`, optional): Only return templates in these categories, comma-separated: MARKETING, UTILITY, AUTHENTICATION. Example: UTILITY
- `fields` (`string`, optional): Comma-separated fields to return, for example name,language,status,category,components,whatsapp_template_id. Example: name,status,category
- `limit` (`integer`, optional): Templates to return. Defaults to 25. Example: 25
- `name` (`string`, optional): Only return the template with this name. Example: order_shipped
- `offset` (`integer`, optional): Templates to skip. Defaults to 0. Example: 0
- `status` (`string`, optional): Only return templates with these statuses, comma-separated: APPROVED, PENDING, REJECTED, PAUSED, DISABLED. Example: APPROVED
- `whatsapp_template_id` (`string`, optional): Only return the template with this WhatsApp template ID. Example: 1317123456789067

Example input: `{"sid":"<sid>","waba_id":"<waba_id>"}`

### `kaleyra_consent_update`

Update Consent · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `channel` (`string`, required): Channel, for example sms or whatsapp. Example: sms
- `consent_status` (`string`, required): New consent status. Example: OPT_IN. One of: `OPT_IN`, `OPT_OUT`.
- `contact_identifier` (`string`, required): Customer's mobile number. Example: 919812345678
- `sender_identifier` (`string`, required): Sender ID or short code the consent applies to. Example: KLRHXA
- `sid` (`string`, required): 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
- `source` (`string`, required): Where the consent came from, for example API. Example: API
- `consent_category` (`string`, optional): Message category, for example Marketing, Transactional or Promotional. Example: Marketing
- `consent_topic` (`string`, optional): Topic, for example Offers, Loan or Insurance. Example: Offers
- `inbound_message_identifier` (`string`, optional): Sender ID the customer's opt-in or opt-out message was sent to. Example: KLRHXA
- `request_identifier` (`string`, optional): Unique ID of your request. Example: req-7f3a
- `source_identifier` (`string`, optional): ID of the source request, for example the MO message ID. Example: MO_12345
- `timestamp` (`string`, optional): When the consent was given, YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T10:30:00
- `x_callback_url` (`string`, optional): URL that receives processing updates. Example: https://api.acme.com/kaleyra/consent

Example input: `{"channel":"<channel>","consent_status":"OPT_IN","contact_identifier":"<contact_identifier>","sender_identifier":"<sender_identifier>","sid":"<sid>","source":"<source>"}`

### `kaleyra_rcs_message_send`

Send RCS Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `content` (`object`, required): 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."}
- `from` (`string`, required): Your RCS agent's service code. Example: rcs-acme-IN
- `sid` (`string`, required): 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
- `to` (`array`, required): Recipient numbers with country code and no plus sign (up to 100). Example: ["919812345678"]
- `ref` (`string`, optional): Your reference for this message. Example: order-1042
- `ttl_seconds` (`string`, optional): Seconds before an undelivered message expires. Example: 3600

Example input: `{"content":{"text":"Your order ORD-1042 has shipped."},"from":"<from>","sid":"<sid>","to":["919812345678"]}`

### `kaleyra_rcs_template_create`

Create RCS Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `agent_number` (`string`, required): Agent number the template belongs to. Example: 48400
- `sid` (`string`, required): 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
- `status` (`string`, required): Initial status, usually DRAFT or SUBMITTEDFORAPPROVAL. Example: DRAFT. One of: `DRAFT`, `CREATED`, `SUBMITTEDFORAPPROVAL`.
- `template_name` (`string`, required): Unique name, up to 20 letters, digits or underscores. Example: order_update
- `template_type` (`string`, required): 1 text, 3 file, 4 rich card, 5 carousel. Example: 1. One of: `1`, `3`, `4`, `5`.
- `content_message` (`object`, optional): Suggestions (reply and action chips) for the template. Example: {"suggestions": [{"reply": {"text": "Track", "postback_data": "track"}}]}
- `file` (`object`, optional): File for file templates: file_url, thumbnail_url, content_description. Example: {"file_url": "https://acme.com/brochure.pdf"}
- `rich_card_carousel` (`object`, optional): 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_standalone` (`object`, optional): 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"}}
- `text` (`string`, optional): Message text for text templates, up to 2000 characters. Example: Hi {name}, your order has shipped.

Example input: `{"agent_number":"<agent_number>","sid":"<sid>","status":"DRAFT","template_name":"<template_name>","template_type":"1"}`

### `kaleyra_rcs_template_update`

Update RCS Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_number` (`string`, required): Agent number the template belongs to. Example: 48400
- `sid` (`string`, required): 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
- `status` (`string`, required): Status to set; SUBMITTEDFORAPPROVAL sends it to the carrier. Example: SUBMITTEDFORAPPROVAL. One of: `DRAFT`, `CREATED`, `SUBMITTEDFORAPPROVAL`.
- `template_id` (`string`, required): RCS template ID. Example: 3a7370e5-ebcd-4fc3-95cc-6d1234567e8e
- `template_name` (`string`, required): Template name (cannot be changed after creation). Example: order_update
- `template_number` (`string`, required): The template's reference number from kaleyra_rcs_template_get; it cannot be changed. Example: MN6123456789
- `template_type` (`string`, required): 1 text, 3 file, 4 rich card, 5 carousel. Example: 1. One of: `1`, `3`, `4`, `5`.
- `text` (`string`, optional): New message text for text templates. Example: Hi {name}, your order is out for delivery.

Example input: `{"agent_number":"<agent_number>","sid":"<sid>","status":"DRAFT","template_id":"<template_id>","template_name":"<template_name>","template_number":"<template_number>","template_type":"1"}`

### `kaleyra_sender_ids_create`

Create Sender IDs · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data` (`array`, required): 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"}]
- `sid` (`string`, required): 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

Example input: `{"data":[{"sender":"ACMEIN","description":"Acme order updates","iso_code":"in","entity_id":"1201161234567890123"}],"sid":"<sid>"}`

### `kaleyra_sms_send`

Send SMS · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): Message text. Kaleyra requires it even when a template_id is given. Example: Your order ORD-1042 has shipped.
- `sender` (`string`, required): Approved alphanumeric sender ID shown to recipients. Example: KLRHXA
- `sid` (`string`, required): 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
- `to` (`string`, required): Recipient phone number in E.164 format with country code; separate several numbers with commas. Example: +919876543210
- `callback_profile_id` (`string`, optional): Callback profile that receives delivery status webhooks. Example: IN_09b3dfa7-e05d-4d84-ab2d-6ed654272abc
- `flash` (`string`, optional): 1 to send as a flash SMS. Example: 0. One of: `0`, `1`.
- `prefix` (`string`, optional): Country code to prepend to numbers that lack one. Example: +91
- `ref_custom` (`array`, optional): Up to 5 custom values (50 characters each) shown in reports and callbacks. Example: ["campaign-diwali"]
- `template_data` (`object`, optional): Values for the template's placeholders, keyed by placeholder name. Example: {"name": "John", "order_id": "ORD-1042"}
- `template_id` (`string`, optional): Registered template ID (12 to 30 digits; mandatory in India). Example: 1107161234567890123
- `time` (`string`, optional): 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
- `type` (`string`, optional): Route type. India: OTP, TXN (transactional), TXND (transactional DND) or MKT (marketing). Other regions: OTP or DEFAULT. Example: TXN. One of: `OTP`, `TXN`, `TXND`, `MKT`, `DEFAULT`.
- `unicode` (`string`, optional): Encoding: 1 for unicode text, 0 for plain, Auto to detect. Example: Auto. One of: `Auto`, `0`, `1`.

Example input: `{"body":"<body>","sender":"<sender>","sid":"<sid>","to":"<to>"}`

### `kaleyra_verify_otp_send`

Send Verification OTP · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `mobile` (`string`, required): Recipient phone number in E.164 format with country code; separate several with commas. Example: +919812345678
- `sid` (`string`, required): 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
- `email` (`string`, optional): Email address to also send the OTP to. Example: john@example.com
- `flow_id` (`string`, optional): Verify configuration ID. Optional when a configuration is set as default. Example: d9901234-6946-4b12-ac18-51c123452344a

Example input: `{"mobile":"<mobile>","sid":"<sid>"}`

### `kaleyra_verify_otp_validate`

Validate Verification OTP · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `otp` (`string`, required): Code the user entered. Example: 482913
- `sid` (`string`, required): 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_id` (`string`, required): verify_id from kaleyra_verify_otp_send. Example: 4d3d1234-80ab-43cd-be12-5815ce0795a1

Example input: `{"otp":"<otp>","sid":"<sid>","verify_id":"<verify_id>"}`

### `kaleyra_voice_click_to_call`

Start Click-to-Call · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`string`, required): First number to call, with country code. Example: 13235551234
- `sid` (`string`, required): 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
- `to` (`string`, required): Second number to call, with country code. Example: 13235555678
- `bridge` (`string`, optional): Your active DID number used for the call. Example: 13235550000
- `callback` (`string`, optional): Callback profile IDs or URLs, as JSON text. Example: {"profile_id":"IN_09b3dfa7-e05d-4d84-ab2d-6ed654272abc"}
- `dlrurl` (`string`, optional): URL that receives call details. Example: https://api.acme.com/kaleyra/voice-dlr
- `prefix` (`string`, optional): Country code to prepend when missing, 1 to 4 digits. Example: 1
- `retry` (`string`, optional): Retries if the call fails (0 to 2), or JSON with count and statuses. Example: 1
- `time` (`string`, optional): Schedule time, Y-m-dTH:i:sP, at least 15 minutes ahead. Example: 2026-11-20T10:30:00+05:30

Example input: `{"from":"<from>","sid":"<sid>","to":"<to>"}`

### `kaleyra_voice_outbound_call`

Make Outbound Voice Call · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `sid` (`string`, required): 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
- `target` (`string`, required): 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"}}]
- `to` (`string`, required): Number(s) to call with country code; separate up to 100 with commas. Example: +919812345678
- `bridge` (`string`, optional): Your active DID number used as caller ID, with country code. Example: +918071234567
- `callback` (`string`, optional): Callback profile IDs or URLs, as JSON text. Example: {"profile_id":"IN_09b3dfa7-e05d-4d84-ab2d-6ed654272abc"}
- `custom` (`string`, optional): Your own reference ID, up to 100 characters. Example: order-1042
- `delay` (`integer`, optional): Seconds to wait before calling, 0 to 900. Example: 0
- `dlrurl` (`string`, optional): URL that receives call details when the call ends. Example: https://api.acme.com/kaleyra/voice-dlr
- `interval` (`integer`, optional): Seconds between retries, 15 to 60. Example: 30
- `prefix` (`string`, optional): Country code to prepend to to and bridge when missing. Example: +91
- `retry` (`string`, optional): Retries if the call fails (0 to 2), or JSON with count and statuses. Example: 1
- `time` (`string`, optional): Schedule time, Y-m-dTH:i:sP, 15 minutes to 90 days ahead. Example: 2026-11-20T10:30:00+05:30
- `timeout` (`string`, optional): Call timeout in seconds (30 to 172800), or JSON with a schedule window. Example: 60

Example input: `{"sid":"<sid>","target":"<target>","to":"<to>"}`

### `kaleyra_whatsapp_flow_create`

Create WhatsApp Flow · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `categories` (`array`, required): Flow categories, for example SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, SURVEY or OTHER. Example: ["APPOINTMENT_BOOKING"]
- `name` (`string`, required): Flow name (not shown to users). Example: Appointment booking
- `sid` (`string`, required): 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_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `endpoint_uri` (`string`, optional): Your endpoint that WhatsApp calls for the flow's data exchange. Example: https://api.acme.com/whatsapp/flows

Example input: `{"categories":["APPOINTMENT_BOOKING"],"name":"<name>","sid":"<sid>","waba_id":"<waba_id>"}`

### `kaleyra_whatsapp_flow_publish`

Publish WhatsApp Flow · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `flow_id` (`string`, required): WhatsApp Flow ID. Example: 1157612345678900
- `sid` (`string`, required): 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

Example input: `{"flow_id":"<flow_id>","sid":"<sid>"}`

### `kaleyra_whatsapp_group_create`

Create WhatsApp Group · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, required): Group description. Example: Early access to offers
- `from_number` (`string`, required): WhatsApp Business number in 91xxxxxxxxxx format. Example: 919876543210
- `join_approval_mode` (`string`, required): Whether people joining by link need approval. Example: approval_required. One of: `auto_approve`, `approval_required`.
- `sid` (`string`, required): 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
- `subject` (`string`, required): Group name. Example: Acme VIP customers

Example input: `{"description":"<description>","from_number":"<from_number>","join_approval_mode":"auto_approve","sid":"<sid>","subject":"<subject>"}`

### `kaleyra_whatsapp_group_invite_link_reset`

Reset WhatsApp Group Invite Link · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
- `sid` (`string`, required): 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

Example input: `{"group_id":"<group_id>","sid":"<sid>"}`

### `kaleyra_whatsapp_group_invite_send`

Send WhatsApp Group Invite · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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` (`object`, required): 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"}]}]}
- `to` (`string`, required): User to invite, phone number in E.164 format with country code. Example: +919812345678
- `extra_info` (`object`, optional): Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}

Example input: `{"phone_number":"<phone_number>","sid":"<sid>","template":{},"to":"<to>"}`

### `kaleyra_whatsapp_group_join_requests_accept`

Accept WhatsApp Group Join Requests · Write

Approve pending requests to join a WhatsApp group.
Returns the result per request.
Use this after kaleyra_whatsapp_group_join_requests_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
- `join_requests` (`array`, required): Join request IDs to approve. Example: ["MTIwMzYzMDI1MjQ2"]
- `sid` (`string`, required): 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

Example input: `{"group_id":"<group_id>","join_requests":["MTIwMzYzMDI1MjQ2"],"sid":"<sid>"}`

### `kaleyra_whatsapp_group_message_pin`

Pin or Unpin WhatsApp Group Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `action` (`string`, required): pin or unpin. Example: pin. One of: `pin`, `unpin`.
- `group_id` (`string`, required): WhatsApp group ID. Example: 120363025246125486@g.us
- `message_id` (`string`, required): ID of the group message. Example: wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTE=
- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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_days` (`integer`, optional): Days to keep the pin (required to pin). Example: 7

Example input: `{"action":"pin","group_id":"<group_id>","message_id":"<message_id>","phone_number":"<phone_number>","sid":"<sid>"}`

### `kaleyra_whatsapp_group_message_send`

Send WhatsApp Group Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `group_id` (`string`, required): WhatsApp group ID. Example: 120363025246125486@g.us
- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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
- `type` (`string`, required): Message type. Example: text. One of: `text`, `template`.
- `extra_info` (`object`, optional): Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}
- `template` (`object`, optional): Approved template (when type is template): name, language with code, and components. Example: {"name": "event_reminder", "language": {"code": "en"}, "components": []}
- `text` (`string`, optional): Message text (when type is text). Example: Doors open at 10 AM tomorrow.

Example input: `{"group_id":"<group_id>","phone_number":"<phone_number>","sid":"<sid>","type":"text"}`

### `kaleyra_whatsapp_message_mark_read`

Mark WhatsApp Message Read · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `message_id` (`string`, required): WhatsApp message ID of the incoming message. Example: wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTE=
- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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_info` (`object`, optional): Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}

Example input: `{"message_id":"<message_id>","phone_number":"<phone_number>","sid":"<sid>"}`

### `kaleyra_whatsapp_message_send`

Send WhatsApp Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `messaging_object` (`object`, required): 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_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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_info` (`object`, optional): Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}

Example input: `{"messaging_object":{},"phone_number":"<phone_number>","sid":"<sid>"}`

### `kaleyra_whatsapp_template_create`

Create WhatsApp Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `category` (`string`, required): Template category. Example: UTILITY. One of: `MARKETING`, `UTILITY`, `AUTHENTICATION`.
- `components` (`array`, required): 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"]]}}]
- `language` (`string`, required): Template language code. Example: en_US
- `name` (`string`, required): Template name: lowercase letters, numbers and underscores. Example: order_shipped
- `sid` (`string`, required): 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_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `message_send_ttl_seconds` (`integer`, optional): Delivery time-to-live in seconds: 30 to 900 for authentication, 30 to 43200 for utility templates. Example: 3600

Example input: `{"category":"MARKETING","components":[],"language":"<language>","name":"<name>","sid":"<sid>","waba_id":"<waba_id>"}`

### `kaleyra_whatsapp_template_message_send`

Send WhatsApp Template Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `language_code` (`string`, required): Template language code. Example: en
- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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_name` (`string`, required): Approved template name. Example: order_shipped
- `to` (`string`, required): Recipient's WhatsApp phone number in E.164 format with country code. Example: +919812345678
- `components` (`array`, optional): 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_info` (`object`, optional): Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}

Example input: `{"language_code":"<language_code>","phone_number":"<phone_number>","sid":"<sid>","template_name":"<template_name>","to":"<to>"}`

### `kaleyra_whatsapp_template_update`

Edit WhatsApp Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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_id` (`string`, required): WhatsApp template ID (whatsapp_template_id). Example: 1317123456789067
- `waba_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `category` (`string`, optional): New category. Example: UTILITY. One of: `MARKETING`, `UTILITY`, `AUTHENTICATION`.
- `components` (`array`, optional): New template components in Meta's format. Example: [{"type": "BODY", "text": "Hello {{1}}, your code is {{2}}.", "example": {"body_text": [["John", "1234"]]}}]

Example input: `{"sid":"<sid>","template_id":"<template_id>","waba_id":"<waba_id>"}`

### `kaleyra_whatsapp_text_message_send`

Send WhatsApp Text Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): Message text. Example: Hi John, your order has shipped.
- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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
- `to` (`string`, required): Recipient's WhatsApp phone number in E.164 format with country code. Example: +919812345678
- `extra_info` (`object`, optional): Optional tracking values returned in reports and callbacks: ref, ref1 and ref2 (your references) and wa_source. Example: {"ref": "order-1042"}
- `preview_url` (`boolean`, optional): Show a link preview for the first URL in the text. Example: true

Example input: `{"body":"<body>","phone_number":"<phone_number>","sid":"<sid>","to":"<to>"}`

### `kaleyra_whatsapp_users_block`

Block WhatsApp Users · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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
- `users` (`array`, required): Users to block, each a phone number in E.164 format with country code. Example: ["+919812345678"]

Example input: `{"phone_number":"<phone_number>","sid":"<sid>","users":["+919812345678"]}`

### `kaleyra_rcs_template_delete`

Delete RCS Template · Destructive

Delete an RCS template.
Returns the deletion status.
Use this to remove unused templates.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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_id` (`string`, required): RCS template ID. Example: 3a7370e5-ebcd-4fc3-95cc-6d1234567e8e

Example input: `{"sid":"<sid>","template_id":"<template_id>"}`

### `kaleyra_sender_ids_delete`

Delete Sender IDs · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `sender` (`array`, required): Sender IDs to delete. Example: ["ACMEIN"]
- `sid` (`string`, required): 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

Example input: `{"sender":["ACMEIN"],"sid":"<sid>"}`

### `kaleyra_whatsapp_flow_delete`

Delete WhatsApp Flow · Destructive

Delete a draft WhatsApp Flow.
Returns the deletion status.
Use this for drafts only; published flows must be deprecated with kaleyra_whatsapp_flow_deprecate.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `flow_id` (`string`, required): WhatsApp Flow ID. Example: 1157612345678900
- `sid` (`string`, required): 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

Example input: `{"flow_id":"<flow_id>","sid":"<sid>"}`

### `kaleyra_whatsapp_flow_deprecate`

Deprecate WhatsApp Flow · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `flow_id` (`string`, required): WhatsApp Flow ID. Example: 1157612345678900
- `sid` (`string`, required): 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

Example input: `{"flow_id":"<flow_id>","sid":"<sid>"}`

### `kaleyra_whatsapp_group_delete`

Delete WhatsApp Group · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
- `sid` (`string`, required): 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

Example input: `{"group_id":"<group_id>","sid":"<sid>"}`

### `kaleyra_whatsapp_group_join_requests_reject`

Reject WhatsApp Group Join Requests · Destructive

Reject pending requests to join a WhatsApp group.
Returns the result per request.
Use this after kaleyra_whatsapp_group_join_requests_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
- `join_requests` (`array`, required): Join request IDs to reject. Example: ["MTIwMzYzMDI1MjQ2"]
- `sid` (`string`, required): 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

Example input: `{"group_id":"<group_id>","join_requests":["MTIwMzYzMDI1MjQ2"],"sid":"<sid>"}`

### `kaleyra_whatsapp_group_participants_remove`

Remove WhatsApp Group Participants · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from kaleyra_whatsapp_groups_list. Example: 120363025246125486@g.us
- `participants` (`array`, required): Participants to remove, each a phone number in E.164 format with country code. Example: ["+919812345678"]
- `sid` (`string`, required): 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

Example input: `{"group_id":"<group_id>","participants":["+919812345678"],"sid":"<sid>"}`

### `kaleyra_whatsapp_template_delete`

Delete WhatsApp Template · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): Template name. Example: order_shipped
- `sid` (`string`, required): 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_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `template_id` (`string`, optional): WhatsApp template ID, to delete only that language version. Example: 1317123456789067

Example input: `{"name":"<name>","sid":"<sid>","waba_id":"<waba_id>"}`

### `kaleyra_whatsapp_templates_bulk_delete`

Delete WhatsApp Templates in Bulk · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `sid` (`string`, required): 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_id` (`string`, required): WhatsApp Business Account (WABA) ID linked to your Kaleyra account. Example: 109012345678901
- `end_date` (`string`, optional): Delete templates created up to this date, YYYY-MM-DD. Example: 2025-08-04
- `language` (`string`, optional): Template language. Defaults to English. Example: en_US
- `name` (`string`, optional): Template names to delete, comma-separated. Example: promo_offer,promo_offer_1
- `start_date` (`string`, optional): Delete templates created from this date, YYYY-MM-DD. Example: 2025-08-01
- `status` (`string`, optional): Template statuses to delete, comma-separated. Example: REJECTED,PAUSED
- `template_id` (`string`, optional): WhatsApp template IDs to delete, comma-separated. Example: 1121234567890566

Example input: `{"sid":"<sid>","waba_id":"<waba_id>"}`

### `kaleyra_whatsapp_users_unblock`

Unblock WhatsApp Users · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `phone_number` (`string`, required): Your WhatsApp Business phone number on Kaleyra, with country code, that sends the message. Example: +919876543210
- `sid` (`string`, required): 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
- `users` (`array`, required): Users to unblock, each a phone number in E.164 format with country code. Example: ["+919812345678"]

Example input: `{"phone_number":"<phone_number>","sid":"<sid>","users":["+919812345678"]}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
