BaleMessenger icon

BaleMessenger

Interact with Bale Messenger API

Overview

The "Log Out" operation under the "Bot" resource allows users to log out from the cloud Bot API server of Bale Messenger. This is particularly useful when you want to disconnect your bot from the cloud service before running it locally or switching environments. For example, if you are migrating your bot from a cloud-hosted environment to a local server, logging out ensures that the cloud instance is properly terminated and does not interfere with the local instance.

Properties

Name Meaning
Reply Keyboard Adds a custom keyboard with reply options. Users can define multiple rows and buttons.
Reply Keyboard Remove Options to remove the custom keyboard, including whether to remove it selectively for specific users.

(Note: These properties are part of the node's general input parameters related to message reply markup but are not specifically used in the "Log Out" operation.)

Output

The output JSON object for the "Log Out" operation contains a single field:

  • logged_out: A boolean indicating whether the logout was successful.

Example output:

{
  "logged_out": true
}

No binary data is produced by this operation.

Dependencies

  • Requires an API authentication token credential for Bale Messenger.
  • Uses the official Bale Messenger Bot API client library (node-telegram-bot-api configured for Bale Messenger).
  • The base API URL used is https://tapi.bale.ai/bot.

Troubleshooting

  • Common Issues:

    • Invalid or expired API token: The logout request will fail if the provided API token is invalid or has expired.
    • Network connectivity issues: Failure to reach the Bale Messenger API endpoint will cause errors.
  • Error Messages:

    • Errors thrown by the underlying API client will typically include HTTP response details. If the logout fails, the error message will be logged, and the node execution will throw an error.
  • Resolution:

    • Verify that the API token credential is correct and active.
    • Ensure network access to https://tapi.bale.ai.
    • Check for any rate limits or restrictions imposed by the Bale Messenger API.

Links and References


This summary focuses exclusively on the "Log Out" operation of the "Bot" resource as requested.

Discussion