BaleMessenger icon

BaleMessenger

Interact with Bale Messenger API

Actions32

Overview

The node enables sending text messages through the Bale Messenger platform. It is designed to send a plain text message to a specified chat identified by its unique chat ID. This operation is useful in scenarios where automated notifications, alerts, or conversational messages need to be sent programmatically to users or groups on Bale Messenger.

Practical examples include:

  • Sending confirmation messages after a user completes a form.
  • Broadcasting announcements to a group chat.
  • Delivering customer support responses automatically.

Properties

Name Meaning
Chat ID Unique identifier for the target chat where the message will be sent.
Text The content of the text message to be sent.
Reply Markup Additional interface options for the message. Possible values:
- Inline Keyboard: Adds an inline keyboard next to the message.
- None: No additional interface elements.
- Reply Keyboard: Adds a custom reply keyboard with buttons.
- Reply Keyboard Remove: Requests clients to remove the custom keyboard.
Inline Keyboard Defines rows and buttons for the inline keyboard when "Inline Keyboard" is selected. Each button can have text, callback data, or URL.
Reply Keyboard Defines rows and buttons for a custom reply keyboard when "Reply Keyboard" is selected. Buttons have text labels.
Reply Keyboard Remove Options to remove the custom keyboard, including whether to remove it selectively for specific users.
Reply To Message ID If set, the message will be sent as a reply to the original message with this ID.

Output

The output JSON contains the response from the Bale Messenger API after sending the message. It typically includes details about the sent message such as message identifiers and status. The output does not include binary data for this operation.

Example output structure (simplified):

{
  "message_id": 12345,
  "chat": {
    "id": "chatIdValue",
    "type": "private"
  },
  "date": 1617181723,
  "text": "Your message text here"
}

Dependencies

  • Requires an active Bale Messenger API authentication token configured in n8n credentials.
  • Uses the official Bale Messenger Bot API endpoint (https://tapi.bale.ai/bot).
  • Relies on the node-telegram-bot-api library adapted for Bale Messenger API calls.
  • No additional environment variables are required beyond the API credential.

Troubleshooting

  • Invalid Chat ID: If the chat ID is incorrect or the bot is not a member of the chat, the message will fail to send. Verify the chat ID and bot permissions.
  • API Authentication Errors: Ensure the API token credential is valid and has not expired.
  • Reply Markup Misconfiguration: Incorrectly structured inline or reply keyboards may cause errors. Validate the keyboard configuration carefully.
  • Empty Text Field: The text property is required; sending an empty string will result in an error.
  • Network Issues: Connectivity problems to the Bale Messenger API endpoint will cause request failures.

Common error messages usually come directly from the Bale Messenger API and indicate issues like unauthorized access, invalid parameters, or rate limits. Review the error details returned in the output JSON for guidance.

Links and References

Discussion