Beex icon

Beex

Interacción y Consumo de la API Beex Contact Center.

Actions9

Overview

This node interacts with the Beex Contact Center API to retrieve information about message templates ("Plantillas"). Specifically, the "Obtener" (Get) operation under the "Template" resource fetches details of templates created within a specified date range. It supports filtering by creation date, WABA identifier, and queue ID, and allows pagination control.

Common scenarios where this node is useful include:

  • Extracting templates created in a certain timeframe for reporting or auditing.
  • Filtering templates associated with specific WhatsApp Business Accounts (WABA) or queues.
  • Integrating template data into workflows that automate customer communication management.

Example use case: A user wants to get all message templates created between January 1st and January 31st, 2025, belonging to a particular WABA and queue, to update their CRM system accordingly.

Properties

Name Meaning
Fecha Inicio Start date for filtering templates based on their creation date. Format: YYYY-MM-DD HH:MM:SS. Required.
Fecha Fin End date for filtering templates based on their creation date. Format: YYYY-MM-DD HH:MM:SS. Required.
Return All Boolean flag indicating whether to return all matching results or limit the number of results returned.
Limit Number of records per page to retrieve when not returning all. Range: from 1 up to any maximum allowed.
Offset Page number to retrieve, ordered descending by creation date, starting at 0.
ID WABA Identifier of the WhatsApp Business Account (WABA) to which the template belongs.
ID Cola Queue ID to filter templates by queue association. This can be obtained from the Queues endpoint.

Output

The node outputs JSON data containing an array of template objects retrieved from the Beex API. Each object represents a template with its associated metadata such as creation date, identifiers, and other relevant fields provided by the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Beex Contact Center API.
  • The base URL for API requests is https://api.beexcontact.com/api/v1.
  • Proper configuration of the API key credential in n8n is necessary for successful execution.

Troubleshooting

  • Missing or invalid API credentials: The node will fail if the API key is not set or invalid. Ensure the API key credential is correctly configured.
  • Date format errors: The start and end dates must follow the exact format YYYY-MM-DD HH:MM:SS. Incorrect formats may cause request failures.
  • Pagination issues: If Return All is false but no limit is set or limit is out of range, the API might reject the request or return unexpected results.
  • Empty results: If filters are too restrictive (e.g., date range with no templates), the output will be empty. Adjust filters accordingly.
  • API rate limits or downtime: Temporary API unavailability or rate limiting may cause errors; retry after some time.

Links and References

Discussion