3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to retrieve information about a parking entity by its ID. It is useful in scenarios where you need to fetch detailed data about a specific parking resource within the 3CX system, such as for monitoring, reporting, or integration with other systems.

For example, you might use this node to:

  • Retrieve details of a particular parking spot or resource by its unique identifier.
  • Expand related entities linked to the parking resource to get more comprehensive data.
  • Select specific properties of the parking entity to optimize data retrieval and reduce payload size.

Properties

Name Meaning
Id The unique identifier of the parking entity to retrieve. Supports expressions like {{$json.Id}}. This is a required numeric field.
Options A collection of optional query parameters:
- $select Comma-separated list of properties to be returned (e.g., "Id,Name").
- $expand Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the parking entity retrieved from the 3CX system. The structure of the JSON depends on the selected properties and expanded related entities specified in the input options.

If binary data were involved (not indicated here), it would typically represent files or media associated with the parking entity, but this node focuses on JSON data output.

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 API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing Id: Ensure the Id property is provided and correctly references an existing parking entity.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Incorrect $select or $expand values: Use valid property names and related entity names supported by the 3CX API to avoid errors or empty responses.
  • Network issues: Check connectivity to the 3CX server URL configured in the credentials.

Links and References

Discussion