TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including Tariffs. Specifically, the "Get Many" operation for the Tariff resource retrieves multiple tariff records from the TeleFlow system. It allows users to specify filtering fields to narrow down the results.

Common scenarios where this node is beneficial include:

  • Fetching a list of tariffs available in the TeleFlow system for reporting or synchronization.
  • Retrieving tariffs that match specific criteria by specifying field-value filters.
  • Integrating tariff data into workflows for billing, provisioning, or analytics.

For example, a user might want to get all tariffs with a certain name or attribute by adding corresponding field filters.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the tariffs returned by the API request. Each pair consists of:
- Name: The field name to filter by (string).
- Value: The value to match for that field (string).
Multiple such pairs can be added to refine the query.

Output

The output is an array of JSON objects representing the tariffs retrieved from the TeleFlow API. Each object corresponds to a tariff record and contains its properties as returned by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

[
  {
    "id": "123",
    "name": "Standard Tariff",
    "description": "Basic tariff plan",
    ...
  },
  {
    "id": "456",
    "name": "Premium Tariff",
    "description": "Premium tariff plan with discounts",
    ...
  }
]

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 or invalid API credentials: Ensure that the API key and base URL are correctly set in the node credentials.
  • Invalid field names or values: If the API returns errors related to query parameters, verify that the field names and values used in the "Fields" property are valid according to the TeleFlow API documentation.
  • Empty results: If no tariffs are returned, check if the filter criteria are too restrictive or if there are no matching records.
  • Network issues: Connectivity problems may cause request failures; verify network access to the TeleFlow API endpoint.
  • Error messages about missing ID: This does not apply to the "Get Many" operation but may appear if other operations are attempted without required IDs.

Links and References

Discussion