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 members of "My Group" within 3CX. It is useful for scenarios where users need to retrieve and manage group member information programmatically, such as displaying current group members in a dashboard, automating group management tasks, or integrating group data with other systems.

For example, a user might want to fetch all members of their call group to display their status or contact details in a custom application or to automate notifications based on group membership changes.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of group members:
- Top ($top) Limits the number of returned items to the first n entries.
- Skip ($skip) Skips the first n items in the result set, useful for pagination.
- Search ($search) Searches items by phrases; supports automatic quoting if the phrase contains spaces.
- Filter ($filter) Filters items by property values using expressions (e.g., State eq 'Connected').
- Count ($count) Includes the count of total items matching the query when set to true.
- Orderby ($orderby) Orders items by specified property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Selects specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expands related entities to include additional linked data (e.g., RelatedEntity1).

These options allow fine-grained control over the data retrieval from the 3CX API.

Output

The node outputs JSON data representing the list of group members retrieved from the 3CX system. The structure typically includes an array of member objects, each containing properties such as identifiers, names, states, and any other selected or expanded fields as per the input options.

If binary data were involved (not indicated here), it would represent files or media associated with group members, but this node focuses on JSON data only.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be provided via credentials.
  • The node uses HTTP requests with JSON headers to communicate with the 3CX API.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions to access group member data.
  • Invalid query parameters: Incorrect filter, search, or orderby syntax may cause API errors. Validate expressions against 3CX API documentation.
  • Empty results: Check if the group actually has members or if filters/search criteria are too restrictive.
  • Network issues: Verify connectivity to the 3CX server and correct base URL configuration.
  • API version mismatch: Confirm that the 3CX API version matches what the node expects (/xapi/v1).

Links and References

Discussion