Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Phones

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve phone report data for a specified company. It is useful for obtaining detailed telephone-related reports within a given company entity, supporting pagination and filtering options.

Use Case Examples

  1. Retrieve a list of phone reports for a specific company by providing the company ID, with options to limit the number of results or paginate through pages.
  2. Use the node to fetch all phone report entries for a company by setting the 'Return All' option to true.

Properties

Name Meaning
Company ID ID of the company in which the phone report information will be retrieved.
Return All Whether to return all results or only up to a given limit.
Limit Size of the page you want to obtain, applicable when 'Return All' is false.
Offset Page number to obtain, in descending order by creation date, starting from 0.

Output

JSON

  • json - Phone report data returned from the Beex API for the specified company.

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 that the Company ID and other required parameters are correctly set.
  • API request failures may occur due to network issues or invalid API keys; verify the API key credential and network connectivity.
  • Pagination parameters such as 'Limit' and 'Offset' must be valid integers; incorrect values may cause errors or unexpected results.

Discussion