> **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 MSG91

The MSG91 connector lets your AI agent act in each user's MSG91 account. Each user connects their own MSG91 API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 67 tools.

**Authentication:** API Key
**Categories:** Communication, Marketing
**Tools:** 67: 31 read, 31 write, 5 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=MSG91)

## 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 MSG91 connection

   In **AgentKit > Connections**, create a MSG91 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 = 'msg91'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize MSG91:', 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: 'msg91_email_analytics_get',
     toolInput: {},
   })
   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 = "msg91"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize MSG91:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="msg91_email_analytics_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their MSG91 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: 'msg91_contacts_search',
  toolInput: {
    phonebook_id: '<phonebook_id>',
  },
  connector: 'msg91',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="msg91_contacts_search",
    tool_input={
        "phonebook_id": "<phonebook_id>",
    },
    connection_name="msg91",
    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.

### `msg91_contacts_search`

Search Contacts · Read-only

Search and filter the contacts of a Segmento phonebook with free text and field rules, with paging and sorting.
Returns matching contacts with the chosen columns and paging details.
Use this to find contacts. Use msg91_phonebook_fields_get for field names and types.

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

Inputs:

- `phonebook_id` (`string`, required): Segmento phonebook ID. Example: 64f1c2b3a4d5e6f708192a3b
- `columns` (`array`, optional): Columns to return. Example: ["Contact_id", "Name", "Email", "Phonenumber"]
- `items_per_page` (`integer`, optional): Contacts per page. Example: 100
- `page_no` (`integer`, optional): Page number, starting at 1. Example: 1
- `query` (`object`, optional): Rule tree: condition is and or or, and rules holds leaf rules (field, operator, type, value) or nested groups. Example: {"condition": "and", "rules": [{"field": "Email", "operator": "=", "type": "Email", "value": "john@example.com"}]}
- `search` (`string`, optional): Free-text search. Example: john
- `sort_by` (`string`, optional): Field to sort by. Example: Name
- `sort_order` (`string`, optional): Sort direction. Example: desc. One of: `asc`, `desc`.

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

### `msg91_email_analytics_get`

Get Email Analytics · Read-only

Get aggregated email statistics for a date range of up to the last 31 days.
Returns totals such as sent, delivered, failed and credits used for the range.
Use this for totals and delivery rates. Use msg91_email_logs_list for per-message detail.

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

Inputs:

- `end_date` (`string`, optional): End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
- `start_date` (`string`, optional): Start date in YYYY-MM-DD format. Example: 2026-11-01

Example input: `{}`

### `msg91_email_css_inline`

Inline Email CSS · Read-only

Convert an HTML email's CSS into inline styles so it renders in email clients.
Returns the HTML with styles inlined.
Use this before msg91_email_template_create when the HTML relies on a style block. It saves nothing.

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

Inputs:

- `html` (`string`, required): HTML to inline. Example: <style>h1{color:#c00}</style><h1>Hello</h1>

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

### `msg91_email_logs_list`

List Email Logs · Read-only

List per-message email delivery logs for up to 3 days within the last 3 days.
Returns one row per message with status, recipient, timestamps, failure reason and request ID; date problems come back as an error field with HTTP 200.
Use this to confirm delivery of specific messages. Use msg91_email_analytics_get for totals.

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

Inputs:

- `end_date` (`string`, required): End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
- `start_date` (`string`, required): Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `msg91_email_template_version_get`

Get Email Template Version · Read-only

Get one version of an email template, including its subject and HTML body.
Returns the version details and, with with=template, its parent template.
Use this to read a template's content. Use msg91_email_templates_list to find version IDs.

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

Inputs:

- `version_id` (`string`, required): Template version ID. Example: 12345
- `with` (`string`, optional): Set to template to include the parent template. Example: template

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

### `msg91_email_templates_list`

List Email Templates · Read-only

List the email templates in your MSG91 account, optionally searched by keyword and filtered by status.
Returns templates with their IDs, slugs, names and versions.
Use this to find a template_id for msg91_email_send. Use msg91_email_template_version_get for one version's content.

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

Inputs:

- `keyword` (`string`, optional): Search text. Example: welcome
- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `per_page` (`integer`, optional): Templates per page. Example: 25
- `search_in` (`string`, optional): Field to search the keyword in, for example name. Example: name
- `status_id` (`integer`, optional): Only return templates with this status ID. Example: 2
- `with` (`string`, optional): Related data to include, for example versions. Example: versions

Example input: `{}`

### `msg91_otp_analytics_get`

Get OTP Analytics · Read-only

Get aggregated OTP statistics for a date range of up to the last 31 days.
Returns totals such as sent, delivered, failed and credits used for the range.
Use this for totals and delivery rates. Use msg91_otp_logs_list for per-message detail.

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

Inputs:

- `end_date` (`string`, optional): End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
- `start_date` (`string`, optional): Start date in YYYY-MM-DD format. Example: 2026-11-01

Example input: `{}`

### `msg91_otp_logs_list`

List OTP Logs · Read-only

List per-message OTP delivery logs for up to 3 days within the last 3 days.
Returns one row per message with status, recipient, timestamps, failure reason and request ID; date problems come back as an error field with HTTP 200.
Use this to confirm delivery of specific messages. Use msg91_otp_analytics_get for totals.

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

Inputs:

- `end_date` (`string`, required): End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
- `start_date` (`string`, required): Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `msg91_phonebook_fields_get`

Get Phonebook Fields · Read-only

Get the fields of a Segmento phonebook, built-in and custom, with their types.
Returns each field's name and type.
Use this before msg91_contact_upsert or msg91_contacts_search so you use the right field names.

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

Inputs:

- `phonebook_id` (`string`, required): Segmento phonebook ID. Example: 64f1c2b3a4d5e6f708192a3b

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

### `msg91_rcs_analytics_get`

Get RCS Analytics · Read-only

Get aggregated RCS statistics for a date range of up to the last 31 days.
Returns totals such as sent, delivered, failed and credits used for the range.
Use this for totals and delivery rates. Use msg91_rcs_logs_list for per-message detail.

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

Inputs:

- `end_date` (`string`, optional): End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
- `start_date` (`string`, optional): Start date in YYYY-MM-DD format. Example: 2026-11-01

Example input: `{}`

### `msg91_rcs_balance_get`

Get RCS Prepaid Balance · Read-only

Get the prepaid RCS balance of your MSG91 account.
Returns the remaining balance.
Use this before large RCS sends. Use msg91_whatsapp_balance_get for WhatsApp.

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

Inputs: none.

Example input: `{}`

### `msg91_rcs_logs_list`

List RCS Logs · Read-only

List per-message RCS delivery logs for up to 3 days within the last 3 days, optionally for one request ID.
Returns one row per message with status, recipient, timestamps, failure reason and request ID; date problems come back as an error field with HTTP 200.
Use this to confirm delivery of specific messages. Use msg91_rcs_analytics_get for totals.

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

Inputs:

- `end_date` (`string`, required): End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
- `start_date` (`string`, required): Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11
- `fields` (`string`, optional): Comma-separated list of columns to return, without spaces. Example: status,customerNumber,deliveryTime
- `limit` (`integer`, optional): Maximum rows to return. Defaults to 1000. Example: 1000
- `request_id` (`string`, optional): Only return logs for this request ID (returned by the send call). Example: 3664676c7a6f313034383834

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `msg91_rcs_templates_list`

List RCS Templates · Read-only

List the RCS templates of a project with a given approval status.
Returns templates with id, name, namespace, status, function_name, content, rejection reason and a ready-to-use send payload.
Use this to find a template's name and namespace for msg91_rcs_template_message_send.

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

Inputs:

- `project_id` (`string`, required): Your RCS project (agent) ID. Example: 1a6caf23-0c6c-4b41-8fe2-1c28bb694335
- `status` (`string`, required): Template status to filter by, for example approved. Example: approved

Example input: `{"project_id":"<project_id>","status":"<status>"}`

### `msg91_sms_analytics_get`

Get SMS Analytics · Read-only

Get aggregated SMS statistics for a date range of up to the last 31 days.
Returns totals such as sent, delivered, failed and credits used for the range.
Use this for totals and delivery rates. Use msg91_sms_logs_list for per-message detail.

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

Inputs:

- `end_date` (`string`, optional): End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
- `start_date` (`string`, optional): Start date in YYYY-MM-DD format. Example: 2026-11-01

Example input: `{}`

### `msg91_sms_logs_list`

List SMS Logs · Read-only

List per-message SMS delivery logs for up to 3 days within the last 3 days, optionally for one request ID.
Returns one row per message with status, recipient, timestamps, failure reason and request ID; date problems come back as an error field with HTTP 200.
Use this to confirm delivery of specific messages. Use msg91_sms_analytics_get for totals.

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

Inputs:

- `end_date` (`string`, required): End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
- `start_date` (`string`, required): Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11
- `fields` (`string`, optional): Comma-separated list of columns to return, without spaces. Example: status,customerNumber,deliveryTime
- `limit` (`integer`, optional): Maximum rows to return. Defaults to 1000. Example: 1000
- `request_id` (`string`, optional): Only return logs for this request ID (returned by the send call). Example: 3664676c7a6f313034383834

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `msg91_sms_template_get`

Get SMS Template Versions · Read-only

Get one SMS template with all its versions, their content, sender ID, DLT template ID and approval status.
Returns the template's versions, including the version id needed to make one the default.
Use this before msg91_sms_template_version_activate. Use msg91_sms_templates_list to find template IDs.

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

Inputs:

- `template_id` (`string`, required): SMS template ID. Example: 63f1a2b4d6fc0560a1234567

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

### `msg91_sms_templates_list`

List SMS Templates · Read-only

List the SMS templates (flows) in your MSG91 account.
Returns templates with their IDs, names, sender IDs and DLT template IDs.
Use this to find a template_id for msg91_sms_send. Use msg91_sms_template_get for one template's versions.

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

Inputs: none.

Example input: `{}`

### `msg91_voice_analytics_get`

Get Voice Analytics · Read-only

Get aggregated voice statistics for a date range of up to the last 31 days.
Returns totals such as sent, delivered, failed and credits used for the range.
Use this for totals and delivery rates. Use msg91_voice_call_logs_list for per-call detail.

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

Inputs:

- `end_date` (`string`, optional): End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
- `start_date` (`string`, optional): Start date in YYYY-MM-DD format. Example: 2026-11-01

Example input: `{}`

### `msg91_voice_call_logs_list`

List Voice Call Logs · Read-only

List the call logs of your voice account, one record per call.
Returns uuid, start and end time, caller ID, destinations, duration, billing duration, status, failure reason, charge, direction, recording flag and IVR inputs for each call.
Use this to check whether a call connected and to get the uuid for msg91_voice_call_recording_get.

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

Inputs: none.

Example input: `{}`

### `msg91_voice_call_recording_get`

Get Voice Call Recording Link · Read-only

Get a temporary download link for a call's recording.
Returns the recording link, valid until the expiry you set.
Use this for calls whose log shows a recording. Get the uuid from msg91_voice_call_logs_list.

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

Inputs:

- `uuid` (`string`, required): Call uuid from msg91_voice_call_logs_list. Example: b7f6c2a1-3d4e-4f50-8a9b-0c1d2e3f4a5b
- `expiry` (`integer`, optional): Link lifetime in seconds, up to 604800 (7 days). Example: 3600

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

### `msg91_voice_files_list`

List Voice Files · Read-only

List the pre-recorded voice files uploaded to your MSG91 account.
Returns files with their IDs and names.
Use this to find file IDs for msg91_voice_template_create.

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

Inputs:

- `page_size` (`integer`, optional): Files per page. Example: 100

Example input: `{}`

### `msg91_voice_templates_list`

List Voice Templates · Read-only

List voice templates, or get one by ID.
Returns templates with name, voice and structure.
Use this to find a template for msg91_voice_template_call.

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

Inputs:

- `id` (`string`, optional): Return only the template with this ID. Example: 1024
- `page_num` (`integer`, optional): Page number, starting at 1. Example: 1
- `page_size` (`integer`, optional): Templates per page. Example: 25
- `sort_by` (`string`, optional): Sort field; only name is supported. Example: name. One of: `name`.
- `sort_order` (`string`, optional): Sort direction. Example: asc. One of: `asc`, `desc`.

Example input: `{}`

### `msg91_whatsapp_analytics_get`

Get WhatsApp Analytics · Read-only

Get aggregated WhatsApp statistics for a date range of up to the last 31 days.
Returns totals such as sent, delivered, failed and credits used for the range.
Use this for totals and delivery rates. Use msg91_whatsapp_logs_list for per-message detail.

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

Inputs:

- `end_date` (`string`, optional): End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
- `start_date` (`string`, optional): Start date in YYYY-MM-DD format. Example: 2026-11-01

Example input: `{}`

### `msg91_whatsapp_balance_get`

Get WhatsApp Prepaid Balance · Read-only

Get the prepaid WhatsApp balance for an integrated number.
Returns the remaining balance.
Use this before large sends. Use msg91_rcs_balance_get for RCS.

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

Inputs:

- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210

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

### `msg91_whatsapp_group_get`

Get WhatsApp Group · Read-only

Get one WhatsApp group's details: subject, description, participants and invite link.
Returns the group.
Use this to read participants or the invite link. Use msg91_whatsapp_groups_list to find group IDs.

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

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
- `integrated_number` (`string`, required): Integrated WhatsApp number that owns the group. Example: 919876543210
- `timezone` (`string`, optional): Timezone offset for timestamps in the response, for example +05:30. Example: +05:30

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

### `msg91_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 request IDs and phone numbers.
Use this before approving or rejecting with msg91_whatsapp_group_join_requests_approve or _reject.

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

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
- `integrated_number` (`string`, required): Integrated WhatsApp number that owns the group. Example: 919876543210
- `timezone` (`string`, optional): Timezone offset for timestamps in the response, for example +05:30. Example: +05:30

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

### `msg91_whatsapp_groups_list`

List WhatsApp Groups · Read-only

List the WhatsApp groups of an integrated number.
Returns groups with their IDs, subjects and participant counts.
Use this to find a group_id. Use msg91_whatsapp_group_get for one group's participants and invite link.

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

Inputs:

- `integrated_number` (`string`, required): Integrated WhatsApp number with country code. Example: 919876543210
- `timezone` (`string`, optional): Timezone offset for timestamps in the response, for example +05:30. Example: +05:30

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

### `msg91_whatsapp_logs_list`

List WhatsApp Logs · Read-only

List per-message WhatsApp delivery logs for up to 3 days within the last 3 days, optionally for one request ID.
Returns one row per message with status, recipient, timestamps, failure reason and request ID; date problems come back as an error field with HTTP 200.
Use this to confirm delivery of specific messages. Use msg91_whatsapp_analytics_get for totals.

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

Inputs:

- `end_date` (`string`, required): End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
- `start_date` (`string`, required): Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11
- `fields` (`string`, optional): Comma-separated list of columns to return, without spaces. Example: status,customerNumber,deliveryTime
- `limit` (`integer`, optional): Maximum rows to return. Defaults to 1000. Example: 1000
- `request_id` (`string`, optional): Only return logs for this request ID (returned by the send call). Example: 3664676c7a6f313034383834

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `msg91_whatsapp_numbers_list`

List WhatsApp Numbers · Read-only

List the WhatsApp business numbers activated on your MSG91 account.
Returns each integrated number with its status and details.
Use this to find the integrated_number the other WhatsApp tools need.

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

Inputs: none.

Example input: `{}`

### `msg91_whatsapp_templates_list`

List WhatsApp Templates · Read-only

List the WhatsApp templates of an integrated number, optionally filtered by name, status or language (up to 500).
Returns templates with name, language, category, status and components.
Use this to find template names before sending, or to check approval after msg91_whatsapp_template_create.

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

Inputs:

- `integrated_number` (`string`, required): Integrated WhatsApp number with country code. Example: 919876543210
- `page_num` (`integer`, optional): Page number when pagination is true, starting at 1. Example: 1
- `page_size` (`integer`, optional): Templates per page when pagination is true. Example: 50
- `pagination` (`boolean`, optional): Set true, together with page_size and page_num, to page the results. Example: true
- `template_language` (`string`, optional): Only return templates in this language. Example: en
- `template_name` (`string`, optional): Only return templates with this name. Example: order_shipped
- `template_status` (`string`, optional): Only return templates with this status. Example: approved. One of: `approved`, `rejected`, `pending`.

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

### `msg91_widget_access_token_verify`

Verify Widget Access Token · Read-only

Validate the access token a client received after verifying a widget OTP, on your server.
Returns whether the token is valid and the verified identifier (email or mobile).
Use this to confirm a login done through the OTP widget before trusting it.

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

Inputs:

- `access_token` (`string`, required): JWT access token returned by the widget's OTP verification. Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0SWQiOiIzNjY0In0.sig

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

### `msg91_campaign_run`

Launch Campaign · Write

Launch an existing MSG91 campaign for the recipients you pass, across the campaign's channels (SMS, email, WhatsApp, voice), now or at a scheduled time.
Returns the campaign run request details.
Use this to trigger a multi-channel campaign from your app. Use msg91_oneapi_flow_run for a One API flow.

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

Inputs:

- `campaign_slug` (`string`, required): Campaign slug from the MSG91 Campaign panel. Example: order-confirmation
- `data` (`object`, required): Send data: sendTo is a list of groups, each with a to list (name, email, mobiles and per-recipient variables) and optional cc, bcc and shared variables; add attachments and reply_to when the campaign sends email. Example: {"sendTo": [{"to": [{"name": "John", "email": "john@example.com", "mobiles": "919876543210", "variables": {"order_id": {"type": "text", "value": "ORD-1042"}}}]}]}
- `schedule_for` (`string`, optional): Run later at this time, in YYYY-MM-DD H:i format. Example: 2026-11-20 10:30
- `timezone` (`string`, optional): Timezone for schedule_for. Defaults to Asia/Kolkata. Example: Asia/Kolkata
- `timezone_by` (`string`, optional): Whose timezone to use for scheduling. Example: company. One of: `company`, `contact`, `manual`.

Example input: `{"campaign_slug":"<campaign_slug>","data":{}}`

### `msg91_contact_upsert`

Create or Update Contact · Write

Add a contact to a Segmento phonebook, or update it when a contact with the same contact_id exists.
Returns the saved contact.
Use this to sync users from your app or CRM. Use msg91_phonebook_fields_get to see existing fields first.

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

Inputs:

- `contact` (`object`, required): Contact attributes: name, email and contact_id are built in; any other key is a custom field (a YYYY-MM-DD HH:MM:SS value becomes a date field) and nested objects are allowed. Example: {"contact_id": "cust_1042", "name": "John", "email": "john@example.com", "Phonenumber": "919876543210", "city": "Pune"}
- `phonebook_id` (`string`, required): Segmento phonebook ID. Example: 64f1c2b3a4d5e6f708192a3b
- `create_fields` (`boolean`, optional): Set false to stop unknown keys from creating new phonebook fields. Defaults to true. Example: false

Example input: `{"contact":{"contact_id":"cust_1042","name":"John","email":"john@example.com","Phonenumber":"919876543210","city":"Pune"},"phonebook_id":"<phonebook_id>"}`

### `msg91_email_send`

Send Email · Write

Send an email built from an MSG91 email template to one or more recipient groups, each with its own variables, from a domain registered with MSG91.
Returns status success with a unique_id for the request.
Use this for transactional email. Use msg91_email_templates_list for the template_id and msg91_email_logs_list to check delivery.

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

Inputs:

- `domain` (`string`, required): Sending domain registered with MSG91; it signs DKIM. Example: mail.acme.com
- `from` (`object`, required): Sender: an object with the email on your registered domain and a display name. Example: {"name": "Acme", "email": "no-reply@mail.acme.com"}
- `recipients` (`array`, required): Recipient groups. Each group has a to list (objects with email and name) and optional cc and bcc lists, plus variables that fill the template's {{placeholders}}; variables can hold lists for Handlebars loops. Example: [{"to": [{"name": "John", "email": "john@example.com"}], "variables": {"name": "John"}}]
- `template_id` (`string`, required): Email template ID (slug) from msg91_email_templates_list. Example: welcome_email
- `attachments` (`array`, optional): Attachments, each an object with a public filePath URL and the fileName to show. Example: [{"filePath": "https://acme.com/invoice.pdf", "fileName": "invoice.pdf"}]
- `reply_to` (`array`, optional): Reply-to addresses, each an object with an email. Example: [{"email": "support@acme.com"}]

Example input: `{"domain":"<domain>","from":{"name":"Acme","email":"no-reply@mail.acme.com"},"recipients":[{"mobiles":"919876543210","VAR1":"John","VAR2":"ORD-1042"}],"template_id":"<template_id>"}`

### `msg91_email_template_create`

Create Email Template · Write

Create an HTML email template with a subject and body that can use {{variables}}.
Returns the new template with its slug, which is the template_id for msg91_email_send.
Use this to add a template. Use msg91_email_css_inline first if the HTML uses a style block.

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

Inputs:

- `body` (`string`, required): HTML body; can use {{variables}}. Example: <html><body><h1>Hello {{first_name}}</h1></body></html>
- `name` (`string`, required): Template name. Example: Welcome email
- `subject` (`string`, required): Subject line; can use {{variables}}. Example: Welcome {{first_name}}
- `slug` (`string`, optional): Unique template ID to use. Generated from the name when empty. Example: welcome_email

Example input: `{"body":"<body>","name":"<name>","subject":"<subject>"}`

### `msg91_email_validate`

Validate Email Address · Write

Check whether an email address is valid and deliverable before you send to it.
Returns the validation result for the address, such as whether it is deliverable.
Use this to clean addresses before sending. Each validation is charged to your MSG91 email balance.

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

Inputs:

- `email` (`string`, required): Email address to validate. Example: john@example.com

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

### `msg91_oneapi_flow_run`

Run One API Flow · Write

Run a One API flow, which sends over the channels, templates and priority order configured for that flow in MSG91.
Returns the flow run request details.
Use this when a flow already defines the channels and fallbacks. Use the channel send tools for a single channel.

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

Inputs:

- `data` (`object`, required): Send data: sendTo is a list of groups with a to list (mobiles, email, name and variables); optional validateBeforeSend, handleBarSupport, attachments and reply_to. Example: {"sendTo": [{"to": [{"mobiles": "919876543210", "name": "John", "email": "john@example.com", "variables": {}}]}]}
- `oneapi_slug` (`string`, required): One API flow slug from the MSG91 panel. Example: otp-fallback-flow

Example input: `{"data":{},"oneapi_slug":"<oneapi_slug>"}`

### `msg91_otp_resend`

Resend OTP · Write

Resend the same OTP to a mobile number by voice call or text message.
Returns type success when the resend is queued.
Use this when the user did not receive the code from msg91_otp_send.

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

Inputs:

- `mobile` (`string`, required): The mobile number in international format with the country code and no plus sign the OTP was sent to. Example: 919876543210
- `retrytype` (`string`, optional): Channel to resend on: voice (the default) or text. Example: text. One of: `voice`, `text`.

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

### `msg91_otp_send`

Send OTP · Write

Generate an OTP and send it by SMS to a mobile number using an OTP template; MSG91 stores it and handles expiry.
Returns type success and a request_id.
Use this for phone verification, then check the user's code with msg91_otp_verify. Use msg91_otp_resend if the code did not arrive.

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

Inputs:

- `mobile` (`string`, required): Recipient mobile number in international format with the country code and no plus sign. Example: 919876543210
- `template_id` (`string`, required): OTP template ID from the OTP section of MSG91; the template must contain ##OTP##. Example: 63f1a2b4d6fc0560a7654321
- `otp` (`string`, optional): Your own OTP value to send instead of a generated one. Example: 482913
- `otp_expiry` (`integer`, optional): Minutes before the code expires, 1 to 10080. Defaults to 15. Example: 10
- `otp_length` (`integer`, optional): Number of digits, 4 to 9. Defaults to 4. Example: 6
- `params` (`object`, optional): Values for the template's other variables (Param1, Param2...), case sensitive. Sent as the JSON body. Example: {"Param1": "Acme", "Param2": "login"}
- `unicode` (`string`, optional): Set 1 for templates in a non-English script. Example: 1. One of: `0`, `1`.

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

### `msg91_otp_template_update`

Update OTP Template · Write

Update the content, DLT template ID or sender ID of an OTP template.
Returns type success when the template is updated.
Use this to change OTP wording; the content must keep ##OTP## and match the DLT registration in India.

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

Inputs:

- `template_id` (`string`, required): OTP template ID. Example: 63f1a2b4d6fc0560a7654321
- `dlt_template_id` (`string`, optional): DLT template ID registered for this content (India). Example: 1207168000000000000
- `sender_id` (`string`, optional): Sender ID to send from. Example: ACMEIN
- `template` (`string`, optional): New template content, including ##OTP##. Example: ##OTP## is your Acme login code. Valid for 10 minutes.

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

### `msg91_otp_verify`

Verify OTP · Write

Check the code a user entered against the OTP sent to their mobile number by msg91_otp_send.
Returns type success with OTP verified success, or type error with OTP expired, OTP not match or a similar message, both with HTTP 200.
Use this when the user submits the code, and check type rather than the HTTP status.

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

Inputs:

- `mobile` (`string`, required): The mobile number in international format with the country code and no plus sign the OTP was sent to. Example: 919876543210
- `otp` (`string`, required): Code the user entered. Example: 482913

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

### `msg91_rcs_message_send`

Send RCS Message · Write

Send an RCS message to one or more numbers: text, media, rich card, carousel, suggested replies, dial, open URL, view or share location, or calendar event.
Returns status success with a request ID; delivery is in msg91_rcs_logs_list.
Use this for free-form RCS content. Use msg91_rcs_template_message_send for an approved RCS template.

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

Inputs:

- `content` (`object`, required): Fields for the chosen type, sent at the top level of the request: text for text_message; media_url for media; media_url, title, description, replies_list and actions for rich_card; image_urls, titles, descriptions, replies_list_of_list and actions_list_of_list for carousel; text, replies_list and actions for suggested_replies; dial_number, text and text_to_show for dial; text, url and text_to_show for open_url; location_query, text and text_to_show for view_location; text and text_to_show for share_location; text, text_to_show, start_time, end_time, title and description for calendar_event. Example: {"text": "Your order ORD-1042 has shipped."}
- `customer_numbers` (`array`, required): Recipient numbers with country code and no plus sign. Example: ["919876543210"]
- `function_name` (`string`, required): Message type. Example: text_message. One of: `text_message`, `media`, `rich_card`, `carousel`, `suggested_replies`, `dial`, `open_url`, `view_location`, `share_location`, `calendar_event`.
- `project_id` (`string`, required): Your RCS project (agent) ID from the MSG91 RCS panel. Example: 1a6caf23-0c6c-4b41-8fe2-1c28bb694335
- `ttl` (`string`, optional): Time to live in seconds, 1 to 1296000. Example: 86400

Example input: `{"content":{"text":"Your order ORD-1042 has shipped."},"customer_numbers":["919876543210"],"function_name":"text_message","project_id":"<project_id>"}`

### `msg91_rcs_template_create`

Create RCS Template · Write

Create a reusable RCS template (text, rich card, carousel, suggested replies, dial, open URL, view or share location, or calendar event) for approval.
Returns status success; check approval with msg91_rcs_templates_list.
Use this to set up repeatable RCS messages for msg91_rcs_template_message_send.

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

Inputs:

- `content` (`object`, required): Template content for the type, using {{1}}, {{2}}... for variables: text for text_message; media_url, title, description, replies_list and actions for rich_card; image_urls (and optional video_urls), titles, descriptions, replies_list_of_list and actions_list_of_list for carousel; and the same fields as the matching send type for the others. Example: {"text": "Hi {{1}}, your order {{2}} has shipped."}
- `function_name` (`string`, required): Template type. Example: text_message. One of: `text_message`, `rich_card`, `carousel`, `suggested_replies`, `dial`, `open_url`, `view_location`, `share_location`, `calendar_event`.
- `project_id` (`string`, required): Your RCS project (agent) ID from the MSG91 RCS panel. Example: 1a6caf23-0c6c-4b41-8fe2-1c28bb694335
- `template_name` (`string`, required): Unique template name. Example: order_update
- `click_count` (`boolean`, optional): Track clicks on the URL (open_url templates). Example: true
- `language` (`string`, optional): Template language code. Example: en
- `ttl` (`string`, optional): Time to live in seconds, 1 to 1296000. Example: 86400

Example input: `{"content":{"text":"Your order ORD-1042 has shipped."},"function_name":"text_message","project_id":"<project_id>","template_name":"<template_name>"}`

### `msg91_rcs_template_message_send`

Send RCS Template Message · Write

Send an approved RCS template to groups of numbers, each group with its own variable values.
Returns status success with a request ID.
Use this for approved RCS templates. Use msg91_rcs_message_send for free-form content.
Needs the template name and namespace from msg91_rcs_templates_list.

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

Inputs:

- `customer_number_variables` (`array`, required): Recipient groups: each has a customer_number list and a variables list with the values for the template's {{1}}, {{2}}... in order. Example: [{"customer_number": ["919876543210"], "variables": ["John", "ORD-1042"]}]
- `function_name` (`string`, required): The template's message type, as shown in msg91_rcs_templates_list. Example: text_message
- `name` (`string`, required): Template name. Example: order_update
- `namespace` (`string`, required): Template namespace from msg91_rcs_templates_list. Example: a1b2c3d4_order_update
- `project_id` (`string`, required): Your RCS project (agent) ID from the MSG91 RCS panel. Example: 1a6caf23-0c6c-4b41-8fe2-1c28bb694335
- `ttl` (`string`, optional): Time to live in seconds, 1 to 1296000. Example: 86400

Example input: `{"customer_number_variables":[],"function_name":"<function_name>","name":"<name>","namespace":"<namespace>","project_id":"<project_id>"}`

### `msg91_sms_send`

Send SMS · Write

Send a DLT-approved SMS template to one or more mobile numbers, each with its own variable values, optionally scheduled or with URL shortening.
Returns type success and the request ID (message) to look up in msg91_sms_logs_list.
Use this for transactional and promotional SMS. Use msg91_otp_send for OTPs that MSG91 should generate and verify.
Needs a template_id from msg91_sms_templates_list.

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

Inputs:

- `recipients` (`array`, required): One object per recipient: mobiles is the mobile number in international format with the country code and no plus sign, and the other keys are the template's variable names (for example VAR1, VAR2) with their values for that recipient. Example: [{"mobiles": "919876543210", "VAR1": "John", "VAR2": "ORD-1042"}]
- `template_id` (`string`, required): SMS template ID from your MSG91 account. Example: 63f1a2b4d6fc0560a1234567
- `real_time_response` (`string`, optional): 1 to get delivery details in the response where available. Example: 1. One of: `0`, `1`.
- `schtime` (`string`, optional): Schedule the send for this time, in YYYY-MM-DD HH:MM:SS format. Leave empty to send now. Example: 2026-11-20 10:30:00
- `short_url` (`string`, optional): 1 to shorten and track URLs in the message, 0 to leave them as they are. Example: 1. One of: `0`, `1`.
- `short_url_expiry` (`string`, optional): Lifetime of shortened URLs in seconds. Example: 86400

Example input: `{"recipients":[{"mobiles":"919876543210","VAR1":"John","VAR2":"ORD-1042"}],"template_id":"<template_id>"}`

### `msg91_sms_template_version_activate`

Make SMS Template Version Default · Write

Make one approved version of an SMS template the default, so new sends with that template ID use its content.
Returns type success when the version is active.
Use this after a new version is approved. Get the version id from msg91_sms_template_get.

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

Inputs:

- `template_id` (`string`, required): SMS template ID. Example: 63f1a2b4d6fc0560a1234567
- `version_id` (`string`, required): ID of the template version to make default. Example: 6501b2c3d4e5f60718293a4b

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

### `msg91_voice_click_to_call`

Start Click-to-Call · Write

Bridge a call between a first party and one or more other numbers through your MSG91 caller ID, without showing anyone's number.
Returns the queued request ID; see msg91_voice_call_logs_list for the outcome.
Use this for click-to-call buttons and agent callbacks.

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

Inputs:

- `caller_id` (`string`, required): Your MSG91 voice number shown to all parties, with country code. Example: 918071234567
- `destination` (`string`, required): First number to call, with country code and no plus sign. Example: 919876543210
- `destination_b` (`array`, required): Numbers to connect once the first party answers. Example: ["919812345678"]
- `expire_time` (`string`, optional): Seconds after which the request expires if it has not connected. Example: 120

Example input: `{"caller_id":"<caller_id>","destination":"<destination>","destination_b":["919812345678"]}`

### `msg91_voice_flow_call`

Run IVR Flow Call · Write

Call a number and run an IVR flow built in your MSG91 account.
Returns the queued call request ID.
Use this for interactive calls with key presses. Use msg91_voice_template_call to only play a message.

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

Inputs:

- `caller_id` (`string`, required): Your MSG91 voice number (caller ID) with country code. Example: 918071234567
- `client_number` (`string`, required): Customer's mobile number in international format with the country code and no plus sign. Example: 919876543210
- `flow` (`string`, required): IVR flow name from your MSG91 account. Example: delivery_confirmation
- `callback_url` (`string`, optional): URL MSG91 calls with the call status. Example: https://api.acme.com/msg91/voice-status
- `variables` (`object`, optional): Values for the flow's variables: each key is a variable name with a type, the value, and as_digits or currency_code where relevant. Example: {"var1": {"type": "currency", "currency_code": "INR", "value": "499"}}

Example input: `{"caller_id":"<caller_id>","client_number":"<client_number>","flow":"<flow>"}`

### `msg91_voice_template_call`

Send Voice Message · Write

Call a customer and play a voice template (text-to-speech with variables) from your caller ID.
Returns the queued call request ID; see msg91_voice_call_logs_list for the outcome.
Use this for spoken notifications and OTPs. Use msg91_voice_flow_call for an interactive IVR flow.
Needs a template name from msg91_voice_templates_list.

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

Inputs:

- `caller_id` (`string`, required): Your MSG91 voice number (caller ID) with country code. Example: 918071234567
- `client_number` (`string`, required): Customer's mobile number in international format with the country code and no plus sign. Example: 919876543210
- `template` (`string`, required): Voice template name. Example: order_update_voice
- `callback_url` (`string`, optional): URL MSG91 calls with the call status. Example: https://api.acme.com/msg91/voice-status
- `variables` (`object`, optional): Values for the template's variables: each key is a variable name with a type (text, number or currency), the value, and as_digits or currency_code where relevant. Example: {"var1": {"type": "number", "as_digits": true, "value": "1234"}}

Example input: `{"caller_id":"<caller_id>","client_number":"<client_number>","template":"<template>"}`

### `msg91_voice_template_create`

Create Voice Template · Write

Create a voice template from spoken text, pre-recorded files and variables, read by a text-to-speech voice.
Returns the new template.
Use this to set up messages for msg91_voice_template_call. Use msg91_voice_files_list for file IDs.

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

Inputs:

- `name` (`string`, required): Template name. Example: order_update_voice
- `structure` (`array`, required): Ordered parts spoken one after another: text parts with a value, file parts with a file ID as value, and var parts with a name and var_type (text, number with optional as_digits, or currency). Example: [{"type": "text", "value": "Hello, your order number is "}, {"type": "var", "value": "VAR1", "name": "VAR1", "var_type": "number", "as_digits": true}]
- `voice_name` (`string`, required): Text-to-speech voice, for example en-IN-Standard-A. Example: en-IN-Standard-A
- `has_variable` (`boolean`, optional): Set true when the structure has var parts. Example: true

Example input: `{"name":"<name>","structure":[{"type":"text","value":"Hello, your order number is "},{"type":"var","value":"VAR1","name":"VAR1","var_type":"number","as_digits":true}],"voice_name":"<voice_name>"}`

### `msg91_whatsapp_group_create`

Create WhatsApp Group · Write

Create a WhatsApp group owned by your integrated number.
Returns the new group with its ID and invite link.
Use this to start a community or customer group. Use msg91_whatsapp_text_message_send with recipient_type group to post in it.

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

Inputs:

- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `subject` (`string`, required): Group name. Example: Acme VIP customers
- `description` (`string`, optional): Group description. Example: Early access to offers
- `join_approval_mode` (`string`, optional): Whether people joining by link need approval, for example approval_required. Example: approval_required

Example input: `{"integrated_number":"<integrated_number>","subject":"<subject>"}`

### `msg91_whatsapp_group_invite_link_reset`

Reset WhatsApp Group Invite Link · Write

Reset a WhatsApp group's invite link so the old link stops working.
Returns status success; read the new link with msg91_whatsapp_group_get.
Use this when an invite link has leaked.

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

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
- `integrated_number` (`string`, required): Integrated WhatsApp number that owns the group. Example: 919876543210

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

### `msg91_whatsapp_group_join_requests_approve`

Approve WhatsApp Group Join Requests · Write

Approve pending requests to join a WhatsApp group.
Returns status success.
Use this after msg91_whatsapp_group_join_requests_list.

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

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `join_requests` (`array`, required): Join request IDs to approve. Example: ["MTIwMzYzMDI1MjQ2MTI1NDg2"]

Example input: `{"group_id":"<group_id>","integrated_number":"<integrated_number>","join_requests":["MTIwMzYzMDI1MjQ2MTI1NDg2"]}`

### `msg91_whatsapp_interactive_message_send`

Send WhatsApp Interactive Message · Write

Send an interactive WhatsApp message: reply buttons, a list menu, a location request, a single product, a multi-product list or a payment link.
Returns status success with a request ID.
Use this inside the 24-hour window. Use msg91_whatsapp_text_message_send for plain text.

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

Inputs:

- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `interactive` (`object`, required): Interactive content in WhatsApp's format. Set type to button (action.buttons with reply id and title), list (action.button label and sections with rows), location_request_message (action.name send_location), product (action.catalog_id and product_retailer_id), product_list (action.catalog_id and sections of product_items) or payment_link (items with name, amount and quantity). Add body text and an optional header and footer. Example: {"type": "button", "body": {"text": "Confirm your delivery slot?"}, "action": {"buttons": [{"type": "reply", "reply": {"id": "yes", "title": "Yes"}}, {"type": "reply", "reply": {"id": "no", "title": "No"}}]}}
- `recipient_number` (`string`, required): Recipient's WhatsApp number with country code. Example: 919876543210

Example input: `{"integrated_number":"<integrated_number>","interactive":{},"recipient_number":"<recipient_number>"}`

### `msg91_whatsapp_template_create`

Create WhatsApp Template · Write

Create a WhatsApp message template with positional variables ({{1}}, {{2}}...) and submit it to Meta for approval.
Returns status success; the template starts as pending.
Use this to add a template, then check its status with msg91_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 WhatsApp's format: a HEADER (format TEXT, IMAGE, VIDEO or DOCUMENT), a BODY with text, an optional FOOTER and BUTTONS. Each part with variables needs an example with sample values. Example: [{"type": "BODY", "text": "Hi {{1}}, your order {{2}} has shipped.", "example": {"body_text": [["John", "ORD-1042"]]}}]
- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `language` (`string`, required): Template language code. Example: en
- `template_name` (`string`, required): Template name: lowercase letters, numbers and underscores. Example: order_shipped
- `button_url` (`boolean`, optional): Set true when a button URL contains a variable. Example: true

Example input: `{"category":"MARKETING","components":[{"type":"BODY","text":"Hello {{1}}, your code is {{2}}!"}],"integrated_number":"<integrated_number>","language":"<language>","template_name":"<template_name>"}`

### `msg91_whatsapp_template_message_send`

Send WhatsApp Template Message · Write

Send an approved WhatsApp template to one or many recipients from your integrated number, with per-recipient variable values.
Returns status success with a request ID; delivery is in msg91_whatsapp_logs_list.
Use this to start conversations. Use msg91_whatsapp_text_message_send or msg91_whatsapp_interactive_message_send inside the 24-hour window.
Needs the template name and language from msg91_whatsapp_templates_list.

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

Inputs:

- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `language_code` (`string`, required): Template language code. Example: en
- `template_name` (`string`, required): Approved template name. Example: order_shipped
- `to_and_components` (`array`, required): Recipient groups: each entry has a to list of recipient numbers and a components object whose keys name the template parts (header_1, body_1, body_2, button_1...) with a type and value for each. Example: [{"to": ["919876543210"], "components": {"body_1": {"type": "text", "value": "John"}, "body_2": {"type": "text", "value": "ORD-1042"}}}]

Example input: `{"integrated_number":"<integrated_number>","language_code":"<language_code>","template_name":"<template_name>","to_and_components":[]}`

### `msg91_whatsapp_template_update`

Edit WhatsApp Template · Write

Edit the components of an existing WhatsApp template; the edit is sent to Meta for approval again.
Returns status success.
Use this to change a template's text or buttons. Use msg91_whatsapp_templates_list to find the template ID.

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

Inputs:

- `components` (`array`, required): The template's new parts in WhatsApp's format (BODY, HEADER, FOOTER, BUTTONS). Example: [{"type": "BODY", "text": "Hello {{1}}, your code is {{2}}!"}]
- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `template_id` (`string`, required): WhatsApp template ID. Example: 1234567890123456
- `button_url` (`boolean`, optional): Set true when a button URL contains a variable. Example: true

Example input: `{"components":[{"type":"BODY","text":"Hello {{1}}, your code is {{2}}!"}],"integrated_number":"<integrated_number>","template_id":"<template_id>"}`

### `msg91_whatsapp_text_message_send`

Send WhatsApp Text Message · Write

Send a free-form WhatsApp text message to a person or a WhatsApp group from your integrated number.
Returns status success with a request ID.
Use this inside the 24-hour window. Use msg91_whatsapp_template_message_send to start a conversation and msg91_whatsapp_interactive_message_send for buttons, lists and products.

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

Inputs:

- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `recipient_number` (`string`, required): Recipient's WhatsApp number with country code, or a group ID when recipient_type is group. Example: 919876543210
- `text` (`string`, required): Message text. Example: Hi John, your order has shipped.
- `recipient_type` (`string`, optional): Set to group to send to a WhatsApp group ID. Example: group. One of: `group`.

Example input: `{"integrated_number":"<integrated_number>","recipient_number":"<recipient_number>","text":"<text>"}`

### `msg91_whatsapp_typing_indicator_send`

Send WhatsApp Typing Indicator · Write

Show a typing indicator to a customer in reply to one of their incoming WhatsApp messages.
Returns status success.
Use this while preparing a reply to an inbound message.

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

Inputs:

- `message_id` (`string`, required): WhatsApp message ID (wamid) of the incoming message. Example: wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTE=

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

### `msg91_widget_otp_retry`

Retry Widget OTP · Write

Resend a widget OTP on the same or another channel when the user did not receive it.
Returns type success when the OTP is resent.
Use this after msg91_widget_otp_send.

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

Inputs:

- `req_id` (`string`, required): reqId from the msg91_widget_otp_send response. Example: 3664676c7a6f313034383834
- `widget_id` (`string`, required): OTP widget ID. Example: 336a6c6d6a52313136373434
- `retry_channel` (`string`, optional): Channel ID to retry on, as configured in the widget (for example SMS, email, voice or WhatsApp). Leave empty to use the same channel. Example: 11

Example input: `{"req_id":"<req_id>","widget_id":"<widget_id>"}`

### `msg91_widget_otp_send`

Send Widget OTP · Write

Send an OTP to an email address or mobile number through an MSG91 OTP widget, using the widget's configured channels.
Returns type success and a reqId used to retry and verify.
Use this with an OTP widget configured in MSG91. Use msg91_otp_send for template-based SMS OTPs without a widget.

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

Inputs:

- `identifier` (`string`, required): Email address or mobile number in international format with the country code and no plus sign. Example: 919876543210
- `widget_id` (`string`, required): OTP widget ID from the MSG91 OTP widget settings. Example: 336a6c6d6a52313136373434

Example input: `{"identifier":"<identifier>","widget_id":"<widget_id>"}`

### `msg91_widget_otp_verify`

Verify Widget OTP · Write

Verify the OTP a user entered for a widget request.
Returns type success and an access token (JWT) on success.
Use this when the user submits the widget OTP. Validate the token server-side with msg91_widget_access_token_verify.

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

Inputs:

- `otp` (`string`, required): Code the user entered. Example: 482913
- `req_id` (`string`, required): reqId from the msg91_widget_otp_send response. Example: 3664676c7a6f313034383834
- `widget_id` (`string`, required): OTP widget ID. Example: 336a6c6d6a52313136373434

Example input: `{"otp":"<otp>","req_id":"<req_id>","widget_id":"<widget_id>"}`

### `msg91_contacts_delete`

Delete Contacts · Destructive

Delete one or more contacts from a Segmento phonebook.
Returns status success.
Use this for opt-out or erasure requests. Deleted contacts cannot be restored.

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

Inputs:

- `contact_ids` (`array`, required): IDs of the contacts to delete. Example: ["1c68997f-fc55-4ace-9b08-d974db36253f"]
- `phonebook_id` (`string`, required): Segmento phonebook ID. Example: 64f1c2b3a4d5e6f708192a3b

Example input: `{"contact_ids":["1c68997f-fc55-4ace-9b08-d974db36253f"],"phonebook_id":"<phonebook_id>"}`

### `msg91_whatsapp_group_delete`

Delete WhatsApp Group · Destructive

Delete a WhatsApp group owned by your integrated number.
Returns status success.
Use this to close a group for good. Use msg91_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 msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210

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

### `msg91_whatsapp_group_join_requests_reject`

Reject WhatsApp Group Join Requests · Destructive

Reject pending requests to join a WhatsApp group.
Returns status success.
Use this after msg91_whatsapp_group_join_requests_list.

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

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `join_requests` (`array`, required): Join request IDs to reject. Example: ["MTIwMzYzMDI1MjQ2MTI1NDg2"]

Example input: `{"group_id":"<group_id>","integrated_number":"<integrated_number>","join_requests":["MTIwMzYzMDI1MjQ2MTI1NDg2"]}`

### `msg91_whatsapp_group_participants_remove`

Remove WhatsApp Group Participants · Destructive

Remove participants from a WhatsApp group.
Returns status success.
Use this to remove specific members. Use msg91_whatsapp_group_get to see who is in the group.

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

Inputs:

- `group_id` (`string`, required): WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
- `integrated_number` (`string`, required): Your WhatsApp business number connected to MSG91 (the integrated number), with country code and no plus sign. Find it with msg91_whatsapp_numbers_list. Example: 919876543210
- `remove_participants` (`array`, required): Phone numbers of the participants to remove, with country code. Example: ["919812345678"]

Example input: `{"group_id":"<group_id>","integrated_number":"<integrated_number>","remove_participants":["919812345678"]}`

### `msg91_whatsapp_template_delete`

Delete WhatsApp Template · Destructive

Delete a WhatsApp template by name from an integrated number.
Returns status success.
Use this to remove templates you no longer need. Deletion cannot be undone and the name cannot be reused for 30 days on Meta.

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

Inputs:

- `integrated_number` (`string`, required): Integrated WhatsApp number with country code. Example: 919876543210
- `template_name` (`string`, required): Name of the template to delete. Example: order_shipped

Example input: `{"integrated_number":"<integrated_number>","template_name":"<template_name>"}`

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