TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node integrates with the TeleFlow API to perform various operations on different resources, including phone numbers. Specifically, for the Phone Number - Get operation, it retrieves detailed information about a specific phone number resource by its unique identifier. This is useful in scenarios where you need to fetch current data or metadata about a phone number managed within TeleFlow, such as verifying its status, type, or associated attributes.

Practical examples include:

  • Retrieving details of a phone number before updating or deleting it.
  • Fetching phone number information to display in dashboards or reports.
  • Using the phone number data to trigger conditional workflows based on its properties.

Properties

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

Output

The node outputs an array of JSON objects, each representing the retrieved phone number resource data from the TeleFlow API. The structure corresponds directly to the API response for the phone number identified by the given ID, including all requested fields.

If binary data were involved (not in this operation), it would be included in the output accordingly, but for the "Get" operation on phone numbers, only JSON data is returned.

Example output snippet (simplified):

{
  "id": "12345",
  "number": "+1234567890",
  "type": "mobile",
  "status": "active",
  ...
}

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 TeleFlow REST endpoints.

Troubleshooting

  • Missing ID Error: If the "ID" property is not provided, the node will throw an error stating that the ID is required for the get operation. Ensure the ID is correctly set.
  • Authentication Failures: If the API credentials are invalid or missing, the node will fail to connect. Verify the API key/token and base URL configuration.
  • Invalid Field Names: Providing incorrect field names in the "Fields" collection may result in incomplete or empty responses. Double-check field names against TeleFlow API documentation.
  • Network Issues: Connectivity problems to the TeleFlow API endpoint will cause request failures. Confirm network access and endpoint availability.

Links and References

Discussion