Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get IVR Survey

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve IVR (Interactive Voice Response) survey reports. It allows users to filter survey data based on a specific IVR ID and a date range (start and end dates). This is useful for analyzing customer satisfaction and feedback collected through IVR systems over a specified period.

Use Case Examples

  1. A customer service manager wants to analyze IVR survey results for a particular IVR system to assess customer satisfaction trends over the last month.
  2. A business analyst needs to generate a report on IVR survey responses filtered by a specific IVR ID and date range to evaluate the effectiveness of the IVR survey.

Properties

Name Meaning
Start Date Start date for filtering the IVR survey data, formatted as YYYY-MM-DD.
End Date End date for filtering the IVR survey data, formatted as YYYY-MM-DD.
IVR ID ID of the IVR from which the survey information will be filtered.
Return All Whether to return all results or only up to a given limit.
Limit Size of the page of results to obtain, applicable if Return All is false.
Offset Page number to obtain, used for pagination starting from 0.

Output

JSON

  • json - The IVR survey report data returned from the Beex API, filtered by IVR ID and date range.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Common issues include invalid or missing parameters such as incorrect date formats or missing IVR ID, which will result in API errors.
  • API authentication errors may occur if the API key credential is invalid or missing.
  • Network or connectivity issues can cause request failures; ensure the node can reach the Beex API endpoint.
  • Error messages from the API are captured and presented with details to help diagnose issues, such as 'Invalid or missing parameters'.

Discussion