ClickSend icon

ClickSend

Consume Clicksend API
Join our community

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 voice messages. It allows users to send a text message that will be converted into speech and delivered as a voice call to a specified recipient number. This is useful for automated notifications, reminders, alerts, or any scenario where delivering a spoken message via phone call is preferred over SMS or email.

For example, you could use this node to:

  • Send appointment reminders to customers.
  • Deliver urgent alerts or warnings.
  • Provide automated customer service messages.

Properties

Name Meaning
Recipient Number / To Field (to) The phone number of the message recipient. Can be local or international format. For international numbers, include the country code (e.g., +61411111111).
Message Body (body) The text content of the voice message that will be read out loud during the call.
Voice Type (voice) The gender of the voice used to read the message. Options: Male, Female.
Language Name or ID (lang) The language in which the message will be read. Choose from a list or specify an ID via expression to ensure correct pronunciation.
Schedule (schedule) Optional date and time when the voice message should be sent. If not set, the message is sent immediately.

Output

The node outputs JSON data representing the response from the ClickSend API after attempting to send the voice message. This typically includes details about the message status, IDs, and any errors if they occurred.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "data": {
    "messages": [
      {
        "message_id": "string",
        "status": "string",
        "to": "+61411111111",
        "body": "Your message text here"
      }
    ]
  }
}

Dependencies

  • Requires an API key credential for authenticating with the ClickSend API.
  • The node uses the ClickSend REST API endpoint https://rest.clicksend.com/v3/voice/send.
  • The user must configure the API key credential in n8n prior to using this node.

Troubleshooting

  • Invalid phone number format: Ensure the recipient number is in the correct local or international format. International numbers must start with a plus sign (+) followed by the country code.
  • Missing required fields: The to and body properties are mandatory. Omitting these will cause errors.
  • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Scheduling issues: If scheduling a message, ensure the date/time is valid and in the future.
  • Unsupported language or voice: If the selected language or voice type is not supported by ClickSend, the API may return an error. Use the provided language options or valid language IDs.

Common error messages come directly from the ClickSend API and usually indicate invalid parameters or authentication failures. Review the error message details to adjust inputs accordingly.

Links and References

Discussion