3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to batch delete users. It allows users to remove multiple user records from the 3CX system in a single request by specifying their IDs. This is useful for administrators who need to clean up or manage user accounts efficiently without deleting them one by one.

A practical example would be when an organization wants to deactivate or remove several employees' phone extensions at once after they leave the company.

Properties

Name Meaning
Ids A JSON array of user IDs to be deleted in batch. The value should be a JSON string representing an array of IDs, e.g., ["id1", "id2", "id3"].

Output

The output contains a JSON field that reflects the response from the 3CX API after attempting to delete the specified users. It typically includes information about the success or failure of the batch deletion operation. No binary data output is expected.

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 IDs: If the provided IDs are not valid or the JSON array is malformed, the API may return an error. Ensure the input is a properly formatted JSON array of valid user IDs.
  • Authentication errors: If the API key or OAuth token is invalid or expired, the node will fail to authenticate. Verify the credentials and refresh tokens if necessary.
  • Server URL issues: The base URL must be correctly set without trailing slashes; otherwise, requests might fail. Check the credential configuration.
  • API rate limits or permissions: If the user associated with the API key lacks permission to delete users or if rate limits are exceeded, errors will occur. Confirm appropriate permissions and usage limits.

Links and References

Discussion