ClickSend

Consume ClickSend API

Actions8

Overview

This node interacts with the ClickSend API to retrieve account usage statistics for a specified year and month. It is useful for monitoring SMS, MMS, or other service usage on your ClickSend account, enabling reporting, cost tracking, or automated alerts based on usage thresholds.

Example scenarios:

Automatically generate monthly usage reports.
Trigger workflows if usage exceeds a certain limit.
Integrate usage data into dashboards or billing systems.

Properties

Name	Type	Meaning
Year	Number	Year of usage. Specifies which year's usage data to retrieve.
Month	Number	Month of usage as a number (e.g., March is 3). Specifies the target month.

Output

The output will be a JSON object containing the account usage details for the specified year and month. The exact structure depends on the ClickSend API response, but typically includes fields such as total messages sent, credits used, and breakdowns by message type.

Example output:

{
  "year": 2023,
  "month": 3,
  "sms_usage": 1200,
  "mms_usage": 50,
  "credits_used": 1250,
  // ...other relevant usage fields
}

Dependencies

External Service: Requires access to the ClickSend API.
API Key: You must configure valid ClickSend API credentials in n8n under the name clickSendApi.

Troubleshooting

Invalid Credentials: If the API key is missing or incorrect, you may receive authentication errors. Ensure your credentials are set up correctly in n8n.
Invalid Date: Supplying an invalid year or month (e.g., month outside 1–12) may result in API errors or empty results.
API Limits: Excessive requests may trigger rate limiting from ClickSend.

Common error messages:

401 Unauthorized: Check your API credentials.
400 Bad Request: Verify that the year and month values are correct and within valid ranges.