TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the Report resource with the Create operation, it sends a POST request to create a new report in the TeleFlow system. This is useful when you want to programmatically generate reports based on specific criteria or data within TeleFlow.

Common scenarios include:

  • Automating report generation as part of a workflow.
  • Creating customized reports by specifying fields and values dynamically.
  • Integrating TeleFlow reporting capabilities into broader automation pipelines.

Example: You might use this node to create a report that filters call detail records by date range or account, enabling automated monitoring or billing processes.

Properties

Name Meaning
Fields A collection of field-value pairs to include in the request. These specify the parameters or filters for the report creation. You can add multiple fields, each with a name and corresponding value, to tailor the report details.

Output

The output is a JSON object representing the response from the TeleFlow API after creating the report. It typically contains the details of the newly created report, such as its ID, status, and any other metadata returned by the API.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the TeleFlow API must be configured in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST API endpoints.

Troubleshooting

  • Missing Required Fields: If required fields for the report creation are not provided, the API may return errors. Ensure all necessary fields are included in the "Fields" property.
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Invalid Field Names or Values: The API may reject unknown or improperly formatted fields. Double-check field names and values against TeleFlow API documentation.
  • Network Issues: Connectivity problems can cause request failures; ensure network access to the TeleFlow API endpoint.
  • Error Messages: The node throws errors if required parameters like IDs are missing for other operations, but for create operation on Report, ensure the fields are properly defined.

If the node is set to continue on failure, errors will be returned in the output JSON under an error key instead of stopping execution.

Links and References

Discussion