# SMS Alert

SMS Alert is a versatile multi-channel communication platform enabling businesses to engage with customers through SMS, RCS, Telegram, and WhatsApp via a unified REST API.

- **Category:** phone & sms
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 23
- **Triggers:** 0
- **Slug:** `SMS_ALERT`
- **Version:** 20260316_00

## Tools

### Change User Password

**Slug:** `SMS_ALERT_CHANGE_PASSWORD`

Tool to change the password for the authenticated user account. Use when the user needs to update their account password.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pwd` | string | Yes | Current password for the authenticated user account |
| `cnfpwd` | string | Yes | Confirm new password - must match newpwd exactly |
| `newpwd` | string | Yes | New password to set for the account |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Alert Balance

**Slug:** `SMS_ALERT_GET_BALANCE_CHECK`

Tool to retrieve the current SMS credit balance. Use when you need an up-to-date credit status before sending messages. If balance is low, gate high-volume sends before proceeding — insufficient credits cause messages to be silently dropped or rejected mid-campaign.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Delivery Report

**Slug:** `SMS_ALERT_GET_DELIVERY_REPORT`

Tool to retrieve delivery report for sent SMS messages by batch ID. Returns message delivery status including mobile numbers, delivery status, and timestamps. Use after sending SMS campaigns to track delivery success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | Filter by message text content to search for specific message deliveries |
| `sender` | string | No | Filter by sender ID to retrieve delivery reports for a specific sender |
| `batchid` | string | Yes | Batch ID of the SMS campaign for which to retrieve the delivery report |
| `schedule` | string | No | Filter by schedule status to narrow down the delivery report results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Detail

**Slug:** `SMS_ALERT_GET_GROUP_DETAIL`

Tool to retrieve details of a specific SMS Alert group. Use after confirming the group ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | ID of the group to fetch details |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group List

**Slug:** `SMS_ALERT_GET_GROUP_LIST`

Tool to retrieve a list of SMS Alert groups. Use when you need to fetch all groups associated with your account. Call after authenticating your API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sender ID List

**Slug:** `SMS_ALERT_GET_SENDER_ID_LIST`

Tool to fetch the list of available sender IDs. Use when you need to retrieve all sender IDs associated with your account. Use after configuring your API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Template List

**Slug:** `SMS_ALERT_GET_TEMPLATE_LIST`

Tool to retrieve list of SMS templates from your SmsAlert account. Use when you need to display or manage your SMSAlert templates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_type` | string | No | Filter templates by type, e.g., 'transactional' or 'promotional'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Profile

**Slug:** `SMS_ALERT_GET_USER_PROFILE`

Tool to retrieve user login and profile information. Returns account details including balance, sender IDs, and account status. Use after configuring your API key to fetch complete user profile.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create New Contact

**Slug:** `SMS_ALERT_POST_CREATE_CONTACT`

Create New Contact

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Full name of the contact |
| `group` | string | Yes | Name of the group to which the contact(s) will be added |
| `mobile` | string | Yes | Mobile number(s) as a 10-digit string, comma-separated for multiple contacts |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create New Group

**Slug:** `SMS_ALERT_POST_CREATE_GROUP`

Tool to create a new contact group. Use when needing to organize contacts into a new group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the group to create. Only letters, numbers, hyphens, and underscores are allowed. Spaces are not permitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Short URL

**Slug:** `SMS_ALERT_POST_CREATE_SHORT_URL`

Tool to create a short URL for a given long URL. Use when you need to shorten a URL before sharing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The original long URL to shorten |
| `alias` | string | No | Custom alias for the short URL; omit or set to null for system-generated alias |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SMS Template

**Slug:** `SMS_ALERT_POST_CREATE_TEMPLATE`

Tool to create a new SMS template. Use when you need to define reusable message content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the SMS template |
| `text` | string | Yes | Text content of the SMS template Some regions require regulatory pre-approval of template content and associated sender IDs before use; ensure content complies with local requirements for the target region. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact

**Slug:** `SMS_ALERT_POST_DELETE_CONTACT`

Tool to delete a specified contact. Use after confirming the contact's ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The Contact Number ID of the contact to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group

**Slug:** `SMS_ALERT_POST_DELETE_GROUP`

Tool to delete a specified group. Use after confirming the group's ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the SMS Alert group to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Short URL

**Slug:** `SMS_ALERT_POST_DELETE_SHORT_URL`

Tool to delete an existing short URL. Use after confirming the short URL's ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier (UUID) of the short URL to delete. This ID is returned when creating a short URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SMS Template

**Slug:** `SMS_ALERT_POST_DELETE_TEMPLATE`

Tool to delete an existing SMS template. Use when you have the template ID to remove it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | The unique identifier of the SMS template to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Contact

**Slug:** `SMS_ALERT_POST_EDIT_CONTACT`

Tool to edit an existing contact’s details. Use when you need to update a contact’s information after confirming the contact_id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the contact |
| `email` | string | No | New email address for the contact |
| `group_id` | string | No | ID of the group to assign the contact to |
| `mobileno` | string | No | New mobile number for the contact; must be unique |
| `contact_id` | string | Yes | Unique identifier of the contact to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Group

**Slug:** `SMS_ALERT_POST_EDIT_GROUP`

Tool to edit an existing groups name. Use when you need to rename a group after confirming the group id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the group to update |
| `name` | string | Yes | New name for the group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Profile

**Slug:** `SMS_ALERT_POST_EDIT_PROFILE`

Tool to update user account profile details. Use when modifying authenticated user profile after login.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gst` | string | No | GST number |
| `city` | string | No | City name |
| `email` | string | No | Email address |
| `state` | string | No | State name |
| `address` | string | No | Physical address |
| `company` | string | No | Company name |
| `country` | string | No | Country |
| `pincode` | string | No | Postal PIN code |
| `mobileno` | string | Yes | Registered mobile number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit SMS Template

**Slug:** `SMS_ALERT_POST_EDIT_TEMPLATE`

Tool to edit an existing SMS template. Use when you need to update a template after confirming the template id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the template to update |
| `name` | string | Yes | New name for the template |
| `text` | string | Yes | New SMS content for the template |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate OTP

**Slug:** `SMS_ALERT_POST_GENERATE_OTP`

Tool to generate a one-time password (OTP). Use when you need to send an OTP to a mobile number using a predefined template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sender` | string | No | Sender ID approved by SMS Alert, up to 6 characters |
| `mobileno` | string | Yes | Mobile number(s) to send OTP, comma-separated, with or without country code Digits only — no spaces, dashes, or special characters. Country code required (e.g., '91' prefix for India). |
| `template` | string | Yes | Template for OTP containing the [otp] tag, e.g., '[otp]' The `[otp]` placeholder is case-sensitive and must appear exactly as shown with brackets; omitting it prevents OTP injection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sent SMS Report

**Slug:** `SMS_ALERT_POST_SENT_SMS_REPORT`

Tool to retrieve SMS campaign sent report details. Use after campaigns are sent to analyze delivery results. Delivery status data may lag real time; treat results as non-final for time-sensitive workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for results (≥ 1) |
| `limit` | integer | No | Records per page (≥ 1) |
| `mobile` | string | No | Comma-separated mobile numbers to filter the report |
| `campaignuniqueid` | string | No | Filter by specific campaign unique ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send SMS via XML

**Slug:** `SMS_ALERT_SEND_SMS_XML`

Tool to send SMS messages using XML format for bulk sending. Use when you need to send multiple messages to different recipients with different content in a single API call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | List of SMS messages to send. Each message can have multiple recipients with the same text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |