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 make a call that plays a user-recorded greeting. It is useful in scenarios where automated calls need to be made to users or contacts, and a personalized or pre-recorded message should be played during the call. For example, it can be used in customer support workflows to deliver announcements or reminders via phone calls.

Properties

Name Meaning
Id The unique identifier of the user entity to whom the call will be made. Can be set dynamically using expressions like {{$json.Id}}. This is a required numeric field.
Dn The destination number (phone number) to which the call will be placed.
Filename The name of the audio file containing the recorded greeting to be played during the call.

Output

The node outputs data in JSON format representing the result of the call operation. This typically includes details about the call status, any errors, or confirmation of the greeting being played. If the node supports binary data output (e.g., audio files), it would represent the content of the recorded greeting or call recording, but this is not explicitly shown in the provided code.

Dependencies

  • Requires an API authentication token credential for the 3CX system.
  • Needs the base URL of the 3CX server configured in the credentials.
  • The node uses the 3CX REST API endpoint /xapi/v1 to perform operations.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Invalid or missing user Id may cause the call to fail.
    • Incorrect or unreachable destination number (Dn) can prevent the call from connecting.
    • Missing or incorrect filename for the greeting audio will result in no greeting being played.
    • Authentication failures due to invalid or expired API tokens.
    • Network connectivity issues with the 3CX server.

  • Error messages:

    • Errors related to authorization usually indicate problems with the API key or OAuth2 token; verify credentials.
    • "Entity not found" or similar errors suggest the provided user Id does not exist.
    • "Invalid phone number" indicates the Dn property is malformed or unsupported.

Resolving these generally involves verifying input properties, ensuring valid credentials, and confirming network access to the 3CX server.

Links and References

Discussion