3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to list call cost settings. It is useful for retrieving detailed information about call cost configurations within a 3CX environment. Typical use cases include auditing call costs, integrating call cost data into reporting workflows, or dynamically adjusting telephony settings based on cost parameters.

Properties

Name Meaning
Options A collection of query options to customize the listing of call cost settings:
- Top Show only the first n items
- Skip Skip the first n items
- Search Search items by search phrases; supports phrase quoting automatically
- Filter Filter items by property values (e.g., State eq 'Connected')
- Count Include count of items (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)

These options allow fine-grained control over the API query to retrieve exactly the desired subset and shape of call cost settings.

Output

The node outputs JSON data representing the list of call cost settings retrieved from the 3CX system. The structure corresponds to the queried properties and may include expanded related entities if requested. If the "Count" option is enabled, the output will also include the total number of items matching the query.

No binary data output is produced by this operation.

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 /xapi/v1 endpoint of the 3CX server.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, orderby, or select syntax can cause API errors. Verify the syntax matches 3CX API expectations.
  • Empty results: Check that the filter and search criteria are correct and that the 3CX system contains relevant call cost settings.
  • Connection issues: Confirm the server URL is reachable and correctly formatted without trailing slashes.

Links and References

Discussion