3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to export user extensions. It is useful for scenarios where you need to retrieve and manage user extension data from a 3CX system, such as synchronizing user information, auditing extensions, or integrating 3CX user data into other systems.

The "Export Extensions" operation allows fetching user extension details with various query options to control the output, including filtering, searching, ordering, and pagination.

Properties

Name Meaning
Options A collection of optional query parameters to customize the export of user extensions:
$top Show only the first n items (limit the number of returned extensions).
$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 auto-quoted.
$filter Filter items by property values (e.g., State eq 'Connected').
$count Include count of items in the response (boolean).
$select Select specific properties to be returned (comma-separated list, e.g., Id,Name).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$expand Expand related entities (comma-separated list of related entities to include).

Output

The node outputs JSON data representing the exported user extensions from the 3CX system. The structure corresponds to the queried user extension objects, potentially filtered and shaped according to the input options.

If the $count option is enabled, the output will also include the total count of matching items.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends requests to the 3CX 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 communication with the 3CX server.

  • Error messages:

    • Authentication errors typically indicate invalid or expired credentials; verify and update the API key/token.
    • Query parameter errors suggest syntax issues; review the OData query syntax used in filters, search, and ordering.
    • Timeout or connection errors require checking network access and the correctness of the server URL.

Links and References

Discussion