3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node integrates with the 3CX telephony system, specifically allowing users to retrieve detailed information about a Call Flow App by its unique identifier. This operation is useful in scenarios where you need to programmatically access configuration or status details of specific call flow applications within 3CX, such as for monitoring, reporting, or automation workflows.

For example, you might use this node to fetch the settings of a particular call flow app before updating it or to verify its existence and properties during an automated deployment process.

Properties

Name Meaning
Id The unique numeric identifier of the Call Flow App to retrieve. Supports expressions like {{$json.Id}}. This is a required property.
Options Additional query options to customize the data returned:
- Select ($select) Comma-separated list of specific properties of the Call Flow App to return (e.g., Id,Name).
- Expand ($expand) Comma-separated list of related entities to expand and include in the response (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the Call Flow App entity corresponding to the provided Id. The structure includes all requested properties and any expanded related entities as specified in the options.

If binary data were involved (not indicated here), it would typically represent media or files associated with the call flow app, but this node focuses on JSON metadata retrieval.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers.

Troubleshooting

  • Invalid or missing Id: Ensure the Id property is set and corresponds to an existing Call Flow App in 3CX.
  • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network issues: Confirm that the 3CX server URL is reachable from the n8n instance.
  • Incorrect $select or $expand values: Using invalid property names may result in incomplete or error responses; check 3CX API documentation for valid fields.

Links and References

Discussion