TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

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 to multiple SIP trunks via workflows.

Practical example:

  • 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 to include in requests (used mainly in get/getAll operations, less relevant for update).

Output

The output is an array of JSON objects representing the updated SIP trunk(s) returned from the TeleFlow API after the update operation. Each JSON object contains the details of the SIP trunk including its updated properties such as id, name, host, and potentially other metadata provided by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "host": "string",
  // other fields as returned by the API
}

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 methods (GET, POST, PUT, DELETE) to interact with the API endpoints.

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 ID is correctly set.
  • API authentication errors: If the API key or base URL is incorrect or missing, the node will fail to connect. Verify credentials and endpoint configuration.
  • Invalid host or name values: Providing invalid formats for the host (e.g., malformed IP or hostname) may cause API errors. Validate input before running.
  • Network issues: Connectivity problems to the TeleFlow API endpoint will result in request failures. Check network access and firewall settings.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.

Links and References

Discussion