3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node allows updating the general settings of a PBX (Private Branch Exchange) system managed by 3CX. It is useful for administrators who want to programmatically configure or modify global telephony settings such as call forwarding permissions, busy signal behavior, outbound call restrictions, and operator extensions.

Typical use cases include:

  • Automating PBX configuration changes during deployment or maintenance.
  • Enforcing company policies on call handling and monitoring.
  • Scheduling report generation times or enabling/disabling features like auto logout.

Properties

Name Meaning
Allow Fwd To External Enable or disable call forwarding to external numbers (true/false).
Busy Monitor Enable or disable busy call monitoring feature (true/false).
Busy Monitor Timeout Set timeout duration (in seconds) for busy monitor before taking action.
Disable Outbound Calls Out Office Hours Restrict outbound calls outside office hours (true/false).
Enable V Menu Outbound Calls Enable or disable voice menu for outbound calls (true/false).
HD Auto Logout Enabled Enable or disable automatic logout for help desk agents (true/false).
HD Auto Logout Time Specify the time duration after which help desk agents are automatically logged out.
Limit Call Pickup Enable or disable restrictions on call pickup (true/false).
Operator Extension Define the extension number assigned to the operator.
Play Busy Enable or disable playing busy tone when lines are busy (true/false).
Scheduled Report Generation Time Set the time for scheduled generation of reports (format: string, e.g., "HH:mm").

Output

The node outputs JSON data representing the updated general settings of the PBX system. This output reflects the current state of all configurable properties after the update operation.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node uses the base URL configured in credentials to send requests to the 3CX API endpoint /xapi/v1.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid property values (e.g., wrong time format) may result in API errors.
    • Network connectivity problems can prevent communication with the 3CX server.

  • Error messages:

    • Authentication errors typically indicate invalid or expired API tokens; reconfigure credentials.
    • Validation errors from the API suggest incorrect input values; verify property formats and allowed ranges.
    • Timeout or connection errors imply network issues; check server availability and firewall settings.

Links and References

Discussion