TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

This node allows interaction with the TeleFlow API to manage various telephony-related resources, including SIP Trunks. Specifically, the "Get" operation for the "SIP Trunk" resource retrieves detailed information about a single SIP Trunk by its unique identifier. This is useful in scenarios where you need to fetch configuration or status details of a specific SIP Trunk within your telephony infrastructure.

Practical examples include:

  • Retrieving SIP Trunk details before updating or auditing configurations.
  • Fetching SIP Trunk information to display in dashboards or reports.
  • Integrating SIP Trunk data into workflows that automate telephony management tasks.

Properties

Name Meaning
ID The unique identifier of the SIP Trunk resource to retrieve. This is required.
Fields Optional key-value pairs specifying additional fields to include in the request query. 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 retrieved SIP Trunk resource. It contains all the properties and metadata as returned by the TeleFlow API for the specified SIP Trunk ID, potentially filtered or extended by any additional fields provided.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "host": "string",
  // other SIP Trunk related properties as defined by the TeleFlow API
}

Dependencies

  • Requires an API authentication token credential configured in n8n to access the TeleFlow API.
  • The base URL for the TeleFlow 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 for the get operation. Ensure you provide a valid SIP Trunk ID.
  • API connection issues: Errors may occur if the API base URL or authentication credentials are incorrect or missing. Verify your API credentials and network connectivity.
  • Invalid field names: Providing unsupported or misspelled field names in the "Fields" property may result in incomplete or empty responses. Double-check field names against the TeleFlow API documentation.
  • Handling errors gracefully: If "Continue On Fail" is enabled, the node will output error messages in the JSON output instead of stopping execution.

Links and References

Discussion