TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage SIP Trunks among other resources. Specifically, for the "SIP Trunk" resource and the "Create" operation, it allows users to create a new SIP trunk by specifying essential details such as its name and host. This is useful in telephony systems where SIP trunks are needed to route calls over IP networks.

Practical examples include:

  • Automating the provisioning of new SIP trunks when scaling telephony infrastructure.
  • Integrating SIP trunk creation into larger workflows that manage telephony resources dynamically.

Properties

Name Meaning
Name The unique name to assign to the SIP trunk being created.
Host The hostname or IP address of the SIP trunk.
Fields Additional field-value pairs to include in the request for more specific queries (optional).

Note: For the Create operation on SIP Trunk, only "Name" and "Host" are required inputs. The "Fields" property is generally used for filtering in other operations but is present in the node's properties.

Output

The output is a JSON object representing the response from the TeleFlow API after creating the SIP trunk. It typically contains details of the newly created SIP trunk such as its ID, name, host, and any other metadata returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the TeleFlow API must be configured in the node credentials.
  • The node sends HTTP POST requests to the /sipTrunks endpoint of the TeleFlow API.

Troubleshooting

  • Missing Required Parameters: If "Name" or "Host" is not provided, the node will fail because these are mandatory fields for creating a SIP trunk.
  • API Authentication Errors: Ensure the API key credential is correctly set up and has permissions to create SIP trunks.
  • Network Issues: Connectivity problems to the TeleFlow API base URL can cause request failures.
  • Error Messages: The node throws errors with messages from the API or internal validation. Common errors include missing IDs for operations that require them (not applicable here for create), invalid hostnames, or duplicate names.

To resolve issues:

  • Verify all required input fields are filled.
  • Check API credentials and network connectivity.
  • Review error messages logged by the node for specific API response details.

Links and References

  • TeleFlow API Documentation (Replace with actual URL if available)
  • n8n HTTP Request Node documentation for understanding how HTTP calls are made within n8n.

Discussion