TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including Resellers. Specifically, the Get operation for the Reseller resource retrieves detailed information about a single reseller by its unique ID. This is useful when you need to fetch specific reseller data for reporting, auditing, or integration purposes.

Practical examples include:

  • Retrieving reseller details to display in a dashboard.
  • Fetching reseller information before updating or deleting it.
  • Using reseller data as part of a workflow that manages billing or user assignments.

Properties

Name Meaning
ID The unique identifier of the reseller to retrieve. This is required for the Get operation.
Fields Optional key-value pairs to specify additional query parameters or filter fields included in the response.

The Fields property allows adding multiple field-value pairs to customize the request further, such as filtering or specifying which fields to return.

Output

The output is a JSON object representing the reseller resource retrieved from the TeleFlow API. It contains all the properties and metadata associated with the specified reseller ID, depending on the API's response structure.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "reseller123",
  "name": "Example Reseller",
  "status": "active",
  "createdAt": "2023-01-01T12:00:00Z",
  "otherProperties": "..."
}

Dependencies

  • Requires an API authentication token configured in the node credentials to access the TeleFlow API.
  • The base URL for the API must be set in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST 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 the ID is correctly set.
  • Authentication errors: If the API key or base URL is incorrect or missing, the node will fail to connect. Verify credential configuration.
  • Invalid field names: Providing unsupported or misspelled field names in the Fields property may result in incomplete or failed responses.
  • API rate limits or downtime: Network issues or API limits can cause request failures; check API status and retry policies.

Links and References

Discussion