3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve console restrictions. The "Get Console Restrictions" operation fetches a list of console restriction entities from the 3CX system, allowing users to query and filter these restrictions based on various criteria.

Common scenarios for this node include:

  • Retrieving a filtered or paginated list of console restrictions to monitor or audit telephony system access.
  • Searching for specific console restrictions by name or other properties.
  • Selecting only certain fields or expanding related entities to optimize data retrieval.

Practical example:

  • A user wants to get the first 10 console restrictions that are currently active and order them by creation date descending. They can use the $top, $filter, and $orderby options to achieve this.

Properties

Name Meaning
Options Collection of optional query parameters to customize the request:
- $top Show only the first n items (pagination limit).
- $skip Skip the first n items (pagination offset).
- $search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be quoted automatically.
- $filter Filter items by property values, 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, e.g., RelatedEntity1,RelatedEntity2.

Output

The node outputs JSON data representing the retrieved console restrictions. The structure corresponds to the queried entities from the 3CX API, including any selected or expanded properties as specified in the input options.

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

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 credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData-like query options may cause errors. Validate query strings carefully.
  • Empty results: Check if filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL configured in credentials.

Links and References

Discussion