TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on multiple resources, including "Tariff Code". Specifically, for the "Get" operation on the "Tariff Code" resource, it retrieves detailed information about a single tariff code by its unique identifier. This is useful in scenarios where you need to fetch specific tariff code details for billing, reporting, or configuration purposes within a telecommunication or billing system.

Practical examples include:

  • Retrieving tariff code details to display pricing or usage rules in a dashboard.
  • Fetching tariff code data to validate or enrich call records.
  • Integrating tariff code information into automated workflows for billing adjustments or audits.

Properties

Name Meaning
ID The unique identifier of the tariff code resource to retrieve. This is required.
Fields Optional field-value pairs to specify additional query parameters for filtering or detail. You can add multiple fields, each with a name and value.

Output

The output is a JSON object representing the retrieved tariff code resource from the TeleFlow API. It contains all the properties returned by the API for that tariff code, such as identifiers, names, rates, or any other metadata defined by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "rate": "number",
  "description": "string",
  ...
}

The exact fields depend on the TeleFlow API response schema for tariff codes.

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The base URL for the TeleFlow API must be set in the node credentials.
  • The node uses HTTP requests to communicate with the API.

Troubleshooting

  • Missing ID error: If the "ID" property is not provided for the "get" operation, the node will throw an error stating that the ID is required. Ensure you provide a valid tariff code ID.
  • API connectivity issues: Network errors or incorrect base URL/credentials will cause request failures. Verify your API credentials and network access.
  • Invalid field names in "Fields": Providing unsupported or misspelled field names may result in unexpected API responses or errors. Confirm field names against the TeleFlow API documentation.
  • Handling API errors: If the API returns an error (e.g., resource not found), the node will either stop execution or continue with an error object depending on the "Continue On Fail" setting.

Links and References

Discussion