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 various types of messages and documents, including faxes, SMS, MMS, voice messages, letters, postcards, and SMS to contact lists. Specifically for the Send Fax operation, it allows users to send a fax by specifying sender and recipient numbers along with a URL pointing to the document/image to fax.

Common scenarios where this node is beneficial include:

  • Automating fax transmissions from workflows without manual intervention.
  • Sending marketing or transactional faxes programmatically.
  • Integrating fax sending into broader communication or notification systems.
  • Scheduling faxes to be sent at a future date/time.

Example use case: A business wants to automatically fax signed contracts stored in cloud storage to clients after they complete an online form. The node can send the fax using the provided document URL and client fax number.

Properties

Name Meaning
Sender name/From field (from) The sender's fax number. Use a dedicated ClickSend number you have purchased. If left blank, a free shared number will be used. Example: +6144444444.
Recipient number / To field (to) The recipient's fax number. Can be local or international format. For international, use the full international format (e.g., +61411111111). This is required.
Image URL (url) The URL of the image or document to fax. Must be accessible via HTTP(S). This is required. Example: https://docs.google.com/yurejfJFM/ID.
Schedule (schedule) Optional date and time to schedule when the fax should be sent. If not set, the fax is sent immediately.

Output

The node outputs JSON data representing the response from the ClickSend API after attempting to send the fax. The structure includes details such as:

  • Confirmation of the request status.
  • Information about queued faxes.
  • Any error messages if the fax could not be sent.

The output JSON typically contains fields like response_code, data, and message details confirming success or failure.

No binary data is output by this node.

Dependencies

  • Requires an active ClickSend account with API access.
  • Needs an API authentication token configured in n8n credentials to authorize requests to ClickSend.
  • The URL provided for the fax document must be publicly accessible or accessible by ClickSend servers.
  • Network connectivity to https://rest.clicksend.com is required.

Troubleshooting

  • Invalid recipient number: If the recipient fax number is incorrectly formatted or invalid, the API may reject the request. Ensure numbers are in correct local or international format.
  • Insufficient credit: Sending faxes requires sufficient credit on your ClickSend account. If credit is insufficient, the API will return an error indicating this.
  • URL accessibility: The document URL must be reachable by ClickSend. Private or inaccessible URLs will cause failures.
  • Scheduling errors: If scheduling a fax, ensure the date/time is valid and in the future.
  • Authentication errors: Verify that the API key credential is correctly configured in n8n and has necessary permissions.

Error messages returned by the API are passed through in the output JSON, providing reasons such as "INVALID_RECIPIENT" or "INSUFFICIENT_CREDIT" with guidance.

Links and References

Discussion