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 TeleFlow 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 (like SIP phones or WebRTC clients) within a telephony system, integrating device management into workflows, or bulk-creating devices based on external data sources.

For example, a user can automate adding new SIP devices when onboarding employees, ensuring each device has a unique name and correct type without manual entry.

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 an array of JSON objects, each representing the response from the TeleFlow API after creating a device. Each JSON object contains the full details of the newly created device as returned by the API.

No binary data output is produced by 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 uses HTTP POST requests to create devices via the TeleFlow REST API.

Troubleshooting

  • Missing Required Parameters: If the "Name" or "Type" properties are not provided, the node will fail because these are required fields for device creation.
  • API Authentication Errors: Ensure that the API key credential is correctly set up and has sufficient permissions to create devices.
  • Network or Endpoint Issues: Verify that the base URL is correct and reachable from the n8n environment.
  • Error Messages: If the API returns an error, the node will throw an error unless "Continue On Fail" is enabled, in which case the error message will be included in the output JSON under an error property.

Links and References

Discussion