TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including Carriers. Specifically, the "Get" operation for the Carrier resource retrieves detailed information about a single carrier by its unique ID. This is useful when you need to fetch specific carrier details such as configuration or status within your workflow.

Practical examples:

  • Fetching carrier details before updating or deleting it.
  • Retrieving carrier information to display or use in conditional logic.
  • Integrating carrier data into reports or dashboards.

Properties

Name Meaning
ID The unique identifier of the carrier resource to retrieve. This is required.
Fields Optional key-value pairs specifying additional fields to include in the request query string. You can add multiple field name and value pairs to filter or customize the returned data.

Output

The output is a JSON object representing the carrier resource retrieved from the TeleFlow API. It contains all the properties of the carrier as returned by the API, potentially filtered or expanded based on the optional fields provided.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "carrier-id",
  "name": "Carrier Name",
  "status": "active",
  "otherProperties": "..."
}

Dependencies

  • Requires an active connection to the TeleFlow API via an API key credential configured in n8n.
  • The base URL for the API is taken from the credential configuration.
  • The node sends HTTP requests with JSON content type and expects JSON responses.

Troubleshooting

  • Missing ID error: If the "ID" property is not set, the node will throw an error stating that the ID is required for the get operation. Ensure you provide a valid carrier ID.
  • API connectivity issues: Errors related to network or authentication failures may occur if the API key credential is invalid or the base URL is incorrect.
  • Invalid fields: Providing unsupported or incorrect field names in the "Fields" collection may result in incomplete or empty responses.

To resolve these:

  • Double-check the carrier ID input.
  • Verify API credentials and endpoint configuration.
  • Confirm field names against TeleFlow API documentation.

Links and References

Discussion