Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Calls

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve call reports within a specified date range. It is useful for users who want to analyze call data, such as call volumes, durations, and other call-related metrics, filtered by start and end dates. For example, a customer service manager might use this node to generate reports on calls handled by their team over a particular period.

Use Case Examples

  1. Retrieve all call records between 2023-01-01 and 2023-01-31 to analyze call traffic for January.
  2. Fetch a limited number of call records (e.g., 10) from the last week to review recent call activity.

Properties

Name Meaning
Start Date Start date for filtering call reports. Format: YYYY-MM-DD.
End Date End date for filtering call reports. Format: YYYY-MM-DD.
Return All Whether to return all call report results or only up to a given limit.
Limit Size of the page you want to obtain. From 1 to XX. Only used if Return All is false.
Offset Page number you wish to obtain. In descending order to the creation date and starting from 0.

Output

JSON

  • json - Call report data returned from the Beex API, including details of calls within the specified date range.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Common issues include invalid or missing parameters for the API request, which will result in error messages indicating the problem. Ensure that the start_date and end_date are provided in the correct format (YYYY-MM-DD) and that the API key credential is valid.
  • API rate limiting or network issues may cause request failures. The node includes a delay between requests to mitigate rate limiting.
  • Error messages from the Beex API are captured and presented with details to help diagnose issues, such as 'Error 400 - Invalid or missing parameters'. Verify the parameters and credentials if such errors occur.

Links

Discussion