3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to list users. It allows retrieving a collection of user records from the 3CX system, supporting various query options such as filtering, searching, ordering, and pagination. This is useful in scenarios where you want to automate workflows involving user data from 3CX, for example, syncing user lists with other systems, generating reports, or triggering actions based on user attributes.

Properties

Name Meaning
Options A collection of optional query parameters to customize the user listing:
$top Show only the first n items (limit the number of returned users).
$skip Skip the first n items (offset for pagination).
$search Search users by search phrases. If the phrase contains spaces and is not quoted, it will be quoted automatically.
$filter Filter users by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of total matching items (boolean).
$orderby Order users 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.

Output

The node outputs JSON data representing the list of users retrieved from the 3CX system. The structure corresponds to the API response and includes user properties as specified by the $select option or all properties by default. If $count is enabled, the output also includes the total count of matching users. No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed filter or orderby strings) may result in API errors.
    • Network connectivity problems can prevent reaching the 3CX server.
  • Error messages:
    • Authentication errors typically indicate invalid or expired credentials; verify and update the API key.
    • Query syntax errors suggest incorrect usage of OData query options; review the filter, search, and orderby expressions.
    • Timeout or connection errors require checking network access and the correctness of the server URL.

Links and References

Discussion