3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to list groups associated with a user. It is useful in scenarios where you need to retrieve group information for a particular user entity within 3CX, such as managing user permissions, monitoring group memberships, or integrating group data into workflows.

For example, you might use this node to:

  • Fetch all groups a specific user belongs to for reporting purposes.
  • Automate updates or notifications based on group membership changes.
  • Integrate 3CX user group data with other systems like CRM or helpdesk software.

Properties

Name Meaning
Id The unique identifier of the user entity whose groups you want to list. Can be set via expression.
Options Additional query options to customize the list request:
- Top ($top) Limit the number of returned items to the first n entries.
- Skip ($skip) Skip the first n items in the result set.
- Search ($search) Search groups by phrases; supports quoted phrases for exact matches.
- Filter ($filter) Filter groups by property values using OData syntax (e.g., State eq 'Connected').
- Count ($count) Include the total count of matching items in the response (boolean).
- Orderby ($orderby) Order the results by specified properties (e.g., Name desc, CreatedAt asc).
- Select ($select) Select specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expand related entities to include additional linked data (e.g., RelatedEntity1).

Output

The node outputs JSON data representing the list of groups associated with the specified user ID. The structure typically includes an array of group objects, each containing properties such as group identifiers, names, and any selected or expanded related data as per the query options.

If binary data were involved, it would be summarized here, but this node focuses on JSON responses from the 3CX API.

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 provided in the node's credential configuration.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.

Troubleshooting

  • Invalid or missing user Id: Ensure the Id property is correctly set and corresponds to an existing user in 3CX.
  • Authentication errors: Verify that the OAuth2 credentials are valid and have sufficient permissions to access user group data.
  • API endpoint issues: Confirm the 3CX server URL is correct and accessible from your environment.
  • Query option syntax errors: When using filters, search, or orderby options, ensure the syntax follows OData conventions expected by the 3CX API.
  • Empty results: Check if the user actually belongs to any groups or if filters/search criteria are too restrictive.

Links and References

Discussion