3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing an operation to "Reprovision All Phones" for users. The reprovisioning process typically forces all phones associated with specified users to refresh their configuration or firmware, which can be useful after changes in user settings, phone configurations, or system updates.

Common scenarios where this node is beneficial include:

  • After updating user permissions or extensions, ensuring all phones reflect the latest settings.
  • When troubleshooting phone registration issues by forcing a reprovision.
  • Automating maintenance tasks that require phones to reload their configuration.

For example, an administrator could use this node to reprovision all phones of selected users after a bulk update to their voicemail settings.

Properties

Name Meaning
Ids A JSON array containing the IDs of the users whose phones should be reprovisioned. Example: [123, 456]. This property expects a JSON string that will be parsed and sent in the request body.

Output

The node outputs data in the json field representing the response from the 3CX API after attempting to reprovision the phones. This typically includes status information about the reprovisioning request, such as success confirmation or error details.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential to connect securely to the 3CX server.
  • 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 User IDs: If the provided user IDs are incorrect or do not exist, the API may return errors or no action will be taken. Verify that the IDs are valid and correspond to existing users.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key or OAuth2 token is correctly configured.
  • Server URL Issues: An incorrect or malformed server URL in credentials can lead to connection errors. Confirm the URL is correct and accessible.
  • JSON Parsing Errors: The Ids property expects a valid JSON string. Malformed JSON will cause parsing errors before sending the request.

Links and References

Discussion