TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including devices. Specifically, for the Device - Create operation, it allows users to create a new device record in the TeleFlow system by specifying essential details such as the device's name and type.

Common scenarios where this node is beneficial include:

  • Automating the provisioning of communication devices (e.g., SIP phones or WebRTC clients) within an organization.
  • Integrating device management into larger workflows that handle telephony infrastructure setup.
  • Bulk creation of devices based on external data sources.

For example, a user can set up a workflow that automatically creates a new SIP device whenever a new employee joins the company, using their unique device name and selecting "SIP" as the device type.

Properties

Name Meaning
Name The unique name of the device to be created.
Type The type of the device. Options: SIP or WebRTC.
Fields Additional field-value pairs to include in the request for more specific queries (not used in create but available generally).

Output

The output is a JSON object representing the newly created device as returned by the TeleFlow API. This typically includes all properties of the device resource such as its ID, name, type, and any other metadata assigned by the server.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "device-id",
  "name": "DeviceName",
  "type": "sip",
  ...
}

Dependencies

  • Requires an active connection to the TeleFlow API via an API key credential configured in n8n.
  • The base URL for the API must be set in the credentials.
  • The node uses HTTP POST requests to create devices.

Troubleshooting

  • Missing Required Parameters: If the "Name" or "Type" property is not provided, the node will fail because these are required fields for creating a device.
  • API Authentication Errors: Ensure that the API key credential is correctly configured and has sufficient permissions to create devices.
  • Network Issues: Connectivity problems to the TeleFlow API endpoint will cause request failures.
  • Error Messages: The node throws errors if the API returns an error response or if required parameters are missing. The error message from the API is logged and can be viewed in the node execution logs.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion