3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve fax server settings. The "Get Fax Server Settings" operation fetches configuration details about the fax servers integrated into the 3CX system. This is useful for administrators or automation workflows that need to monitor, audit, or manage fax server configurations programmatically.

Practical examples include:

  • Automatically retrieving and displaying current fax server settings in a dashboard.
  • Integrating fax server data into reporting tools.
  • Triggering alerts or actions based on specific fax server states or properties.

Properties

Name Meaning
Options A collection of optional query parameters to customize the request:
- 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-tuning the data retrieval to match specific needs such as pagination, filtering, sorting, and selecting relevant fields.

Output

The node outputs JSON data representing the fax server settings retrieved from the 3CX system. The structure typically includes an array of fax server objects with their properties as requested via the $select option or all properties by default.

If binary data were involved (not indicated here), it would represent files or attachments related to fax servers, but this node focuses on JSON metadata 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 API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth token is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, search, or select syntax may cause API errors. Validate OData-like query strings.
  • Empty results: Check if filters or search terms are too restrictive or if the fax server settings exist.
  • Network issues: Verify connectivity to the 3CX server URL and that the server is reachable.

Links and References

Discussion