3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list forwarding profiles associated with the current user ("My User"). It is useful in scenarios where you want to retrieve and manage call forwarding settings programmatically within an automation workflow. For example, you might use this node to fetch all forwarding profiles for a user to display them in a dashboard or to automate updates based on certain conditions.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of forwarding profiles:
- Top: Show only the first n items.
- Skip: Skip the first n items.
- Search: Search items by search phrases (supports phrase quoting).
- Filter: Filter items by property values (e.g., State eq 'Connected').
- Count: Include count of items (boolean).
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc).
- Select: Select specific properties to be returned (e.g., Id,Name).
- Expand: Expand related entities (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the list of forwarding profiles for the authenticated user. The structure typically includes an array of forwarding profile objects, each containing properties such as identifiers, names, states, and possibly related entities if expanded. If binary data were involved, it would be summarized here, but this node deals with JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters based on input options.

Troubleshooting

  • Authentication errors: Ensure that the API key credential and server URL are correctly configured and valid.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or other options may cause API errors. Validate these strings according to OData query conventions.
  • Empty results: If no forwarding profiles are returned, verify that the user has forwarding profiles set up and that filters/search terms are not overly restrictive.
  • Network issues: Check connectivity to the 3CX server and firewall settings.

Links and References

Discussion