TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including Tariff Profiles. Specifically, the "Get" operation for the "Tariff Profile" resource retrieves detailed information about a single tariff profile by its unique ID. This is useful when you need to fetch specific tariff profile data for billing, reporting, or configuration purposes within your telephony or billing system.

Practical examples:

  • Retrieve a tariff profile's details to display in a dashboard.
  • Fetch tariff profile data before updating or auditing it.
  • Use the tariff profile information to apply specific billing rules or rates.

Properties

Name Meaning
ID The unique identifier of the tariff profile to retrieve. This is required for the get operation.
Fields Optional field-value pairs to include additional query parameters for more specific requests. You can add multiple fields, each with a name and value.

Output

The output is a JSON object representing the retrieved tariff profile data as returned by the TeleFlow API. It contains all the properties of the tariff profile resource, such as its identifiers, names, settings, 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",
  "description": "string",
  "otherProperties": "..."
}

Dependencies

  • Requires an active connection to the TeleFlow API via an API key credential configured in n8n.
  • The base URL for the API must be set in the node credentials.
  • The node sends HTTP requests with JSON content type and expects JSON responses.

Troubleshooting

  • Missing ID error: If the "ID" property is not provided, the node will throw an error stating that the ID is required. Ensure you provide a valid tariff profile ID.
  • API connectivity issues: Errors related to network or authentication failures may occur if the API key or base URL is incorrect or expired. Verify your credentials and network access.
  • Invalid field names: Providing unsupported or misspelled field names in the "Fields" property may result in unexpected API errors or empty responses. Double-check field names against the TeleFlow API documentation.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.

Links and References

Discussion