Voicenter icon

Voicenter

Consume Voicenter API (v.0.1.7)

Actions10

Overview

This node integrates with the Voicenter API, specifically supporting operations related to an External IVR (Interactive Voice Response) system. The goToLayer operation allows directing a call flow to a specified IVR layer, optionally providing status information, caller name, and custom CRM data. This is useful in scenarios where calls need to be programmatically routed through different IVR menus or layers based on dynamic conditions or external triggers.

Practical examples include:

  • Automatically routing a customer call to a specific IVR menu layer after verifying their account status.
  • Passing custom CRM data to the IVR system to personalize the interaction.
  • Indicating call status (OK or Error) to influence IVR behavior.

Properties

Name Meaning
Status Indicates the call status; options are: OK (0) or Error (1), where Error means an issue occurred on the client's side.
Layer Numeric identifier of the IVR layer to which the call should be routed.
Caller Name Optional string specifying the name of the caller.
Custom Data A collection of key-value pairs representing internal CRM information that can be passed via the External CDR notification API. Each item has a Name and a Value.
Merge JSON parameters Boolean flag to enable merging additional JSON parameters into the request using lodash's merge functionality.
JSON Raw JSON input used to append or update parameters when "Merge JSON parameters" is enabled.

Output

The node outputs JSON data representing the result of the goToLayer operation. This typically includes confirmation of the action taken, any response data from the Voicenter API, and possibly error messages if the operation failed.

If binary data were involved (not indicated here), it would represent media or files related to the call or IVR session, but this node focuses on JSON structured data only.

Dependencies

  • Requires an active connection to the Voicenter API via an API key credential configured in n8n.
  • Uses the Voicenter client library internally to communicate with the API.
  • Relies on lodash's merge function for JSON parameter merging if enabled.
  • No other external services or environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid layer numbers or statuses may result in API errors.
    • Malformed JSON in the JSON property when merging parameters can cause parsing errors.

  • Error Messages:

    • Authentication errors: Verify that the API key credential is correctly set up and valid.
    • Validation errors from the API: Check that the Layer number and Status values conform to expected ranges.
    • JSON parsing errors: Ensure that the JSON input is well-formed and valid.

Resolving these usually involves checking credentials, validating input parameters, and ensuring correct JSON formatting.

Links and References

Discussion