TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

The node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the Device resource and the 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 information such as its name or type within your telephony infrastructure.

Practical examples include:

  • Renaming a device to reflect a new user or location.
  • Changing the device type from SIP to WebRTC or vice versa to accommodate different communication protocols.

Properties

Name Meaning
ID The unique identifier of the device to update (required).
Name The new name to assign to the device (required).
Type The type of the device; options are: SIP or WebRTC (required).
Fields Additional field-value pairs to include in requests (not used directly in update here).

Output

The output is a JSON object representing the updated device as returned by the TeleFlow API after the successful update operation. It typically includes the device's current properties such as its ID, name, type, and possibly other metadata managed by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "id": "device-id",
  "name": "Updated Device Name",
  "type": "sip"
}

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 for the update operation, the node will throw an error stating that the ID is required. Ensure the device ID is correctly specified.
  • API request failures: Network issues or invalid credentials can cause HTTP request errors. Verify API keys and network connectivity.
  • Invalid property values: Providing unsupported device types or empty names may result in API validation errors. Use only allowed values (sip, webrtc) and non-empty strings.
  • 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