3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get Fax" operation in the Fax resource allows users to retrieve detailed information about a specific fax entity by its unique identifier. This node is useful when you need to fetch metadata or status of a particular fax message within the 3CX telephony system. Practical scenarios include checking the delivery status of a sent fax, retrieving fax details for logging or auditing purposes, or integrating fax data into other workflows.

Properties

Name Meaning
Id The unique identifier of the fax entity to retrieve. Can be set directly or via an expression.
Options Additional query options to customize the returned data:
- Select ($select) Comma-separated list of properties to return for the fax (e.g., Id,Name).
- Expand ($expand) Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the fax entity corresponding to the provided Id. The structure includes all requested properties and any expanded related entities as specified in the options. This output can be used downstream in workflows for further processing or decision-making.

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 a base URL for the 3CX API server configured in credentials.
  • Network access to the 3CX API endpoint is necessary.

Troubleshooting

  • Invalid Id: If the provided fax Id does not exist, the API may return a "not found" error. Verify the Id value and ensure it corresponds to an existing fax.
  • Authentication errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key or OAuth token is correctly configured.
  • Incorrect $select or $expand values: Providing invalid property names in these options may result in API errors or incomplete data. Use valid property names as per 3CX API documentation.
  • Network issues: Connectivity problems to the 3CX server will prevent data retrieval. Check network settings and server availability.

Links and References

Discussion