ClickSend icon

ClickSend

Consume ClickSend API

Overview

The ClickSend node for n8n allows you to interact with the ClickSend API. Specifically, when using the MMS resource and the Get MMS History operation, this node retrieves a paginated history of sent and received MMS messages within a specified date range. This is useful for tracking message delivery, auditing communications, or generating reports on MMS usage.

Practical examples:

  • Retrieve all MMS messages sent in the last month for compliance reporting.
  • Audit MMS activity between specific dates for a particular campaign.
  • Paginate through large volumes of MMS history for analytics.

Properties

Name Type Meaning
From Date dateTime Date range start for MMS history. Only messages sent after this date are included.
To Date dateTime Date range end for MMS history. Only messages sent before this date are included.
Page number Page of results to start on. Used for pagination of results.
Limit number Max number of results to return per page. Controls the size of each result set.

Output

The output will be a JSON object (or array of objects) representing the MMS message history retrieved from ClickSend. Each entry typically includes details such as:

  • Message ID
  • Status
  • Timestamps (sent/received)
  • Sender and recipient information
  • Message content and media URLs
  • Delivery status

Note: The exact structure depends on the ClickSend API response for MMS history. No binary data is returned by this operation.

Dependencies

  • External Service: Requires access to the ClickSend API.
  • API Key: You must configure valid ClickSend API credentials in n8n under the name clickSendApi.
  • n8n Configuration: No additional environment variables are required beyond standard credential setup.

Troubleshooting

Common Issues:

  • Invalid Credentials: If your API key is incorrect or missing, authentication errors will occur. Ensure your clickSendApi credentials are correctly configured in n8n.
  • Date Format Errors: Dates must be provided in a format recognized by JavaScript's Date constructor. Invalid dates may result in empty results or errors.
  • Pagination Issues: If the Page or Limit values are out of range, you may receive empty results or an error from the API.
  • API Rate Limits: Excessive requests may trigger rate limiting by ClickSend.

Common Error Messages:

  • "Authentication failed": Check your API credentials.
  • "Invalid date_from/date_to": Ensure your date inputs are valid and properly formatted.
  • "Page not found": Adjust the Page parameter to a valid value.

Links and References

Discussion