TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including Carriers. Specifically, the "Update" operation for the Carrier resource allows users to modify existing carrier records by specifying the carrier's unique ID and the fields to update. This is useful in scenarios where carrier details need to be changed or corrected without creating a new record.

Practical examples include:

  • Updating the name or configuration details of a carrier after changes in your telephony infrastructure.
  • Correcting data entry errors in carrier information.
  • Automating carrier updates as part of a larger workflow that manages telephony resources.

Properties

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

Output

The node outputs an array of JSON objects, each representing the response from the TeleFlow API after attempting to update a carrier. The JSON structure corresponds to the updated carrier resource returned by the API, typically including the updated fields and metadata about the carrier.

No binary data output is produced by this operation.

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 (PUT) to communicate with the TeleFlow REST endpoints.

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 carrier ID.
  • API Request Failures: Network issues, invalid credentials, or incorrect field names/values may cause the API request to fail. Check the API key validity, network connectivity, and ensure the fields being updated are supported by the TeleFlow API.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one update fails, returning the error message in the output JSON for the failed item.

Links and References

Discussion