Overview
This node integrates with the Alive5 API to send SMS messages. It allows users to select a communication channel and an agent (user) within that channel, specify a recipient phone number, and compose a message to be sent via SMS.
Common scenarios for this node include:
- Sending notifications or alerts to customers or team members via SMS.
- Automating SMS outreach campaigns where different channels and agents represent different sending identities.
- Integrating SMS messaging into workflows for customer support or marketing.
For example, a user can select a specific channel representing a business line, choose an agent responsible for sending the message, enter the recipient's phone number in E.164 format, and write the message content. The node then sends the SMS through the Alive5 platform.
Properties
| Name | Meaning |
|---|---|
| Channel Name or ID | Select a channel from a dynamically loaded list or specify its ID. Channels represent sending sources and must have a valid phone number in E.164 format. |
| User Name or ID | Select a user (agent) associated with the chosen channel or specify their ID. Represents the sender identity within the channel. |
| To Phone Number | The recipient's phone number in E.164 format (e.g., +1234567890). This is the destination of the SMS message. |
| Message | The text content of the SMS message to be sent. |
Output
The node outputs JSON data containing the response from the Alive5 API after attempting to send the SMS. The structure includes details about the sent message or any errors returned by the API.
Example output JSON fields may include:
- Confirmation of message delivery status.
- Metadata about the SMS transaction.
- Any error messages if the sending failed.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for the Alive5 service to authenticate requests.
- Uses the Alive5 REST API endpoints:
GET /objects/channels-and-users/listto fetch available channels and agents.POST /conversations/sms/sendto send SMS messages.
- The node expects the phone numbers (both sender and recipient) to be in E.164 format.
- Requires n8n environment configured with the appropriate API key credential for Alive5.
Troubleshooting
- Invalid phone number format: The node validates both the "From" (channel phone number) and "To" phone numbers to ensure they follow E.164 format. Errors will occur if the format is incorrect. Ensure phone numbers start with "+" followed by country code and subscriber number.
- Channel not found: If the selected channel ID does not exist or cannot be retrieved from the API, the node throws an error. Verify the channel ID is correct and accessible with the provided API key.
- API request failures: Network issues or invalid API keys can cause request failures. Check the API key validity and network connectivity.
- Empty or malformed API responses: The node expects JSON responses. If the API returns unexpected data, the node will throw an error.
- Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.
Links and References
- Alive5 API Documentation (for reference to endpoints used)
- n8n Expressions Documentation (for using expressions in property values)