TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node "TeleFlow" allows interaction with the TeleFlow API to manage various telephony-related resources. Specifically, for the Flow resource and the Update operation, this node updates an existing Flow entity by its unique ID with new field values.

This node is beneficial in scenarios where you need to programmatically modify telephony flows, such as updating call routing rules or flow configurations without manual intervention. For example, you might update a flow's name or parameters dynamically based on external triggers or data changes.

Properties

Name Meaning
ID The unique identifier of the Flow resource to update. This is required to specify which Flow to update.
Fields A collection of field-value pairs representing the properties of the Flow to update. Each pair consists of:
- Name: The field name to update.
- Value: The new value for that field.

Note: The provided input properties JSON only defines id and fields. However, from the source code, it appears that for some resources, specific fields like name are expected. Since the focus is on the Flow resource, and no explicit field mappings are shown in the code for Flow, the fields collection is used to specify arbitrary fields to update.

Output

The output of the node is an array containing one item per input item processed. Each output item has a json property holding the response from the TeleFlow API after the update operation.

  • The json object contains the updated Flow resource data as returned by the API.
  • No binary data output is indicated.

Example output structure (simplified):

{
  "json": {
    "id": "flow-id",
    "name": "Updated Flow Name",
    "otherField": "updatedValue",
    ...
  }
}

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the TeleFlow API.
  • The base URL for the API is taken from the credential configuration.
  • The node uses HTTP methods (PUT) to communicate with the TeleFlow REST API endpoints.

Troubleshooting

  • Missing ID Error: If the ID property is not provided for the update operation, the node will throw an error stating "ID is required for update operation". Ensure the ID of the Flow to update is specified.
  • API Request Failures: Network issues, invalid credentials, or incorrect field names may cause the API request to fail. Check the API key validity, endpoint URL, and field names.
  • Invalid Field Names: Since fields are passed as key-value pairs, providing incorrect or unsupported field names may result in API errors or ignored updates.
  • 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


If you want me to analyze other operations or resources, please provide their details!

Discussion