Skip to main content
SMS Alert logo
  • Category: phone & sms
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 23
  • Triggers: 0
  • Slug: SMS_ALERT
  • Version: 20261101_00

Tools

Slug: SMS_ALERT_CHANGE_PASSWORDTool to change the password for the authenticated user account. Use when the user needs to update their account password.

Input Parameters

string
required
Current password for the authenticated user account
string
required
Confirm new password - must match newpwd exactly
string
required
New password to set for the account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_GET_BALANCE_CHECKTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_GET_DELIVERY_REPORTRetrieve 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

string
Filter by message text content to search for specific message deliveries
string
Filter by sender ID to retrieve delivery reports for a specific sender
string
required
Batch ID of the SMS campaign for which to retrieve the delivery report
string
Filter by schedule status to narrow down the delivery report results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_GET_GROUP_DETAILRetrieve the contacts in a specific SMS Alert group by group ID. A group with no contacts is returned as an empty list.

Input Parameters

integer
required
ID of the group to fetch details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_GET_GROUP_LISTTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_GET_SENDER_ID_LISTTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_GET_TEMPLATE_LISTTool to retrieve list of SMS templates from your SmsAlert account. Use when you need to display or manage your SMSAlert templates.

Input Parameters

string
Filter templates by type, e.g., ‘transactional’ or ‘promotional’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_GET_USER_PROFILERetrieve user login and profile information for the configured SMS Alert account, including contact and account verification details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_CREATE_CONTACTCreate New Contact

Input Parameters

string
required
Full name of the contact
string
required
Name of the group to which the contact(s) will be added
string
required
Mobile number(s) as a 10-digit string, comma-separated for multiple contacts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_CREATE_GROUPTool to create a new contact group. Use when needing to organize contacts into a new group.

Input Parameters

string
required
Name of the group to create. Only letters, numbers, hyphens, and underscores are allowed. Spaces are not permitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_CREATE_SHORT_URLTool to create a short URL for a given long URL. Use when you need to shorten a URL before sharing.

Input Parameters

string
required
The original long URL to shorten
string
Custom alias for the short URL; omit or set to null for system-generated alias

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_CREATE_TEMPLATETool to create a new SMS template. Use when you need to define reusable message content.

Input Parameters

string
required
Name of the SMS template
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_DELETE_CONTACTTool to delete a specified contact. Use after confirming the contact’s ID.

Input Parameters

string
required
The Contact Number ID of the contact to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_DELETE_GROUPTool to delete a specified group. Use after confirming the group’s ID.

Input Parameters

integer
required
The unique identifier of the SMS Alert group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_DELETE_SHORT_URLTool to delete an existing short URL. Use after confirming the short URL’s ID.

Input Parameters

string
required
The unique identifier (UUID) of the short URL to delete. This ID is returned when creating a short URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_DELETE_TEMPLATETool to delete an existing SMS template. Use when you have the template ID to remove it.

Input Parameters

string
required
The unique identifier of the SMS template to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_EDIT_CONTACTTool to edit an existing contact’s details. Use when you need to update a contact’s information after confirming the contact_id.

Input Parameters

string
New name for the contact
string
New email address for the contact
string
ID of the group to assign the contact to
string
New mobile number for the contact; must be unique
string
required
Unique identifier of the contact to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_EDIT_GROUPTool to edit an existing groups name. Use when you need to rename a group after confirming the group id.

Input Parameters

string
required
Unique identifier of the group to update
string
required
New name for the group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_EDIT_PROFILETool to update user account profile details. Use when modifying authenticated user profile after login.

Input Parameters

string
GST number
string
City name
string
Email address
string
State name
string
Physical address
string
Company name
string
Country
string
Postal PIN code
string
required
Registered mobile number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_EDIT_TEMPLATETool to edit an existing SMS template. Use when you need to update a template after confirming the template id.

Input Parameters

string
required
Unique identifier of the template to update
string
required
New name for the template
string
required
New SMS content for the template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_GENERATE_OTPTool 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

string
Sender ID approved by SMS Alert, up to 6 characters
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).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_POST_SENT_SMS_REPORTRetrieve sent SMS campaign log details, optionally filtered by campaign ID or mobile numbers, with pagination.

Input Parameters

integer
Page number for results (≥ 1)
integer
Records per page (≥ 1)
string
Comma-separated mobile numbers to filter the report
string
Filter by specific campaign unique ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMS_ALERT_SEND_SMS_XMLTool 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

array
required
List of SMS messages to send. Each message can have multiple recipients with the same text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not