BaleMessenger icon

BaleMessenger

Interact with Bale Messenger API

Overview

The node interacts with the Bale Messenger API to manage sticker sets, specifically allowing users to create new sticker sets. This operation is useful for bot developers or chat administrators who want to programmatically add custom sticker collections to their bots or chats on the Bale Messenger platform.

Typical use cases include:

  • Creating a personalized sticker set for a bot to enhance user engagement.
  • Automating the creation of themed sticker packs based on user input or events.
  • Managing sticker assets dynamically without manual intervention in the Bale Messenger app.

For example, a bot could create a new sticker set when a user submits artwork, enabling instant sharing and usage within chats.

Properties

Name Meaning
UserId The unique identifier of the user who will own the new sticker set.
Name The short name (identifier) for the new sticker set.
Title The display title for the new sticker set.
Binary Property The name of the binary data property containing the sticker file data to upload (e.g., "data").

Output

The output JSON contains the response from the Bale Messenger API after attempting to create the new sticker set. It typically includes confirmation details such as success status and any metadata returned by the API about the created sticker set.

The node also supports binary data input for the sticker file, which is uploaded as part of the sticker set creation process.

Dependencies

  • Requires an active Bale Messenger API authentication token configured in n8n credentials.
  • Uses the node-telegram-bot-api library configured to communicate with Bale Messenger's API endpoint.
  • Expects binary data input containing the sticker file to be uploaded.

Troubleshooting

  • Common issues:

    • Missing or invalid API authentication token will cause authorization failures.
    • Incorrect or missing binary data property name will result in failure to upload the sticker file.
    • Invalid user ID or sticker set name may cause the API to reject the creation request.
  • Error messages:

    • Errors from the Bale Messenger API are logged and returned in the output JSON under error details.
    • If the binary data is not found or improperly formatted, the node will throw an error indicating the missing or invalid binary property.
    • Network or API errors during the HTTP POST request to create the sticker set will be logged and surfaced as node execution errors.

To resolve these issues:

  • Ensure the API credential is correctly set up and valid.
  • Verify that the binary property name matches the actual binary input field containing the sticker file.
  • Confirm that the user ID and sticker set name conform to Bale Messenger API requirements.

Links and References

Discussion