ClickSend icon

ClickSend

Consume Clicksend API

Actions7

  • Send Fax Actions
  • Send Letter Actions
  • Send MMS. Actions
  • Send Postcard Actions
  • Send SMS Actions
  • Send SMS to a Contact List Actions
  • Send Voice Actions

Overview

This node integrates with the ClickSend API to send SMS messages to a contact list. It allows users to send bulk SMS campaigns efficiently by specifying a sender ID, selecting a predefined contact list, composing a message, and optionally scheduling the sending time. This is useful for marketing campaigns, notifications, alerts, or any scenario where you need to broadcast SMS messages to multiple recipients at once.

For example, a business can use this node to send promotional offers to all customers in a contact list or notify members of an event about last-minute changes.

Properties

Name Meaning
Sender Name / From Field Name or ID The sender identifier shown on recipients' devices. Choose from your purchased dedicated numbers or specify an ID via expression.
Name / ID Of Contact List Name or ID The contact list to which the SMS will be sent. Select from existing lists in your ClickSend account or specify an ID using an expression.
Message Body The content of the SMS message to send. A standard SMS supports up to 160 characters.
Schedule Optional date and time to schedule when the message should be sent. If left empty, the message is sent immediately.
Custom String An optional reference string (max 50 characters) to label or tag the message, e.g., campaign name or order ID.

Output

The node outputs JSON data representing the response from the ClickSend API after attempting to send the SMS messages. This includes details such as message status, IDs, and any errors returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "data": {
    "messages": [
      {
        "message_id": "123456",
        "status": "SUCCESS",
        "to": "+61411111111",
        "custom_string": "promo_campaign"
      }
    ]
  }
}

Dependencies

  • Requires an active ClickSend account.
  • Requires an API key credential configured in n8n for authenticating requests to ClickSend.
  • Internet access to communicate with the ClickSend REST API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect contact list ID or empty contact list may result in no messages being sent.
    • Exceeding SMS character limits might truncate messages or cause errors.
    • Scheduling with invalid date/time formats may lead to immediate sending or errors.
  • Error messages:

    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Validation errors from ClickSend API: Check that all required fields (e.g., contact list, message body) are provided and valid.
    • Network errors: Ensure stable internet connection and that ClickSend API endpoints are reachable.

Links and References

Discussion