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 groups within the system. It is useful for scenarios where users need to retrieve and manage group information from their 3CX environment, such as fetching a list of call groups or user groups for reporting, monitoring, or automation purposes.

For example, a user might want to list all groups to display them in a dashboard, filter groups based on certain criteria, or paginate through large sets of groups.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list of groups returned:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be wrapped in quotes automatically.
$filter Filter items by property values using OData-style expressions (e.g., State eq 'Connected').
$count Include count of items in the response (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 to include additional linked data (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the list of groups retrieved from the 3CX API. The structure typically includes an array of group objects, each containing properties as requested via $select or default fields. If $count is enabled, the output may also include metadata about the total number of groups available.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the 3CX server.
  • The node expects a base URL for the 3CX API server, configured in the credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.
  • The request headers specify Accept: application/json.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token provided in credentials is valid and has sufficient permissions to access group data.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData queries can cause errors. Validate these expressions against 3CX API documentation.
  • Empty results: If no groups are returned, verify that the filters and search terms are correct and that groups exist in the 3CX system.
  • Network issues: Confirm that the base URL is reachable and correctly formatted (no trailing slash).

Links and References

Discussion