Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Incoming Call

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve an incoming call report filtered by campaign (portfolio) and date range. It is useful for analyzing incoming call data within a specified campaign and time period, helping call center managers monitor call traffic and performance.

Use Case Examples

  1. Retrieve incoming call reports for a specific campaign between two dates to analyze call volume and patterns.
  2. Use the node to fetch paginated incoming call data for detailed reporting and analysis.

Properties

Name Meaning
Portfolio ID ID of the campaign in which the information will be filtered, obtained from the ID column in the Campaigns module on the platform.
Start Date Start date for filtering the incoming call report. Format: YYYY-MM-DD.
End Date End date for filtering the incoming call report. Format: YYYY-MM-DD.
Return All Whether to return all results or only up to a given limit.
Limit Size of the page you want to obtain. From 1 to XX. Used only 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 - Incoming call report data returned from the Beex API, filtered by the specified portfolio and date range.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Common errors include invalid or missing parameters, which result in error messages from the Beex API. Ensure all required fields (Portfolio ID, Start Date, End Date) are correctly set.
  • API authentication errors may occur if the API key credential is missing or invalid. Verify the API key is correctly configured in the node credentials.
  • Rate limiting or request throttling may happen due to the enforced delay between requests (1 second). Adjust usage accordingly to avoid hitting API limits.

Links

Discussion