> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

![SMS Alert logo](https://mintcdn.com/composio-preview/B09iGux45A5cYDuO/images/toolkits/sms_alert.svg?fit=max\&auto=format\&n=B09iGux45A5cYDuO\&q=85\&s=6ece6a1758bddc12b31a6ac35785fb79)

* **Category:** phone & sms
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 23
* **Triggers:** 0
* **Slug:** `SMS_ALERT`
* **Version:** 20261101\_00

## Tools

> [accordion] 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
>
> **pwd** `string` *required*
>
> Current password for the authenticated user account
>
> **cnfpwd** `string` *required*
>
> Confirm new password - must match newpwd exactly
>
> **newpwd** `string` *required*
>
> New password to set for the account
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS Delivery Report
>
> **Slug:** `SMS_ALERT_GET_DELIVERY_REPORT`
>
> Retrieve an SMS delivery report by batch ID to track campaign delivery. The provider requires a batch ID for messages sent in the last three days; report entries may include mobile numbers, delivery statuses and timestamps.
>
> #### Input Parameters
>
> **text** `string`
>
> Filter by message text content to search for specific message deliveries
>
> **sender** `string`
>
> Filter by sender ID to retrieve delivery reports for a specific sender
>
> **batchid** `string` *required*
>
> Batch ID of the SMS campaign for which to retrieve the delivery report
>
> **schedule** `string`
>
> Filter by schedule status to narrow down the delivery report results
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Group Detail
>
> **Slug:** `SMS_ALERT_GET_GROUP_DETAIL`
>
> Retrieve the contacts in a specific SMS Alert group by group ID. A group with no contacts is returned as an empty list.
>
> #### Input Parameters
>
> **group\_id** `integer` *required*
>
> ID of the group to fetch details
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **template\_type** `string`
>
> Filter templates by type, e.g., 'transactional' or 'promotional'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Profile
>
> **Slug:** `SMS_ALERT_GET_USER_PROFILE`
>
> Retrieve user login and profile information for the configured SMS Alert account, including contact and account verification details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create New Contact
>
> **Slug:** `SMS_ALERT_POST_CREATE_CONTACT`
>
> Create New Contact
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Full name of the contact
>
> **group** `string` *required*
>
> Name of the group to which the contact(s) will be added
>
> **mobile** `string` *required*
>
> Mobile number(s) as a 10-digit string, comma-separated for multiple contacts
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Name of the group to create. Only letters, numbers, hyphens, and underscores are allowed. Spaces are not permitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **url** `string` *required*
>
> The original long URL to shorten
>
> **alias** `string`
>
> Custom alias for the short URL; omit or set to null for system-generated alias
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Name of the SMS template
>
> **text** `string` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Contact
>
> **Slug:** `SMS_ALERT_POST_DELETE_CONTACT`
>
> Tool to delete a specified contact. Use after confirming the contact's ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The Contact Number ID of the contact to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Group
>
> **Slug:** `SMS_ALERT_POST_DELETE_GROUP`
>
> Tool to delete a specified group. Use after confirming the group's ID.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the SMS Alert group to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the short URL to delete. This ID is returned when creating a short URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **template\_id** `string` *required*
>
> The unique identifier of the SMS template to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> New name for the contact
>
> **email** `string`
>
> New email address for the contact
>
> **group\_id** `string`
>
> ID of the group to assign the contact to
>
> **mobileno** `string`
>
> New mobile number for the contact; must be unique
>
> **contact\_id** `string` *required*
>
> Unique identifier of the contact to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Edit Group
>
> **Slug:** `SMS_ALERT_POST_EDIT_GROUP`
>
> Tool to edit an existing groups name. Use when you need to rename a group after confirming the group id.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the group to update
>
> **name** `string` *required*
>
> New name for the group
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **gst** `string`
>
> GST number
>
> **city** `string`
>
> City name
>
> **email** `string`
>
> Email address
>
> **state** `string`
>
> State name
>
> **address** `string`
>
> Physical address
>
> **company** `string`
>
> Company name
>
> **country** `string`
>
> Country
>
> **pincode** `string`
>
> Postal PIN code
>
> **mobileno** `string` *required*
>
> Registered mobile number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> Unique identifier of the template to update
>
> **name** `string` *required*
>
> New name for the template
>
> **text** `string` *required*
>
> New SMS content for the template
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sender** `string`
>
> Sender ID approved by SMS Alert, up to 6 characters
>
> **mobileno** `string` *required*
>
> 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` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Sent SMS Report
>
> **Slug:** `SMS_ALERT_POST_SENT_SMS_REPORT`
>
> Retrieve sent SMS campaign log details, optionally filtered by campaign ID or mobile numbers, with pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for results (≥ 1)
>
> **limit** `integer`
>
> Records per page (≥ 1)
>
> **mobile** `string`
>
> Comma-separated mobile numbers to filter the report
>
> **campaignuniqueid** `string`
>
> Filter by specific campaign unique ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **messages** `array` *required*
>
> List of SMS messages to send. Each message can have multiple recipients with the same text.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
