3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to list forwarding profiles associated with a user. It is useful in scenarios where you need to retrieve and manage call forwarding settings for users within the 3CX system, such as automating user configuration audits or integrating forwarding profile data into other workflows.

For example, you might use this node to:

  • Fetch all forwarding profiles of a specific user to display or analyze their call routing setup.
  • Automate updates or reporting on user forwarding configurations in bulk.

Properties

Name Meaning
Id The unique identifier of the user entity whose forwarding profiles are to be listed.
Options Additional query options to control the listing behavior:
- Top: Show only the first n items
- Skip: Skip the first n items
- Search: Search items by search phrases
- 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 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 specified user. Each item in the output corresponds to a forwarding profile entity with its properties as returned by the 3CX API. The exact structure depends on the API response but typically includes identifiers, names, states, and related forwarding settings.

If binary data were involved (not indicated here), it would represent files or media related to forwarding profiles, but this node focuses on JSON data.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials.
  • The base URL for the 3CX API must be set in the node credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing user Id: Ensure the Id property is provided and correctly references an existing user in 3CX.
  • Authentication errors: Verify that the OAuth2 credentials are valid and have sufficient permissions to access user forwarding profiles.
  • API endpoint issues: Confirm the server URL is correct and reachable; trailing slashes are handled automatically.
  • Query option misuse: Incorrect filter or search syntax may cause API errors; validate OData-like query expressions.
  • Empty results: Could indicate no forwarding profiles exist for the user or filters exclude all entries.

Links and References

Discussion