3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to retrieve detailed information about a particular parameter entity within 3CX. The "Get Parameter" operation fetches data for a single parameter identified by its unique ID. This is useful in scenarios where you need to programmatically access configuration or status details of specific parameters in 3CX, such as retrieving settings or metadata for further processing or automation.

Practical examples include:

  • Fetching a parameter's details to verify or audit telephony configurations.
  • Using parameter data to trigger conditional workflows based on telephony system states.
  • Integrating 3CX parameter information into dashboards or reports.

Properties

Name Meaning
Id The unique identifier of the parameter entity to retrieve. Can be set dynamically via expressions (e.g., {{$json.Id}}).
Options Additional query options to customize the returned data:
- $select Comma-separated list of properties to return for the parameter (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 requested parameter entity from the 3CX system. The structure corresponds to the selected properties and any expanded related entities specified in the options. This JSON typically includes fields like the parameter's ID, name, and other relevant attributes depending on the $select and $expand options.

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

Dependencies

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

Troubleshooting

  • Invalid or missing Id: Ensure the Id property is provided and correctly references an existing parameter. Errors may occur if the ID does not exist or is malformed.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access parameter data.
  • Network issues: Confirm connectivity to the 3CX server URL and that the URL is correctly formatted without trailing slashes.
  • Incorrect $select or $expand values: Using invalid property names in these options can cause the API to reject the request or return incomplete data. Use valid property names as per 3CX API documentation.

Links and References

Discussion