3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing an operation to retrieve phone registrars associated with users. It is useful in scenarios where you need to programmatically access and manage telephony user data within 3CX, such as fetching device registrations for monitoring or administrative purposes.

For example, a practical use case would be to get the list of MAC addresses registered as phone devices for certain users, enabling automated audits or synchronization with other systems.

Properties

Name Meaning
Macs A JSON array specifying MAC addresses of devices to query. This input allows filtering the request to only include specified MAC addresses. The value should be a JSON-formatted string representing an array of MAC addresses (or null).

Output

The node outputs JSON data containing information about the phone registrars retrieved from the 3CX system. Each item in the output corresponds to a phone registrar record, typically including details such as MAC address, registration status, and associated user information.

If binary data were involved (e.g., files or media), it would be indicated here, but this node focuses on JSON data related to telephony registrations.

Dependencies

  • Requires an API key credential for authenticating with the 3CX server.
  • Needs the base URL of the 3CX server configured in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing API credentials: Ensure that the API key and server URL are correctly set up in the node's credentials.
  • Malformed JSON in "Macs" property: The "Macs" input expects a valid JSON array string. Invalid JSON will cause errors; validate the input format before execution.
  • Network connectivity issues: Verify that the n8n instance can reach the 3CX server URL.
  • Empty or no results returned: Confirm that the provided MAC addresses exist and are registered in the 3CX system.

Links and References

Discussion