Alive5 icon

Alive5

Send SMS messages via alive5 API

Overview

This node allows sending SMS messages via the Alive5 API. It is designed to send text messages from a selected communication channel and user to a specified phone number. Common use cases include automating SMS notifications, alerts, or customer communications directly from workflows.

For example, you can use this node to:

  • Send appointment reminders to customers.
  • Notify users about system status updates.
  • Deliver marketing messages or promotions.

The node fetches available channels and their associated users dynamically, ensuring that messages are sent from valid sources.

Properties

Name Meaning
Channel name or ID Select the channel to send the SMS from. Options are loaded dynamically from the Alive5 API.
User email or ID Select the user (agent) within the chosen channel who will be the sender of the SMS. Options depend on the selected channel.
To phone number The recipient's phone number in E.164 format (e.g., +1234567890).
Message The text content of the SMS message to send.

Output

The node outputs JSON data representing the response from the Alive5 API after attempting to send the SMS. This includes details such as message status and any metadata returned by the API.

The output structure per item looks like:

{
  "json": {
    // API response fields related to the sent SMS message
  },
  "pairedItem": <index_of_input_item>
}

No binary data is produced by this node.

Dependencies

  • Requires an API key credential for the Alive5 service configured in n8n.
  • The node makes authenticated HTTP requests to the Alive5 API endpoints:
    • To list channels and users: /objects/channels-and-users/list
    • To send SMS messages: /conversations/sms/send
  • The base URL for the API is taken from the credential configuration.

Troubleshooting

  • Invalid phone number format errors: Both the sender's ("From") and recipient's ("To") phone numbers must be in E.164 format (e.g., +1234567890). Ensure phone numbers conform to this standard to avoid errors.
  • Channel not found error: If the selected channel ID does not exist or cannot be retrieved from the API, the node will throw an error. Verify the channel selection and API connectivity.
  • API request failures: Network issues, invalid credentials, or API downtime may cause request failures. Check the API key validity and network access.
  • Empty user list: If no users appear for a selected channel, ensure the channel has assigned agents in the Alive5 system.

When Continue On Fail is enabled, the node will return error information per item instead of stopping execution.

Links and References

Discussion