3CX

Interact with 3CX telephony system

Actions462

Users Actions
- Download Greeting
- Batch Delete
- Get Call Log
- Get Phone Registrars
- Reboot Phone
- Reprovision Phone
- Upgrade Phone
- Generate Prov Link
- Has Duplicated Email
- Get Duplicated Emails
- Send Welcome Email
- List Groups
- List Forwarding Profiles
- Get Phone Secret
- Regenerate
- Regenerate Passwords
- Export Extensions
- Get Phone Registrar
- Bulk Update
- Get User
- Update User
- Delete User
- List Greetings
- Make Call User Record Greeting
- Make Call
- Get Monitor Status
- Set Monitor Status
- Multi User Update
- Reprovision All Phones
- Get Multi Edit Greetings
- Multi Delete Greeting
- Get User By Number
- List User
- Create User
Active Calls Actions
- List Active Call
- Drop Call
Activity Log Actions
- Get Logs
Anti Hacking Settings Actions
- Get Anti Hacking Settings
- Update Anti Hacking Settings
Backups Actions
- List Backups
- Get Backup Extras
- Delete Backups
- Restore
- Backup
- Set Backup Failover Settings
- Get Failover Scripts
- Set Backup Settings
- Set Backup Repository Settings
- Set Restore Settings
Black List Numbers Actions
- List Black List Number
- Create Black List Number
- Get Black List Number
- Update Black List Number
- Delete Black List Number
- Bulk Numbers Delete
Blocklist Actions
- List Blocklist Addr
- Create Blocklist Addr
- Get Blocklist Addr
- Update Blocklist Addr
- Delete Blocklist Addr
- Bulk Ips Delete
Call Cost Settings Actions
- List Call Cost Settings
- Update Cost
Call Flow Apps Actions
- Get Call Flow App
- Update Call Flow App
- Delete Call Flow App
- List Call Flow App
- Create Call Flow App
- Get Files
- Delete File
Call Flow Scripts Actions
- List Call Flow Script
Call History View Actions
- Download Call History
- List Call History View
Call Parking Settings Actions
- Get Call Parking Settings
- Update Call Parking Settings
Call Types Settings Actions
- Get Call Types Settings
- Update Call Types Settings
CDR Settings Actions
- Get CDR Settings
- Update CDR Settings
Chat History View Actions
- List Chat History View
- Download Chat History
Chat Log Settings Actions
- Get Chat Log Settings
- Update Chat Log Settings
Contacts Actions
- Get Contact
- List Contact
- Create Contact
- Set Dir Search Settings
- Batch Contacts Delete
- Update Contact
- Delete Contact
Chat Messages History View Actions
- List Chat Messages History View
- Download Chat Messages History
Codecs Settings Actions
- Get Codecs Settings
- Update Codecs Settings
Conference Settings Actions
- Get Web Meeting Zones
- Get Conference Settings
- Update Conference Settings
- Get Onboard Mcu Data
- Get Onboard Meetings
- Get MCU Rows
- Get MCU Row
- Update MCU Request Status
Console Restrictions Actions
- Get Console Restrictions
- Update Console Restrictions
Countries Actions
- List Country
Country Codes Actions
- Get Country Codes
- Update Country Codes
CRM Integration Actions
- Get Crm Integration
- Update Crm Integration
- Set O Auth State
- Get O Auth
- Get Crm Template Source
Crm Templates Actions
- Ge Crmt Templates
- Get Crm Template
- Delete Crm Template
Custom Prompts Actions
- List Custom Prompt
- Make Call Record Custom Prompt
- Delete Custom Prompt
Data Connector Settings Actions
- Get Data Connector Settings
- Update Data Connector Settings
Defs Actions
- Get Defs
- List Codecs
- List Gateway Parameters
- List Gateway Parameter Values
- List Time Zones
- Get Routes
Device Infos Actions
- List Device Info
- Get Device Info
- Delete Device Info
- Provision
Dial Code Settings Actions
- Get Dial Code Settings
- Update Dial Code Settings
Did Numbers Actions
- List Did Number
DN Properties Actions
- Get Properties By Dn
- Create DN Property
- Update DN Property
- Delete DN Property
- Get DN Property By Name
E 164 Settings Actions
- Get E 164 Settings
- Update E 164 Settings
Email Template Actions
- List Email Template
- Get Email Template
- Update Email Template
- Set Default
Emergency Geo Locations Actions
- List Emergency Geo Location
- Update
Fax Actions
- Create Fax
- Get Fax
- Update Fax
- Delete Fax
- Bulk Fax Delete
- Get Fax By Number
- List Fax
Fax Server Settings Actions
- Update Fax Server Settings
- Get Fax Server Settings
Firewall Actions
- Get Firewall State
Firmwares Actions
- List Firmware
- Delete Firmware
- Push Firmware For Phones
Fxs Actions
- List Fxs
- Create Fxs
- Get Fxs
- Update Fxs
- Delete Fxs
- Regenerate Web Credentials
General Settings For Pbx Actions
- Update General Settings For Pbx
- Get General Settings For Pbx
Google Settings Actions
- Update Google Settings
- Get Google Users
- Get Google Settings
Emergency Notifications Settings Actions
- Get Emergency Notifications Settings
- Update Emergency Notifications Settings
Event Logs Actions
- List Event Log
Fxs Templates Actions
- List Fxs Template
- Create Fxs Template
- Get Fxs Template
- Update Fxs Template
- Delete Fxs Template
General Settings For Apps Actions
- Get General Settings For Apps
- Update General Settings For Apps
Groups Actions
- Get Group
- Update Group
- Delete Group
- List Group
- Create Group
- Get Restrictions
- Delete Company By Number
- Delete Company By Id
- List Members
- Replace Group License Key
- Link Group Partner
- List Rights
Holidays Actions
- List Holiday
- Get Holiday
- Update Holiday
- Delete Holiday
Hotel Services Actions
- Get Hotel Services
- Update Hotel Services
Microsoft 365 Integration Actions
- Authorize Presence
- Get M 365 Users
- Get Microsoft 365 Integration
- Update Microsoft 365 Integration
- Get Users By Principal Names
My Group Actions
- Update My Group
- Get My Group
- List My Group Members
- List My Group Rights
- Replace My Group License Key
- Get My Group Partner Info
- Link My Group Partner
Inbound Rules Actions
- List Inbound Rule
- Create Inbound Rule
- Get Inbound Rule
- Update Inbound Rule
- Delete Inbound Rule
- Bulk Inbound Rules Delete
- Export Caller Id Rules
Last Cdr And Chat Message Timestamp Actions
- List Last Cdr And Chat Message Timestamp
License Status Actions
- Get License Status
- Link Partner
- Partner Info
- Replace License Key
- Edit License Info
Logging Settings Actions
- Get Logging Settings
- Update Logging Settings
Microsoft 365 Teams Integration Actions
- Get Microsoft 365 Teams Integration
- Update Microsoft 365 Teams Integration
- Check Fqdn Record
Music On Hold Settings Actions
- Get Music On Hold Settings
- Update Music On Hold Settings
My Tokens Actions
- List Refresh Token
- Revoke Token
My User Actions
- Get My User
- Update My User
- List My User Groups
- List My User Forwarding Profiles
- List My User Greetings
Network Interfaces Actions
- List Network Interface
Network Settings Actions
- Get Network Settings
- Update Network Settings
- Get Ifaces
Notification Settings Actions
- Get Notification Settings
- Update Notification Settings
Office Hours Actions
- Get Office Hours
- Update Office Hours
Outbound Rules Actions
- Get Outbound Rule
- Update Outbound Rule
- Delete Outbound Rule
- List Outbound Rule
- Create Outbound Rule
- Get Emergency Outbound Rules
- Purge
- Move Up Down
Parameters Actions
- Get Parameter By Name
- List Parameter
- Create Parameter
- Get Parameter
- Update Parameter
- Delete Parameter
Parkings Actions
- List Parking Groups
- Get By Number
- List Parking
- Create Parking
- Get Parking
- Update Parking
- Delete Parking
Peers Actions
- List Peer
- Get Peer By Number
- Get Report Peers
- Retreive Peers By Numbers
Phone Book Settings Actions
- Get Phone Book Settings
- Update Phone Book Settings
Phone Logos Actions
- Delete Phone Logo
- List Phone Logo
Phones Settings Actions
- Get Phones Settings
- Update Phones Settings
Phone Templates Actions
- List Phone Template
- Create Phone Template
- Get Phone Template
- Update Phone Template
- Delete Phone Template
Playlists Actions
- List Playlist
- Create Playlist
- Get Playlist
- Update Playlist
- Delete Playlist
- Delete Playlist File
- Download Playlist File
Prompt Sets Actions
- List Prompt Set
- Get Prompt Set
- Update Prompt Set
- Delete Prompt Set
- List Prompts
- Set Active
- Set Alternate Pronunciation
- Copy
- Play Prompt
- Record Prompt
Purge Settings Actions
- Purge Calls
- Purge Chats
Queues Actions
- Get Queue
- Update Queue
- Delete Queue
- List Queue
- Create Queue
- List Agents
- List Managers
- Reset Queue Statistics
- Get Queue By Number
Receptionists Actions
- List Forwards
- Get Receptionist By Number
- List Receptionist
- Create Receptionist
- Get Receptionist
- Update Receptionist
- Delete Receptionist
Report Queue Failed Callbacks Actions
- Get Queue Failed Callbacks Data
- Download Queue Failed Callbacks
Recordings Actions
- List Recording
- Download Recording
- Set Recording Repository Settings
- Bulk Recordings Delete
- Bulk Recordings Archive
System Status Actions
- Request Help
- Get Request Help Link
- Get System Status
- System Extensions
- Set Chat Log Status
- Set Multi Company Mode
Remote Archiving Settings Actions
- Get Remote Archiving Settings
- Update Remote Archiving Settings
Report Abandoned Chats Statistics Actions
- Get Abandoned Chats Statistics Data
- Download Abandoned Chats Statistics
Report Abandoned Queue Calls Actions
- Get Abandoned Queue Calls Data
- Download Abandoned Queue Calls
Report Agent Login History Actions
- Get Agent Login History Data
- Download Agent Login History
Report Agents In Queue Statistics Actions
- Get Agents In Queue Statistics Data
- Download Agents In Queue Statistics
Report Audit Log Actions
- Get Audit Log Data
- Download Audit Log
Report Average Queue Waiting Time Actions
- Get Average Queue Waiting Time Data
- Download Average Queue Waiting Time Report
Report Breaches Sla Actions
- Get Breaches Sla Data
- Download Breaches Sla
Report Call Cost By Extension Group Actions
- Get Call Cost By Extension Group Data
- Download Call Cost By Extension Group
Report Call Distribution Actions
- Get Call Distribution
- Download Get Get Call Distribution
Report Call Log Data Actions
- Get Call Log Data
- Get Old Call Log Data
- Download Call Log
- Get Call Quality Report
Report Detailed Queue Statistics Actions
- Get Detailed Queue Statistics Data
- Download Detailed Queue Statistics
Report Extensions Statistics By Ring Groups Actions
- Get Extensions Statistics By Ring Groups Data
- Download Extensions Statistics By Ring Groups
Report Extension Statistics By Group Actions
- Get Extension Statistics By Group Data
- Download Extension Statistics By Group
Report Extension Statistics Actions
- Get Extension Statistics Data
- Download Extension Statistics
Report Inbound Rules Actions
- Get Inbound Rules Data
- Download Inbound Rules
Report Queue Agents Chat Statistics Actions
- Get Queue Agents Chat Statistics Data
- Download Queue Agents Chat Statistics
Report Queue Agents Chat Statistics Totals Actions
- Get Queue Agents Chat Statistics Totals Data
- Download Queue Agents Chat Statistics Totals
Report Queue Answered Calls By Wait Time Actions
- Get Queue Answered Calls By Wait Time Data
- Download Queue Answered Calls By Wait Time
Report Queue An Un Calls Actions
- Get Queue An Un Calls Data
- Download Queue An Un Calls Report
Report Queue Callbacks Actions
- Get Queue Callbacks Data
- Download Queue Callbacks
Report Queue Chat Performance Actions
- Get Queue Chat Performance Data
- Download Queue Chat Performance
Report Statistic Sla Actions
- Get Statistic Sla Data
- Download Statistic Sla
Report Queue Performance Overview Actions
- Get Queue Performance Overview Data
- Download Queue Performance Overview
Report Queue Performance Totals Actions
- Get Queue Performance Totals Data
- Download Queue Performance Totals
Report Ring Group Statistics Actions
- Get Ring Group Statistics Data
- Download Ring Group Statistics
Sbcs Actions
- Create Sbc
- Get Sbc
- Update Sbc
- Delete Sbc
- List Sbc
Secure Sip Settings Actions
- Get Secure Sip Settings
- Update Secure Sip Settings
Report Team Queue General Statistics Actions
- Get Team Queue General Statistics Data
- Download Team Queue General Statistics
Scheduled Reports Actions
- List Scheduled Report
- Create Scheduled Report
- Get Scheduled Report
- Update Scheduled Report
- Delete Scheduled Report
Ring Groups Actions
- Get Ring Group
- Update Ring Group
- Delete Ring Group
- List Ring Group
- Create Ring Group
- List Ring Group Members
- Get Ring Group By Number
Security Tokens Actions
- List Security Refresh Token
- Revoke Security Token
Service Principals Actions
- Get Service Principal
- Update Service Principal
- Delete Service Principal
- List Service Principal
- Create Service Principal
- Generate App Token
Services Actions
- List Service Info
- Garbage Collect
- Start
- Stop
- Enable
- Disable
- Restart
Sip Devices Actions
- List Sip Device
- Push Firmware
Directories Actions
- Get Directory Info
Tenant Properties Actions
- List Property
- Create Property
- Get Property
- Update Property
- Delete Property
Trunks Actions
- Get Trunk
- Update Trunk
- Delete Trunk
- Init Trunk
- Export Trunk
- Refresh Registration
- Set Routes
- Get Trunk By Number
- List Trunk
- Create Trunk
- Get Provider Available Phone Numbers
- Finalize Trunk Provisioning
Trunk Templates Actions
- List Trunk Template
- Create Trunk Template
- Get Trunk Template
- Update Trunk Template
- Delete Trunk Template
Updates Actions
- Set Update Settings
- Install Updates
Voicemail Settings Actions
- Get Transcribe Languages
- Get Voicemail Settings
- Update Voicemail Settings
Website Links Actions
- List Weblink
- Create Weblink
- Validate Link
- Bulk Links Delete
- Get Weblink
- Update Weblink
- Delete Weblink
Report Inbound Calls Actions
- Get Inbound Calls
- Download Get Inbound Calls
Report Outbound Calls Actions
- Get Outbound Calls
- Download Get Outbound Calls
Report User Activity Actions
- Get User Activity
- Download Get User Activity

Overview

This node operation allows users to update notification settings for the 3CX telephony system. It is useful in scenarios where administrators want to customize which system events trigger notifications and configure email-related settings such as SMTP server details and authorized email addresses. For example, an admin can enable or disable alerts for network errors, license limits, or voicemail quota thresholds, and specify the mail server credentials used to send these notifications.

Properties

Name	Meaning
Can Edit Email Addresses	Boolean flag indicating if email addresses can be edited
Can Edit Mail Server Type	Boolean flag indicating if the mail server type can be changed
Email Addresses	Comma-separated string of email addresses to receive notifications
Fake Id	A string identifier (purpose depends on implementation context)
Mail Address	The email address used as the sender for notification emails
Mail Password	JSON object containing the password or authentication details for the mail server
Mail Server	The hostname or IP address of the SMTP mail server
Mail Server Type	Type of mail server; options: "Tcx", "MS 365", "Custom", "Google Workspace"
Mail Ssl Enabled	Boolean flag to enable or disable SSL for the mail server connection
Mail User	Username for authenticating with the mail server
Notify Call Denied	Enable notification when a call is denied
Notify Emergency Number Dialed	Enable notification when an emergency number is dialed
Notify Extension Added	Enable notification when a new extension is added
Notify IP Blocked	Enable notification when an IP address is blocked
Notify License Limit	Enable notification when license limits are reached
Notify Network Error	Enable notification on network errors
Notify Request Anti Hacked	Enable notification on anti-hacking requests
Notify Service Stopped	Enable notification when a service stops
Notify Storage Limit	Enable notification when storage limits are reached
Notify STUN Error	Enable notification on STUN protocol errors
Notify Success Scheduled Backups	Enable notification when scheduled backups succeed
Notify System Owners	Enable notification sent to system owners
Notify Trunk Error	Enable notification on trunk errors
Notify Trunk Failover	Enable notification on trunk failover events
Notify Trunk Status Changed	Enable notification when trunk status changes
Notify Updates Available	Enable notification when updates are available
Notify When Recordings Quota Reached	Enable notification when recordings quota threshold is reached
Notify When Voicemail Quota Reached	Enable notification when voicemail quota threshold is reached
Recordings Quota Percentage	Numeric value specifying the percentage threshold for recordings quota
Voicemail Quota Percentage	Numeric value specifying the percentage threshold for voicemail quota

Output

The node outputs JSON data representing the updated notification settings after the operation completes. This typically includes confirmation of the applied settings or any relevant response from the 3CX API. There is no indication that binary data is output by this operation.

Dependencies

Requires an API key credential for authenticating with the 3CX telephony system.
The node uses the base URL configured in the credentials to send requests to the 3CX API endpoint /xapi/v1.
Proper configuration of the mail server and authentication details is necessary for email notifications to function correctly.

Troubleshooting

Invalid Credentials: If the API key or mail server credentials are incorrect, the node will fail to update settings. Verify all authentication details.
Incorrect Mail Server Settings: Misconfigured mail server parameters (host, user, password, SSL) may cause notification emails not to send.
Permission Issues: If Can Edit Email Addresses or Can Edit Mail Server Type flags are false, attempts to change those fields might be rejected.
Quota Thresholds: Setting invalid quota percentages (e.g., negative numbers or values above 100) could lead to errors.
Network Errors: Connectivity issues with the 3CX server or mail server will prevent successful updates.

Links and References

3CX Official Documentation
3CX API Reference (for detailed API endpoints and payloads)
SMTP Configuration Guides

3CXInstall