3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing functionality to bulk update user records. It allows users to modify multiple user entries in one operation by specifying their IDs and the new user data to apply. This is useful in scenarios such as updating contact details, forwarding rules, or group memberships for many users simultaneously, saving time compared to updating each user individually.

Practical examples include:

  • Changing office hours or break times for a set of employees.
  • Updating call forwarding profiles or greetings for multiple users at once.
  • Modifying group rights or tags across several user accounts in bulk.

Properties

Name Meaning
Ids A JSON array containing the IDs of the users to be updated. Each ID identifies a user record that will be modified.
User A JSON object representing the user data to update. This includes detailed nested properties such as BreakTime periods, ForwardingExceptions, ForwardingProfiles, Greetings, Groups (with rights and tags), Hours, OfficeHoursProps, Phones (with settings like codecs and VLAN info), Tags, and TranscriptionMode. The structure supports complex user configurations for bulk updates.

Output

The node outputs JSON data reflecting the result of the bulk update operation. Typically, this would include confirmation of which user records were successfully updated and any relevant response data from the 3CX API. The output does not explicitly mention binary data, so it is assumed to be purely JSON.

Dependencies

  • Requires an active connection to a 3CX telephony system via its API.
  • Needs an OAuth2 API credential configured in n8n for authentication.
  • The base URL for the 3CX server must be provided in the credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX API.

Troubleshooting

  • Invalid User IDs: If the IDs array contains invalid or non-existent user IDs, the API may return errors or fail to update those users. Verify that all IDs are correct.
  • Malformed User Data: The user JSON must conform to the expected schema. Incorrectly structured JSON or missing required fields can cause the API to reject the request.
  • Authentication Errors: Ensure the OAuth2 credentials are valid and have sufficient permissions to perform bulk updates.
  • API Endpoint Issues: Confirm the base URL is correctly set without trailing slashes and points to a reachable 3CX server.
  • Large Payloads: Bulk updates with very large user data might hit API limits or timeouts; consider splitting into smaller batches if needed.

Links and References

Discussion