3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Update Fax" operation in this node allows users to modify the properties of an existing fax entity within a 3CX telephony system. This is useful for updating fax configurations such as authentication credentials, server settings, group permissions, and caller identification details. Practical scenarios include changing the fax number, updating authentication info after password changes, or adjusting transcription modes for received faxes.

Properties

Name Meaning
Id The unique identifier of the fax entity to update. Can be set dynamically using expressions.
Auth ID Authentication ID used for accessing the fax service.
Auth Password Password corresponding to the Auth ID for authentication.
Fax Server Boolean flag indicating whether the fax server feature is enabled or disabled.
Groups JSON object defining group rights, individual rights, and tags associated with the fax.
Number The fax number assigned to this fax entity.
Outbound Caller Id The caller ID that will appear on outbound faxes sent from this entity.
Transcription Mode Defines how fax transcriptions are handled. Options: Nothing, Voicemail, Recordings, Both, Inherit.

Output

The node outputs JSON data representing the updated fax entity after the operation completes. This typically includes the updated properties reflecting the changes made. There is no indication that binary data is output by this operation.

Dependencies

  • Requires connection to a 3CX telephony system API.
  • Needs an API authentication token (OAuth2 or similar) configured in n8n credentials.
  • The base URL for the 3CX API must be provided in the credentials configuration.

Troubleshooting

  • Invalid Id: If the provided fax Id does not exist, the API may return an error indicating the entity was not found. Verify the Id value.
  • Authentication Errors: Incorrect Auth ID or Auth Password can cause authentication failures. Ensure credentials are correct and up to date.
  • Malformed Groups JSON: The Groups property expects valid JSON. Invalid JSON syntax will cause parsing errors.
  • Permission Issues: Insufficient rights to update fax entities may result in authorization errors.
  • Transcription Mode Values: Using unsupported values for Transcription Mode will likely cause validation errors; use one of the predefined options.

Links and References

Discussion