3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to delete a company entry by its phone number within the "Groups" resource. It is useful in scenarios where an organization needs to manage and clean up their contact groups or company listings programmatically, for example, removing outdated or incorrect company entries based on their phone numbers.

A practical example would be automating the removal of companies that have been deactivated or merged, ensuring the telephony system's group data remains accurate without manual intervention.

Properties

Name Meaning
Number Phone number in international format (e.g., +1234567890). This identifies the company to delete.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of deletion or error details if the operation failed. The exact structure depends on the 3CX API response but generally confirms whether the specified company was successfully deleted.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Invalid or missing phone number: Ensure the phone number is provided in the correct international format (e.g., +1234567890).
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network or server errors: Check connectivity to the 3CX server URL and ensure the server is reachable.
  • Company not found: If the phone number does not correspond to any company, the API may return an error or empty response; verify the number exists before attempting deletion.

Links and References

Discussion