/msg91 | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
msg91_get_otp_analytics | Get OTP analytics |
msg91_get_otp_logs | Get OTP delivery logs |
msg91_get_sms_analytics | Get SMS analytics |
msg91_get_sms_logs | Get SMS delivery logs |
msg91_get_sms_template_versions | Get SMS template versions |
msg91_list_email_templates | List email templates |
msg91_retry_otp | Resend OTP |
msg91_send_email | Send email |
msg91_send_otp | Send OTP |
msg91_send_sms | Send SMS via flow |
msg91_send_whatsapp_message | Send WhatsApp outbound message |
msg91_verify_otp | Verify OTP |
msg91_get_otp_analytics
Get OTP analytics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fromDate | string | No | — | Start date (YYYY-MM-DD). |
toDate | string | No | — | End date (YYYY-MM-DD). |
country | string | No | — | Filter by destination country code. |
msg91_get_otp_logs
Get OTP delivery logs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fromDate | string | No | — | Start date (YYYY-MM-DD). |
toDate | string | No | — | End date (YYYY-MM-DD). |
mobile | string | No | — | Filter by recipient mobile number. |
requestId | string | No | — | Filter by a specific OTP request id. |
status | string | No | — | Filter by status (e.g. delivered, failed, verified). |
page | integer | No | — | Page number for paginated results. |
limit | integer | No | — | Maximum number of records per page. |
msg91_get_sms_analytics
Get SMS analytics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fromDate | string | No | — | Start date (YYYY-MM-DD) for the analytics window. |
toDate | string | No | — | End date (YYYY-MM-DD) for the analytics window. |
route | string | No | — | Filter analytics by SMS route (e.g. transactional, promotional). |
country | string | No | — | Filter analytics by destination country code. |
smsType | string | No | — | Filter by SMS type (e.g. domestic, international). |
msg91_get_sms_logs
Get SMS delivery logs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fromDate | string | No | — | Start date (YYYY-MM-DD) for the log window. |
toDate | string | No | — | End date (YYYY-MM-DD) for the log window. |
mobile | string | No | — | Filter logs by recipient mobile number (with country code, no plus). |
requestId | string | No | — | Filter logs to a specific request id returned by the send call. |
templateId | string | No | — | Filter logs by SMS template id. |
status | string | No | — | Filter by delivery status (e.g. delivered, failed, submitted). |
page | integer | No | — | Page number for paginated results. |
limit | integer | No | — | Maximum number of records per page. |
msg91_get_sms_template_versions
Get SMS template versions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | string | Yes | — | The SMS template id whose versions you want to fetch. |
msg91_list_email_templates
List email templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for paginated results. |
limit | integer | No | — | Maximum number of templates per page. |
msg91_retry_otp
Resend OTP Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mobile | string | Yes | — | Mobile number the OTP was originally sent to. |
retrytype | string | No | — | Channel for the retry: “text” to resend via SMS, “voice” to deliver via voice call. |
msg91_send_email
Send email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attachments | object[] | No | — | Optional file attachments. |
domain | string | No | — | Sender domain configured in Msg91 (e.g. mail.example.com). |
from | object | Yes | — | Sender details. Must use a verified Msg91 sender domain. |
recipients | object[] | Yes | — | List of recipients. Each entry has a to array of recipient objects and optional per-recipient variables for template substitution. |
subject | string | No | — | Subject line of the email. Optional if a template_id supplies one. |
template_id | string | No | — | Msg91 email template id. Optional if you supply inline subject + body. |
msg91_send_otp
Send OTP Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | string | Yes | — | Msg91 OTP template id (DLT-approved). Required. |
mobile | string | Yes | — | Recipient mobile number with country code, no plus sign (e.g. 919XXXXXXXXX). Required. |
otp | string | No | — | Specific OTP to send. If omitted, Msg91 generates one based on the template’s otp_length. |
otp_length | integer | No | — | Length of the auto-generated OTP (4-9 digits). Ignored if otp is supplied. |
otp_expiry | integer | No | — | OTP validity period in minutes. |
sender | string | No | — | Sender id to use for this OTP send. |
msg91_send_sms
Send SMS via flow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
realTimeResponse | string | No | — | Set to “1” to receive a real-time delivery response in the API result, “0” otherwise. |
recipients | object[] | Yes | — | List of recipient objects. Each recipient must include a mobiles field (E.164-style number with country code, e.g. 919XXXXXXXXX) and any per-recipient template variables (VAR1, VAR2, …). |
sender | string | No | — | Sender ID to use for this send. If omitted, the template’s default sender is used. |
short_url | string | No | — | Set to “1” to enable short-url tracking, “0” to disable. Optional. |
short_url_expiry | string | No | — | Expiry for the tracked short URL, e.g. “1 day” or “2 hours”. Only relevant when short_url is enabled. |
template_id | string | Yes | — | The Msg91 flow / SMS template id (DLT-approved). Find this in the Msg91 dashboard under SMS > Templates. |
msg91_send_whatsapp_message
Send WhatsApp outbound message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content_type | string | Yes | — | Always “template” for outbound WhatsApp Business messages. |
integrated_number | string | Yes | — | Your Msg91-registered WhatsApp Business phone number (without plus, with country code). |
payload | object | Yes | — | Message payload describing the template, recipient(s), and template parameters. |
msg91_verify_otp
Verify OTP Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mobile | string | Yes | — | Mobile number the OTP was sent to (with country code, no plus sign). |
otp | string | Yes | — | OTP value entered by the user, to be verified. |

