TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage SIP Trunks among other resources. Specifically, the Update operation for the SIP Trunk resource allows users to modify existing SIP trunk configurations by specifying the unique ID of the SIP trunk and updating its properties such as name and host.

Common scenarios where this node is beneficial include:

  • Updating the hostname or IP address of a SIP trunk when infrastructure changes.
  • Renaming a SIP trunk for better identification or organizational purposes.
  • Automating bulk updates of SIP trunks in a telephony system integrated with TeleFlow.

Example use case: A telecom administrator wants to update the host address of a SIP trunk after migrating to a new server. Using this node, they can specify the SIP trunk ID and provide the new host value to update it seamlessly.

Properties

Name Meaning
ID The unique identifier of the SIP trunk to update. This is required to specify which SIP trunk to modify.
Name The new name for the SIP trunk. Used to rename the SIP trunk.
Host The new hostname or IP address of the SIP trunk. Used to update where the SIP trunk points.
Fields Additional field-value pairs for more specific queries (not typically used in update).

Output

The output is a JSON object representing the updated SIP trunk resource as returned by the TeleFlow API. It contains all the current properties of the SIP trunk after the update operation.

No binary data output is produced by this node.

Dependencies

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

Troubleshooting

  • Missing ID Error: If the "ID" property is not provided, the node will throw an error stating that the ID is required for the update operation. Ensure you provide a valid SIP trunk ID.
  • API Request Failures: Network issues, invalid credentials, or incorrect hostnames may cause HTTP request failures. Verify API credentials and network connectivity.
  • Invalid Property Values: Providing invalid values for "Name" or "Host" might result in API errors. Confirm that the values conform to expected formats.
  • 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