NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
SMS Alert connects to a Nagent workspace with an API key. Once it is connected, agents can call 23 SMS Alert actions, such as "Get SMS Alert Balance", "Get SMS Delivery Report" and "Get Group Detail". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against SMS Alert, with input parameters and output schema.
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
Current password for the authenticated user account
Confirm new password - must match newpwd exactly
New password to set for the account
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_GET_DELIVERY_REPORTTool 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
Filter by message text content to search for specific message deliveries
Filter by sender ID to retrieve delivery reports for a specific sender
Batch ID of the SMS campaign for which to retrieve the delivery report
Filter by schedule status to narrow down the delivery report results
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_GET_GROUP_DETAILTool to retrieve details of a specific SMS Alert group. Use after confirming the group ID.
Input parameters
ID of the group to fetch details
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Filter templates by type, e.g., 'transactional' or 'promotional'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_GET_USER_PROFILETool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_CREATE_CONTACTCreate New Contact
Input parameters
Full name of the contact
Name of the group to which the contact(s) will be added
Mobile number(s) as a 10-digit string, comma-separated for multiple contacts
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_CREATE_GROUPTool to create a new contact group. Use when needing to organize contacts into a new group.
Input parameters
Name of the group to create. Only letters, numbers, hyphens, and underscores are allowed. Spaces are not permitted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The original long URL to shorten
Custom alias for the short URL; omit or set to null for system-generated alias
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_CREATE_TEMPLATETool to create a new SMS template. Use when you need to define reusable message content.
Input parameters
Name of the SMS template
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_DELETE_CONTACTTool to delete a specified contact. Use after confirming the contact's ID.
Input parameters
The Contact Number ID of the contact to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_DELETE_GROUPTool to delete a specified group. Use after confirming the group's ID.
Input parameters
The unique identifier of the SMS Alert group to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_DELETE_SHORT_URLTool to delete an existing short URL. Use after confirming the short URL's ID.
Input parameters
The unique identifier (UUID) of the short URL to delete. This ID is returned when creating a short URL.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_DELETE_TEMPLATETool to delete an existing SMS template. Use when you have the template ID to remove it.
Input parameters
The unique identifier of the SMS template to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
New name for the contact
New email address for the contact
ID of the group to assign the contact to
New mobile number for the contact; must be unique
Unique identifier of the contact to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique identifier of the group to update
New name for the group
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_EDIT_PROFILETool to update user account profile details. Use when modifying authenticated user profile after login.
Input parameters
GST number
City name
Email address
State name
Physical address
Company name
Country
Postal PIN code
Registered mobile number
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique identifier of the template to update
New name for the template
New SMS content for the template
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Sender ID approved by SMS Alert, up to 6 characters
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 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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SMS_ALERT_POST_SENT_SMS_REPORTTool 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
Page number for results (≥ 1)
Records per page (≥ 1)
Comma-separated mobile numbers to filter the report
Filter by specific campaign unique ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
List of SMS messages to send. Each message can have multiple recipients with the same text.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 23 SMS Alert actions on Nagent, including "Get SMS Alert Balance", "Get SMS Delivery Report" and "Get Group Detail". Get SMS Alert Balance: Retrieve the current SMS credit balance. Each action is listed on this page with its input parameters and its output.
SMS Alert connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.