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 client data filtered by creation date. It is designed to fetch multiple client records within a specified date range, supporting pagination and control over the number of results returned.

Common scenarios where this node is beneficial include:

  • Extracting client lists created within a specific timeframe for reporting or analysis.
  • Synchronizing client data from Beex into other systems based on creation dates.
  • Paginating through large sets of clients to process them in batches.

For example, you could use this node to get all clients created between January 1, 2025, and January 31, 2025, retrieving 50 clients per page and iterating through pages as needed.

Properties

Name Meaning
Fecha Inicio Start date for filtering clients by their creation date. Format: YYYY-MM-DD. (Required)
Fecha Fin End date for filtering clients by their creation date. Format: YYYY-MM-DD. (Required)
Return All Boolean flag indicating whether to return all matching clients or limit the number of results returned.
Limit Number of clients to return per page when not returning all. Must be a positive integer as string.
Offset Page number to retrieve, starting at 0, ordered descending by creation date.

Output

The node outputs JSON data containing an array of client objects retrieved from the Beex API. Each object represents a client with its associated details as provided by the API.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Beex Contact Center API.
  • The base URL for API requests is https://api.beexcontact.com/api/v1.
  • The node performs HTTP GET requests to the /clients endpoint with query parameters for filtering and pagination.

Troubleshooting

  • Invalid Date Format: Ensure that "Fecha Inicio" and "Fecha Fin" are provided in the correct YYYY-MM-DD format. Incorrect formats may cause API errors or empty results.
  • Empty Results: If no clients are returned, verify that the date range actually includes client creation dates and that pagination parameters are correct.
  • API Authentication Errors: Confirm that the API key credential is correctly configured and has sufficient permissions.
  • Pagination Issues: When using "Return All" set to false, ensure that "Limit" and "Offset" values are valid integers and within acceptable ranges to avoid unexpected results.

Links and References

Discussion