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.
- Tools
- 67
- What they doRead · write · destructive
- 31 · 31 · 531 read31 write5 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the MSG91 connection
In AgentKit > Connections, create a MSG91 connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'msg91'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'msg91_email_analytics_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "msg91"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="msg91_email_analytics_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their MSG91 credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolmsg91_contacts_searchSearch and filter the contacts of a Segmento phonebook with free text and field rules, with paging and sorting.Read-onlySearch Contacts
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.
Inputs
phonebook_idstringrequired- Segmento phonebook ID. Example: 64f1c2b3a4d5e6f708192a3b
columnsarray- Columns to return. Example: ["Contact_id", "Name", "Email", "Phonenumber"]
items_per_pageinteger- Contacts per page. Example: 100
page_nointeger- Page number, starting at 1. Example: 1
queryobject- 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"}]}
searchstring- Free-text search. Example: john
sort_bystring- Field to sort by. Example: Name
sort_orderstring- Sort direction. Example: descone of
ascdesc
msg91_email_analytics_getGet aggregated email statistics for a date range of up to the last 31 days.Read-onlyGet Email Analytics
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.
Inputs
end_datestring- End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
start_datestring- Start date in YYYY-MM-DD format. Example: 2026-11-01
msg91_email_css_inlineConvert an HTML email's CSS into inline styles so it renders in email clients.Read-onlyInline Email CSS
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.
Inputs
htmlstringrequired- HTML to inline. Example: <style>h1{color:#c00}</style><h1>Hello</h1>
msg91_email_logs_listList per-message email delivery logs for up to 3 days within the last 3 days.Read-onlyList Email Logs
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.
Inputs
end_datestringrequired- End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
start_datestringrequired- Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11
msg91_email_template_version_getGet one version of an email template, including its subject and HTML body.Read-onlyGet Email Template Version
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.
Inputs
version_idstringrequired- Template version ID. Example: 12345
withstring- Set to template to include the parent template. Example: template
msg91_email_templates_listList the email templates in your MSG91 account, optionally searched by keyword and filtered by status.Read-onlyList Email Templates
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.
Inputs
keywordstring- Search text. Example: welcome
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Templates per page. Example: 25
search_instring- Field to search the keyword in, for example name. Example: name
status_idinteger- Only return templates with this status ID. Example: 2
withstring- Related data to include, for example versions. Example: versions
msg91_otp_analytics_getGet aggregated OTP statistics for a date range of up to the last 31 days.Read-onlyGet OTP Analytics
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.
Inputs
end_datestring- End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
start_datestring- Start date in YYYY-MM-DD format. Example: 2026-11-01
msg91_otp_logs_listList per-message OTP delivery logs for up to 3 days within the last 3 days.Read-onlyList OTP Logs
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.
Inputs
end_datestringrequired- End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
start_datestringrequired- Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11
msg91_phonebook_fields_getGet the fields of a Segmento phonebook, built-in and custom, with their types.Read-onlyGet Phonebook Fields
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.
Inputs
phonebook_idstringrequired- Segmento phonebook ID. Example: 64f1c2b3a4d5e6f708192a3b
msg91_rcs_analytics_getGet aggregated RCS statistics for a date range of up to the last 31 days.Read-onlyGet RCS Analytics
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.
Inputs
end_datestring- End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
start_datestring- Start date in YYYY-MM-DD format. Example: 2026-11-01
msg91_rcs_balance_getGet the prepaid RCS balance of your MSG91 account.Read-onlyGet RCS Prepaid Balance
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.
Inputs
This tool takes no inputs.
msg91_rcs_logs_listList per-message RCS delivery logs for up to 3 days within the last 3 days, optionally for one request ID.Read-onlyList RCS Logs
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.
Inputs
end_datestringrequired- End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
start_datestringrequired- Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11
fieldsstring- Comma-separated list of columns to return, without spaces. Example: status,customerNumber,deliveryTime
limitinteger- Maximum rows to return. Defaults to 1000. Example: 1000
request_idstring- Only return logs for this request ID (returned by the send call). Example: 3664676c7a6f313034383834
msg91_rcs_templates_listList the RCS templates of a project with a given approval status.Read-onlyList RCS Templates
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.
Inputs
project_idstringrequired- Your RCS project (agent) ID. Example: 1a6caf23-0c6c-4b41-8fe2-1c28bb694335
statusstringrequired- Template status to filter by, for example approved. Example: approved
msg91_sms_analytics_getGet aggregated SMS statistics for a date range of up to the last 31 days.Read-onlyGet SMS Analytics
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.
Inputs
end_datestring- End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
start_datestring- Start date in YYYY-MM-DD format. Example: 2026-11-01
msg91_sms_logs_listList per-message SMS delivery logs for up to 3 days within the last 3 days, optionally for one request ID.Read-onlyList SMS Logs
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.
Inputs
end_datestringrequired- End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
start_datestringrequired- Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11
fieldsstring- Comma-separated list of columns to return, without spaces. Example: status,customerNumber,deliveryTime
limitinteger- Maximum rows to return. Defaults to 1000. Example: 1000
request_idstring- Only return logs for this request ID (returned by the send call). Example: 3664676c7a6f313034383834
msg91_sms_template_getGet one SMS template with all its versions, their content, sender ID, DLT template ID and approval status.Read-onlyGet SMS Template Versions
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.
Inputs
template_idstringrequired- SMS template ID. Example: 63f1a2b4d6fc0560a1234567
msg91_sms_templates_listList the SMS templates (flows) in your MSG91 account.Read-onlyList SMS Templates
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.
Inputs
This tool takes no inputs.
msg91_voice_analytics_getGet aggregated voice statistics for a date range of up to the last 31 days.Read-onlyGet Voice Analytics
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.
Inputs
end_datestring- End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
start_datestring- Start date in YYYY-MM-DD format. Example: 2026-11-01
msg91_voice_call_logs_listList the call logs of your voice account, one record per call.Read-onlyList Voice Call Logs
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.
Inputs
This tool takes no inputs.
msg91_voice_call_recording_getGet a temporary download link for a call's recording.Read-onlyGet Voice Call Recording Link
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.
Inputs
uuidstringrequired- Call uuid from msg91_voice_call_logs_list. Example: b7f6c2a1-3d4e-4f50-8a9b-0c1d2e3f4a5b
expiryinteger- Link lifetime in seconds, up to 604800 (7 days). Example: 3600
msg91_voice_files_listList the pre-recorded voice files uploaded to your MSG91 account.Read-onlyList Voice Files
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.
Inputs
page_sizeinteger- Files per page. Example: 100
msg91_voice_templates_listList voice templates, or get one by ID.Read-onlyList Voice Templates
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.
Inputs
idstring- Return only the template with this ID. Example: 1024
page_numinteger- Page number, starting at 1. Example: 1
page_sizeinteger- Templates per page. Example: 25
sort_bystring- Sort field; only name is supported. Example: nameone of
name sort_orderstring- Sort direction. Example: ascone of
ascdesc
msg91_whatsapp_analytics_getGet aggregated WhatsApp statistics for a date range of up to the last 31 days.Read-onlyGet WhatsApp Analytics
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.
Inputs
end_datestring- End date in YYYY-MM-DD format; the range can cover at most the last 31 days. Example: 2026-11-13
start_datestring- Start date in YYYY-MM-DD format. Example: 2026-11-01
msg91_whatsapp_balance_getGet the prepaid WhatsApp balance for an integrated number.Read-onlyGet WhatsApp Prepaid Balance
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.
Inputs
integrated_numberstringrequired- 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
msg91_whatsapp_group_getGet one WhatsApp group's details: subject, description, participants and invite link.Read-onlyGet WhatsApp Group
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.
Inputs
group_idstringrequired- WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
integrated_numberstringrequired- Integrated WhatsApp number that owns the group. Example: 919876543210
timezonestring- Timezone offset for timestamps in the response, for example +05:30. Example: +05:30
msg91_whatsapp_group_join_requests_listList pending requests to join a WhatsApp group.Read-onlyList WhatsApp Group Join Requests
List pending requests to join a WhatsApp group. Returns join requests with their request IDs and phone numbers. Use this before approving or rejecting with msg91_whatsapp_group_join_requests_approve or _reject.
Inputs
group_idstringrequired- WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
integrated_numberstringrequired- Integrated WhatsApp number that owns the group. Example: 919876543210
timezonestring- Timezone offset for timestamps in the response, for example +05:30. Example: +05:30
msg91_whatsapp_groups_listList the WhatsApp groups of an integrated number.Read-onlyList WhatsApp Groups
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.
Inputs
integrated_numberstringrequired- Integrated WhatsApp number with country code. Example: 919876543210
timezonestring- Timezone offset for timestamps in the response, for example +05:30. Example: +05:30
msg91_whatsapp_logs_listList per-message WhatsApp delivery logs for up to 3 days within the last 3 days, optionally for one request ID.Read-onlyList WhatsApp Logs
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.
Inputs
end_datestringrequired- End date in YYYY-MM-DD format; at most 3 days after start_date. Example: 2026-11-13
start_datestringrequired- Start date in YYYY-MM-DD format; it must be within the last 3 days. Example: 2026-11-11
fieldsstring- Comma-separated list of columns to return, without spaces. Example: status,customerNumber,deliveryTime
limitinteger- Maximum rows to return. Defaults to 1000. Example: 1000
request_idstring- Only return logs for this request ID (returned by the send call). Example: 3664676c7a6f313034383834
msg91_whatsapp_numbers_listList the WhatsApp business numbers activated on your MSG91 account.Read-onlyList WhatsApp Numbers
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.
Inputs
This tool takes no inputs.
msg91_whatsapp_templates_listList the WhatsApp templates of an integrated number, optionally filtered by name, status or language (up to 500).Read-onlyList WhatsApp Templates
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.
Inputs
integrated_numberstringrequired- Integrated WhatsApp number with country code. Example: 919876543210
page_numinteger- Page number when pagination is true, starting at 1. Example: 1
page_sizeinteger- Templates per page when pagination is true. Example: 50
paginationboolean- Set true, together with page_size and page_num, to page the results. Example: true
template_languagestring- Only return templates in this language. Example: en
template_namestring- Only return templates with this name. Example: order_shipped
template_statusstring- Only return templates with this status. Example: approvedone of
approvedrejectedpending
msg91_widget_access_token_verifyValidate the access token a client received after verifying a widget OTP, on your server.Read-onlyVerify Widget Access Token
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.
Inputs
access_tokenstringrequired- JWT access token returned by the widget's OTP verification. Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0SWQiOiIzNjY0In0.sig
msg91_campaign_runLaunch an existing MSG91 campaign for the recipients you pass, across the campaign's channels (SMS, email, WhatsApp, voice), now or at a scheduled time.WriteLaunch Campaign
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.
Inputs
campaign_slugstringrequired- Campaign slug from the MSG91 Campaign panel. Example: order-confirmation
dataobjectrequired- 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_forstring- Run later at this time, in YYYY-MM-DD H:i format. Example: 2026-11-20 10:30
timezonestring- Timezone for schedule_for. Defaults to Asia/Kolkata. Example: Asia/Kolkata
timezone_bystring- Whose timezone to use for scheduling. Example: companyone of
companycontactmanual
msg91_contact_upsertAdd a contact to a Segmento phonebook, or update it when a contact with the same contact_id exists.WriteCreate or Update Contact
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.
Inputs
contactobjectrequired- 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_idstringrequired- Segmento phonebook ID. Example: 64f1c2b3a4d5e6f708192a3b
create_fieldsboolean- Set false to stop unknown keys from creating new phonebook fields. Defaults to true. Example: false
msg91_email_sendSend 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.WriteSend Email
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.
Inputs
domainstringrequired- Sending domain registered with MSG91; it signs DKIM. Example: mail.acme.com
fromobjectrequired- Sender: an object with the email on your registered domain and a display name. Example: {"name": "Acme", "email": "no-reply@mail.acme.com"}
recipientsarrayrequired- 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_idstringrequired- Email template ID (slug) from msg91_email_templates_list. Example: welcome_email
attachmentsarray- 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_toarray- Reply-to addresses, each an object with an email. Example: [{"email": "support@acme.com"}]
msg91_email_template_createCreate an HTML email template with a subject and body that can use {{variables}}.WriteCreate Email Template
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.
Inputs
bodystringrequired- HTML body; can use {{variables}}. Example: <html><body><h1>Hello {{first_name}}</h1></body></html>
namestringrequired- Template name. Example: Welcome email
subjectstringrequired- Subject line; can use {{variables}}. Example: Welcome {{first_name}}
slugstring- Unique template ID to use. Generated from the name when empty. Example: welcome_email
msg91_email_validateCheck whether an email address is valid and deliverable before you send to it.WriteValidate Email Address
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.
Inputs
emailstringrequired- Email address to validate. Example: john@example.com
msg91_oneapi_flow_runRun a One API flow, which sends over the channels, templates and priority order configured for that flow in MSG91.WriteRun One API Flow
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.
Inputs
dataobjectrequired- 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_slugstringrequired- One API flow slug from the MSG91 panel. Example: otp-fallback-flow
msg91_otp_resendResend the same OTP to a mobile number by voice call or text message.WriteResend OTP
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.
- Idempotent
Inputs
mobilestringrequired- The mobile number in international format with the country code and no plus sign the OTP was sent to. Example: 919876543210
retrytypestring- Channel to resend on: voice (the default) or text. Example: textone of
voicetext
msg91_otp_sendGenerate an OTP and send it by SMS to a mobile number using an OTP template; MSG91 stores it and handles expiry.WriteSend OTP
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.
Inputs
mobilestringrequired- Recipient mobile number in international format with the country code and no plus sign. Example: 919876543210
template_idstringrequired- OTP template ID from the OTP section of MSG91; the template must contain ##OTP##. Example: 63f1a2b4d6fc0560a7654321
otpstring- Your own OTP value to send instead of a generated one. Example: 482913
otp_expiryinteger- Minutes before the code expires, 1 to 10080. Defaults to 15. Example: 10
otp_lengthinteger- Number of digits, 4 to 9. Defaults to 4. Example: 6
paramsobject- Values for the template's other variables (Param1, Param2...), case sensitive. Sent as the JSON body. Example: {"Param1": "Acme", "Param2": "login"}
unicodestring- Set 1 for templates in a non-English script. Example: 1one of
01
msg91_otp_template_updateUpdate the content, DLT template ID or sender ID of an OTP template.WriteUpdate OTP Template
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.
- Idempotent
Inputs
template_idstringrequired- OTP template ID. Example: 63f1a2b4d6fc0560a7654321
dlt_template_idstring- DLT template ID registered for this content (India). Example: 1207168000000000000
sender_idstring- Sender ID to send from. Example: ACMEIN
templatestring- New template content, including ##OTP##. Example: ##OTP## is your Acme login code. Valid for 10 minutes.
msg91_otp_verifyCheck the code a user entered against the OTP sent to their mobile number by msg91_otp_send.WriteVerify OTP
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.
- Idempotent
Inputs
mobilestringrequired- The mobile number in international format with the country code and no plus sign the OTP was sent to. Example: 919876543210
otpstringrequired- Code the user entered. Example: 482913
msg91_rcs_message_sendSend 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.WriteSend RCS Message
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.
Inputs
contentobjectrequired- 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_numbersarrayrequired- Recipient numbers with country code and no plus sign. Example: ["919876543210"]
function_namestringrequired- Message type. Example: text_messageone of
text_messagemediarich_cardcarouselsuggested_repliesdialopen_urlview_locationshare_locationcalendar_event project_idstringrequired- Your RCS project (agent) ID from the MSG91 RCS panel. Example: 1a6caf23-0c6c-4b41-8fe2-1c28bb694335
ttlstring- Time to live in seconds, 1 to 1296000. Example: 86400
msg91_rcs_template_createCreate a reusable RCS template (text, rich card, carousel, suggested replies, dial, open URL, view or share location, or calendar event) for approval.WriteCreate RCS Template
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.
Inputs
contentobjectrequired- 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_namestringrequired- Template type. Example: text_messageone of
text_messagerich_cardcarouselsuggested_repliesdialopen_urlview_locationshare_locationcalendar_event project_idstringrequired- Your RCS project (agent) ID from the MSG91 RCS panel. Example: 1a6caf23-0c6c-4b41-8fe2-1c28bb694335
template_namestringrequired- Unique template name. Example: order_update
click_countboolean- Track clicks on the URL (open_url templates). Example: true
languagestring- Template language code. Example: en
ttlstring- Time to live in seconds, 1 to 1296000. Example: 86400
msg91_rcs_template_message_sendSend an approved RCS template to groups of numbers, each group with its own variable values.WriteSend RCS Template Message
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.
Inputs
customer_number_variablesarrayrequired- 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_namestringrequired- The template's message type, as shown in msg91_rcs_templates_list. Example: text_message
namestringrequired- Template name. Example: order_update
namespacestringrequired- Template namespace from msg91_rcs_templates_list. Example: a1b2c3d4_order_update
project_idstringrequired- Your RCS project (agent) ID from the MSG91 RCS panel. Example: 1a6caf23-0c6c-4b41-8fe2-1c28bb694335
ttlstring- Time to live in seconds, 1 to 1296000. Example: 86400
msg91_sms_sendSend a DLT-approved SMS template to one or more mobile numbers, each with its own variable values, optionally scheduled or with URL shortening.WriteSend SMS
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.
Inputs
recipientsarrayrequired- 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_idstringrequired- SMS template ID from your MSG91 account. Example: 63f1a2b4d6fc0560a1234567
real_time_responsestring- 1 to get delivery details in the response where available. Example: 1one of
01 schtimestring- 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_urlstring- 1 to shorten and track URLs in the message, 0 to leave them as they are. Example: 1one of
01 short_url_expirystring- Lifetime of shortened URLs in seconds. Example: 86400
msg91_sms_template_version_activateMake one approved version of an SMS template the default, so new sends with that template ID use its content.WriteMake SMS Template Version Default
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.
- Idempotent
Inputs
template_idstringrequired- SMS template ID. Example: 63f1a2b4d6fc0560a1234567
version_idstringrequired- ID of the template version to make default. Example: 6501b2c3d4e5f60718293a4b
msg91_voice_click_to_callBridge a call between a first party and one or more other numbers through your MSG91 caller ID, without showing anyone's number.WriteStart Click-to-Call
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.
Inputs
caller_idstringrequired- Your MSG91 voice number shown to all parties, with country code. Example: 918071234567
destinationstringrequired- First number to call, with country code and no plus sign. Example: 919876543210
destination_barrayrequired- Numbers to connect once the first party answers. Example: ["919812345678"]
expire_timestring- Seconds after which the request expires if it has not connected. Example: 120
msg91_voice_flow_callCall a number and run an IVR flow built in your MSG91 account.WriteRun IVR Flow Call
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.
Inputs
caller_idstringrequired- Your MSG91 voice number (caller ID) with country code. Example: 918071234567
client_numberstringrequired- Customer's mobile number in international format with the country code and no plus sign. Example: 919876543210
flowstringrequired- IVR flow name from your MSG91 account. Example: delivery_confirmation
callback_urlstring- URL MSG91 calls with the call status. Example: https://api.acme.com/msg91/voice-status
variablesobject- 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"}}
msg91_voice_template_callCall a customer and play a voice template (text-to-speech with variables) from your caller ID.WriteSend Voice Message
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.
Inputs
caller_idstringrequired- Your MSG91 voice number (caller ID) with country code. Example: 918071234567
client_numberstringrequired- Customer's mobile number in international format with the country code and no plus sign. Example: 919876543210
templatestringrequired- Voice template name. Example: order_update_voice
callback_urlstring- URL MSG91 calls with the call status. Example: https://api.acme.com/msg91/voice-status
variablesobject- 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"}}
msg91_voice_template_createCreate a voice template from spoken text, pre-recorded files and variables, read by a text-to-speech voice.WriteCreate Voice Template
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.
Inputs
namestringrequired- Template name. Example: order_update_voice
structurearrayrequired- 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_namestringrequired- Text-to-speech voice, for example en-IN-Standard-A. Example: en-IN-Standard-A
has_variableboolean- Set true when the structure has var parts. Example: true
msg91_whatsapp_group_createCreate a WhatsApp group owned by your integrated number.WriteCreate WhatsApp Group
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.
Inputs
integrated_numberstringrequired- 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
subjectstringrequired- Group name. Example: Acme VIP customers
descriptionstring- Group description. Example: Early access to offers
join_approval_modestring- Whether people joining by link need approval, for example approval_required. Example: approval_required
msg91_whatsapp_group_invite_link_resetReset a WhatsApp group's invite link so the old link stops working.WriteReset WhatsApp Group Invite Link
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.
Inputs
group_idstringrequired- WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
integrated_numberstringrequired- Integrated WhatsApp number that owns the group. Example: 919876543210
msg91_whatsapp_group_join_requests_approveApprove pending requests to join a WhatsApp group.WriteApprove WhatsApp Group Join Requests
Approve pending requests to join a WhatsApp group. Returns status success. Use this after msg91_whatsapp_group_join_requests_list.
Inputs
group_idstringrequired- WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
integrated_numberstringrequired- 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_requestsarrayrequired- Join request IDs to approve. Example: ["MTIwMzYzMDI1MjQ2MTI1NDg2"]
msg91_whatsapp_interactive_message_sendSend an interactive WhatsApp message: reply buttons, a list menu, a location request, a single product, a multi-product list or a payment link.WriteSend WhatsApp Interactive Message
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.
Inputs
integrated_numberstringrequired- 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
interactiveobjectrequired- 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_numberstringrequired- Recipient's WhatsApp number with country code. Example: 919876543210
msg91_whatsapp_template_createCreate a WhatsApp message template with positional variables ({{1}}, {{2}}...) and submit it to Meta for approval.WriteCreate WhatsApp Template
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.
Inputs
categorystringrequired- Template category. Example: UTILITYone of
MARKETINGUTILITYAUTHENTICATION componentsarrayrequired- 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_numberstringrequired- 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
languagestringrequired- Template language code. Example: en
template_namestringrequired- Template name: lowercase letters, numbers and underscores. Example: order_shipped
button_urlboolean- Set true when a button URL contains a variable. Example: true
msg91_whatsapp_template_message_sendSend an approved WhatsApp template to one or many recipients from your integrated number, with per-recipient variable values.WriteSend WhatsApp Template Message
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.
Inputs
integrated_numberstringrequired- 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_codestringrequired- Template language code. Example: en
template_namestringrequired- Approved template name. Example: order_shipped
to_and_componentsarrayrequired- 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"}}}]
msg91_whatsapp_template_updateEdit the components of an existing WhatsApp template; the edit is sent to Meta for approval again.WriteEdit WhatsApp Template
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.
- Idempotent
Inputs
componentsarrayrequired- The template's new parts in WhatsApp's format (BODY, HEADER, FOOTER, BUTTONS). Example: [{"type": "BODY", "text": "Hello {{1}}, your code is {{2}}!"}]
integrated_numberstringrequired- 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_idstringrequired- WhatsApp template ID. Example: 1234567890123456
button_urlboolean- Set true when a button URL contains a variable. Example: true
msg91_whatsapp_text_message_sendSend a free-form WhatsApp text message to a person or a WhatsApp group from your integrated number.WriteSend WhatsApp Text Message
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.
Inputs
integrated_numberstringrequired- 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_numberstringrequired- Recipient's WhatsApp number with country code, or a group ID when recipient_type is group. Example: 919876543210
textstringrequired- Message text. Example: Hi John, your order has shipped.
recipient_typestring- Set to group to send to a WhatsApp group ID. Example: groupone of
group
msg91_whatsapp_typing_indicator_sendShow a typing indicator to a customer in reply to one of their incoming WhatsApp messages.WriteSend WhatsApp Typing Indicator
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.
Inputs
message_idstringrequired- WhatsApp message ID (wamid) of the incoming message. Example: wamid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQTE=
msg91_widget_otp_retryResend a widget OTP on the same or another channel when the user did not receive it.WriteRetry Widget OTP
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.
Inputs
req_idstringrequired- reqId from the msg91_widget_otp_send response. Example: 3664676c7a6f313034383834
widget_idstringrequired- OTP widget ID. Example: 336a6c6d6a52313136373434
retry_channelstring- 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
msg91_widget_otp_sendSend an OTP to an email address or mobile number through an MSG91 OTP widget, using the widget's configured channels.WriteSend Widget OTP
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.
Inputs
identifierstringrequired- Email address or mobile number in international format with the country code and no plus sign. Example: 919876543210
widget_idstringrequired- OTP widget ID from the MSG91 OTP widget settings. Example: 336a6c6d6a52313136373434
msg91_widget_otp_verifyVerify the OTP a user entered for a widget request.WriteVerify Widget OTP
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.
Inputs
otpstringrequired- Code the user entered. Example: 482913
req_idstringrequired- reqId from the msg91_widget_otp_send response. Example: 3664676c7a6f313034383834
widget_idstringrequired- OTP widget ID. Example: 336a6c6d6a52313136373434
msg91_contacts_deleteDelete one or more contacts from a Segmento phonebook.DestructiveDelete Contacts
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.
- Idempotent
Inputs
contact_idsarrayrequired- IDs of the contacts to delete. Example: ["1c68997f-fc55-4ace-9b08-d974db36253f"]
phonebook_idstringrequired- Segmento phonebook ID. Example: 64f1c2b3a4d5e6f708192a3b
msg91_whatsapp_group_deleteDelete a WhatsApp group owned by your integrated number.DestructiveDelete WhatsApp Group
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.
- Idempotent
Inputs
group_idstringrequired- WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
integrated_numberstringrequired- 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
msg91_whatsapp_group_join_requests_rejectReject pending requests to join a WhatsApp group.DestructiveReject WhatsApp Group Join Requests
Reject pending requests to join a WhatsApp group. Returns status success. Use this after msg91_whatsapp_group_join_requests_list.
- Idempotent
Inputs
group_idstringrequired- WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
integrated_numberstringrequired- 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_requestsarrayrequired- Join request IDs to reject. Example: ["MTIwMzYzMDI1MjQ2MTI1NDg2"]
msg91_whatsapp_group_participants_removeRemove participants from a WhatsApp group.DestructiveRemove WhatsApp Group Participants
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.
- Idempotent
Inputs
group_idstringrequired- WhatsApp group ID, from msg91_whatsapp_groups_list. Example: 120363025246125486@g.us
integrated_numberstringrequired- 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_participantsarrayrequired- Phone numbers of the participants to remove, with country code. Example: ["919812345678"]
msg91_whatsapp_template_deleteDelete a WhatsApp template by name from an integrated number.DestructiveDelete WhatsApp Template
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.
- Idempotent
Inputs
integrated_numberstringrequired- Integrated WhatsApp number with country code. Example: 919876543210
template_namestringrequired- Name of the template to delete. Example: order_shipped
No tools match.