3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing an operation to list parking entities. This operation retrieves a collection of parking records from the 3CX API, allowing users to query and filter parking data according to various criteria.

Common scenarios where this node is beneficial include:

  • Retrieving a list of current parking sessions or spots managed by the 3CX system.
  • Filtering parking data based on specific attributes such as state or creation date.
  • Paginating through large sets of parking records.
  • Selecting only certain fields or expanding related entities for detailed information.

Practical example:

  • A user wants to get the first 10 active parking sessions ordered by creation time descending.
  • Another use case could be searching for parking entries matching a particular keyword or filtering by status.

Properties

Name Meaning
Options Collection of optional query parameters to customize the listing of parking items:
$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 auto-quoted.
$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 output JSON contains the list of parking items retrieved from the 3CX API according to the specified query options. Each item represents a parking entity with its properties as returned by the API.

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

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is correctly configured and valid.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other query options can cause API errors. Validate these strings against 3CX API documentation.
  • Empty results: Check if the filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL.
  • Unexpected response structure: Confirm that the 3CX API version matches the expected schema.

Links and References

Discussion