Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Actions59

Template → Get Many

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve multiple templates based on specified filtering criteria. It is useful for scenarios where users need to fetch template details created within a certain date range, optionally filtered by WABA ID or Queue ID, and supports pagination for managing large result sets. For example, a user can retrieve all templates created between two dates for a specific queue or WABA, with control over the number of results returned per request.

Use Case Examples

  1. Retrieve all templates created between 2023-01-01 and 2023-01-31 for a specific WABA ID.
  2. Fetch up to 50 templates created in the last month, filtered by a specific queue ID.

Properties

Name Meaning
Start Date Start date for filtering templates based on their creation date, in the format YYYY-MM-DD HH:MM:SS.
End Date End date for filtering templates based on their creation date, in the format YYYY-MM-DD HH:MM:SS.
WABA ID Identifier of the WhatsApp Business Account (WABA) to which the template belongs.
Queue ID Queue ID to filter templates, which can be obtained from the Queues endpoint.
Return All Boolean flag indicating whether to return all matching templates or limit the results to a specified number.
Limit The maximum number of templates to return when 'Return All' is false, specifying the page size.
Offset The page number to retrieve, used for pagination, starting from 0 and ordered descending by creation date.

Output

JSON

  • json - Each item contains the details of a template retrieved from the Beex API.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Common issues include API authentication errors due to invalid or missing API keys. Ensure the API key credential is correctly configured.
  • Errors related to invalid date formats or missing required parameters (start_date, end_date) may occur. Verify date inputs are in the correct format (YYYY-MM-DD HH:MM:SS).
  • Pagination parameters (limit and offset) must be valid integers; incorrect values may cause errors or unexpected results.
  • API rate limits may cause delays or errors; the node includes a delay between requests to mitigate this.

Links

Discussion