TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node interacts with the TeleFlow API to manage various resources, including devices. Specifically, for the Device - Update operation, it updates an existing device's details by sending a PUT request to the TeleFlow API. This is useful in scenarios where you need to modify device attributes such as its name or type after creation.

Practical examples include:

  • Renaming a device to reflect a new naming convention.
  • Changing the device type from SIP to WebRTC or vice versa to update its communication protocol.

Properties

Name Meaning
ID The unique identifier of the device to update. Required to specify which device to modify.
Name The new name for the device. Must be unique.
Type The type of the device. Options are: SIP or WebRTC.
Fields Additional field-value pairs to include in requests (not used directly in update).

Output

The output is a JSON object representing the updated device resource as returned by the TeleFlow API. It typically includes the updated properties of the device such as its ID, name, type, and any other metadata provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the API must be set in the node credentials configuration.

Troubleshooting

  • Missing ID Error: If the "ID" property is not provided, the node throws an error stating that the ID is required for the update operation. Ensure the device ID is correctly specified.
  • API Request Failures: Network issues or invalid credentials can cause HTTP request failures. Verify API keys and network connectivity.
  • Invalid Property Values: Providing unsupported values for "Type" or empty "Name" may result in API errors. Use only allowed options and ensure required fields are filled.
  • 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