ClickSend icon

ClickSend

Consume ClickSend API

Overview

The ClickSend node's "SMS" resource with the "Send SMS" operation allows you to send one or more SMS messages via the ClickSend API. This is useful for automating notifications, alerts, reminders, or any workflow that requires sending text messages to recipients programmatically.

Common scenarios:

  • Sending appointment reminders to customers.
  • Notifying users of system events or status changes.
  • Broadcasting marketing or informational messages to a list of contacts.

Example:
You could use this node in an n8n workflow to automatically send a confirmation SMS when a new order is placed on your e-commerce site.


Properties

Name Type Meaning
SMS Messages Collection An array of SMS message objects to send. Each object contains the following fields:
└ Body String The content of the SMS message. Required.
└ To String Recipient phone number in E.164 format (e.g., +61411111111). Required unless using List ID.
└ Source Name String Method/source of sending (e.g., 'wordpress', 'php', 'c#'). Optional.
└ Schedule DateTime When to send the message (leave blank for immediate delivery). Optional.
└ Custom String String A custom reference string returned with replies and delivery reports. Optional.
└ List ID Number List ID to send to multiple recipients at once. Can be used instead of "To". Optional.
└ Country Code String ISO alpha-2 country code (e.g., "US"). Used to format recipient number if not in international format.
└ From Email String Email address to receive replies. If omitted, replies go to the sender's email. Optional.

Output

The node returns a JSON object for each SMS message sent. The structure typically includes:

  • success: Boolean indicating if the message was sent successfully.
  • message_id: Unique identifier for the sent message.
  • to: The recipient's phone number.
  • body: The message content.
  • status: Delivery status or error information.
  • custom_string: Your custom reference string, if provided.
  • error: Error details if the message failed to send.

Note: The exact output fields may vary depending on the ClickSend API response.


Dependencies

  • External Service: Requires a ClickSend account.
  • API Key: You must configure ClickSend API credentials in n8n under the name clickSendApi.
  • Environment: No special environment variables are required beyond n8n credential setup.

Troubleshooting

Common issues:

  • Invalid phone number format: Ensure numbers are in E.164 format or provide a valid country code.
  • Missing required fields: Both "Body" and "To" (or "List ID") are required for each message.
  • Authentication errors: Make sure your ClickSend API credentials are correct and active.
  • API rate limits: Excessive requests may be throttled by ClickSend.

Error messages:

  • "401 Unauthorized": Check your API credentials.
  • "400 Bad Request": Likely due to missing or invalid input fields (e.g., empty "Body" or incorrect "To" format).
  • "Insufficient balance": Your ClickSend account does not have enough credit to send messages.

Links and References

Discussion