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 batch delete contacts. It is useful in scenarios where you need to remove multiple contacts from the 3CX contact list at once, such as cleaning up outdated or irrelevant contact entries in bulk.

A practical example would be a user who manages a large contact database within 3CX and wants to automate the removal of several contacts identified by their IDs, rather than deleting them one by one manually.

Properties

Name Meaning
Ids A JSON array containing the IDs of the contacts to be deleted in batch. The value should be a valid JSON string representing an array of contact IDs.

Output

The node outputs data in JSON format. The json output field will typically contain the response from the 3CX API after attempting to delete the specified contacts. This may include success confirmation or error details for each contact ID processed.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, which must be configured in the credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid JSON in Ids property: If the JSON array provided in the "Ids" property is malformed, the node will fail to parse it. Ensure the input is a valid JSON array of contact IDs.
  • Authentication errors: If the API key or OAuth2 token is missing or invalid, the node will not be able to connect to the 3CX API. Verify that the correct credentials are set up.
  • API endpoint issues: If the base URL for the 3CX server is incorrect or unreachable, the node will fail to send requests. Confirm the server URL is accurate and accessible.
  • Partial failures: When deleting multiple contacts, some deletions might succeed while others fail. Check the output JSON for detailed error messages per contact ID.

Links and References

Discussion