3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node allows you to create a new user in the 3CX telephony system. It is useful for automating user management tasks such as onboarding new employees, setting up user profiles with specific telephony permissions, and configuring user-related telephony settings programmatically. For example, you can use this node to add a new employee to your phone system with their extension number, voicemail settings, call forwarding rules, and calendar integrations all configured automatically.

Properties

Name Meaning
Access Password Password used for user access authentication.
Allow Lan Only Whether the user is restricted to LAN access only (true/false).
Allow Own Recordings Whether the user is allowed to access their own call recordings (true/false).
Auth ID Authentication identifier for the user.
Auth Password Authentication password for the user.
Blfs Busy Lamp Field settings as a string.
Break Time JSON object defining break periods for the user.
Call Screening Enable or disable call screening (true/false).
Call Us Enable Chat Enable chat feature on "Call Us" (true/false).
Call Us Enable Phone Enable phone feature on "Call Us" (true/false).
Call Us Enable Video Enable video feature on "Call Us" (true/false).
Call Us Requirement Requirement for "Call Us" form: Both, Name, Email, or None.
Click To Call Id Identifier for click-to-call functionality.
Contact Image URL or path to user's contact image.
Current Profile Name Name of the current profile assigned to the user.
Deskphone Password Password for deskphone device.
Display Name User's display name.
Email Address User's email address.
Emergency Additional Info Additional emergency information.
Emergency Location Id Identifier for emergency location.
Enable 2 FA Enable two-factor authentication (true/false).
Enabled Whether the user account is enabled (true/false).
Enable Hotdesking Enable hotdesking feature (true/false).
First Name User's first name.
Forwarding Exceptions JSON array defining exceptions to call forwarding rules.
Forwarding Profiles JSON array defining call forwarding profiles and routes.
Google Calendar Enabled Enable Google Calendar integration (true/false).
Google Contacts Enabled Enable Google Contacts integration (true/false).
Google Sign In Enabled Enable Google sign-in for the user (true/false).
Greetings JSON array defining greeting messages/settings.
Groups JSON array defining groups the user belongs to, including rights and tags.
Hide In Phonebook Whether to hide the user in the phonebook (true/false).
Hotdesking Assignment Assignment details for hotdesking.
Hours JSON object defining working hours periods.
Id Numeric identifier for the user.
Internal Whether the user is internal (true/false).
Is Registered Whether the user is registered (true/false).
Language User's preferred language.
Last Name User's last name.
Mobile User's mobile phone number.
MS 365 Calendar Enabled Enable Microsoft 365 Calendar integration (true/false).
MS 365 Contacts Enabled Enable Microsoft 365 Contacts integration (true/false).
MS 365 Sign In Enabled Enable Microsoft 365 sign-in (true/false).
MS 365 Teams Enabled Enable Microsoft Teams integration (true/false).
My Phone Allow Delete Recordings Allow user to delete their own recordings (true/false).
My Phone Hide Forwardings Hide forwarding options in user's phone interface (true/false).
My Phone Push Enable push notifications to user's phone (true/false).
My Phone Show Recordings Show recordings in user's phone interface (true/false).
Number User's extension or phone number.
Office Hours Props JSON array defining office hours properties.
Outbound Caller ID Outbound caller ID to be used by the user.
Pbx Delivers Audio Whether PBX delivers audio directly (true/false).
Phones JSON array defining phone devices and their settings associated with the user.
Pin Protected Whether the user is pin protected (true/false).
Pin Protect Timeout Timeout duration for pin protection in seconds.
Primary Group Id Numeric ID of the user's primary group.
Prompt Set Name of the prompt set used for the user.
Queue Status User's queue status: Logged Out or Logged In.
Record Calls Whether calls are recorded (true/false).
Record Email Notify Whether to send email notifications for recordings (true/false).
Record External Calls Only Whether to record only external calls (true/false).
Require 2 FA Whether two-factor authentication is required (true/false).
Send Email Missed Calls Whether to send email notifications for missed calls (true/false).
SIPID SIP identifier for the user.
SRTP Mode Secure RTP mode: SRTP Disabled, Enabled, or Enforced.
Tags JSON array of tags associated with the user.
Transcription Mode Transcription mode: Nothing, Voicemail, Recordings, Both, or Inherit.
VM Disable Pin Auth Disable PIN authentication for voicemail (true/false).
VM Email Options Voicemail email options: None, Notification, Attachment, Attachment And Delete.
VM Enabled Enable voicemail (true/false).
VMPIN Voicemail PIN code.
VM Play Caller ID Play caller ID in voicemail (true/false).
VM Play Msg Date Time Voicemail message date/time playback: None, Play 12 Hr, Play 24 Hr.
Web Meeting Approve Participants Require approval for web meeting participants (true/false).
Web Meeting Friendly Name Friendly name for web meetings.

Output

The node outputs the response from the 3CX API after creating the user. The output is structured as JSON data representing the newly created user's details, including all the properties sent in the request along with any additional metadata or identifiers assigned by the system. This output can be used downstream in workflows to reference the created user or to confirm successful creation.

If the node supports binary data output (not indicated here), it would typically relate to files such as contact images or other media associated with the user, but no explicit binary output is described.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Requires an API key or OAuth2 token credential configured in n8n for authenticating requests to the 3CX API.
  • The base URL for the 3CX server must be configured in the credentials.
  • The node uses the 3CX REST API endpoint /xapi/v1 for operations.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 credentials are correctly configured and have sufficient permissions to create users.
  • Invalid JSON input: Properties like BreakTime, ForwardingExceptions, ForwardingProfiles, Greetings, Groups, Hours, OfficeHoursProps, and Phones expect valid JSON strings. Malformed JSON will cause errors.
  • Missing required fields: Some fields like DisplayName, Number, or EmailAddress might be required by the 3CX API. Omitting them may result in validation errors.
  • API endpoint issues: Verify that the base URL is correct and accessible from the n8n environment.
  • Data type mismatches: Boolean and numeric fields must be provided with correct types; otherwise, the API may reject the request.

Links and References

Discussion