AiSensy icon

AiSensy

Interact with AiSensy WhatsApp API

Overview

This node integrates with the AiSensy WhatsApp API to send WhatsApp messages using predefined campaigns. It supports sending messages by selecting a campaign, specifying the recipient's phone number and contact name, and optionally providing template parameters for message customization. This node is useful for automating WhatsApp communications in marketing campaigns, customer support, or notifications, allowing users to send personalized messages efficiently.

Use Case Examples

  1. Sending a WhatsApp message to a customer using a specific campaign with personalized template parameters.
  2. Automating bulk WhatsApp notifications by selecting a campaign and providing different phone numbers and contact names.
  3. Using template parameters to customize messages dynamically for each recipient.

Properties

Name Meaning
Campaign Name Name of the campaign to use for sending the message, which determines the message template and content.
Phone Number Recipient's phone number including country code, used to direct the WhatsApp message to the correct contact.
Contact Name Name of the contact receiving the message, used for personalization or record-keeping.
Template Parameters Comma-separated values to fill in the placeholders in the message template, allowing dynamic content in the message.

Output

JSON

  • success - Indicates if the message was sent successfully.
  • messageResponse - The response object from the AiSensy API after sending the message, containing details about the sent message.
  • campaignDetails
    • id - ID of the campaign used to send the message.
    • name - Name of the campaign.
    • type - Type of the campaign message (e.g., TEXT, IMAGE).
    • status - Current status of the campaign.
    • audienceSize - Number of recipients targeted by the campaign.
    • templateText - The text template used in the campaign message.
    • sampleText - Sample text example of the campaign message template.
    • totalParameters - Total number of template parameters expected by the campaign.
    • parametersUsed - List of template parameters actually used in the sent message.
  • sentTo
    • phoneNumber - Phone number of the message recipient.
    • contactName - Name of the message recipient.
  • media
    • url - URL of the media sent with the message, if applicable.
    • filename - Filename of the media sent with the message, if applicable.

Dependencies

  • AiSensy API with project ID and API key credentials

Troubleshooting

  • Ensure the campaign name provided matches an existing campaign in the AiSensy project; otherwise, the node will throw a 'Selected campaign not found' error.
  • Verify the phone number format includes the country code without spaces or special characters to avoid message delivery failures.
  • If sending media with the message, ensure the media URL is accessible and the campaign type supports media content.
  • Check API credentials and project ID configuration to avoid authentication errors when calling the AiSensy API.

Links

  • AiSensy API Documentation - Official documentation for AiSensy WhatsApp API, useful for understanding campaign setup and message sending.

Discussion