3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node integrates with the 3CX telephony system, specifically allowing users to record prompts within prompt sets. This operation is useful for automating the management of voice prompts in a 3CX environment, such as updating or adding new recorded messages for extensions or other telephony features.

Typical use cases include:

  • Automatically recording or updating voice prompts for specific extensions.
  • Managing prompt sets programmatically as part of a larger telephony workflow.
  • Integrating with external systems to dynamically update call handling messages.

Properties

Name Meaning
Id The entity ID of the prompt set to which the prompt belongs. Can be provided via expression (e.g., {{$json.Id}}). Required.
Extension The extension number associated with the prompt (e.g., 101, 102, 999).
Prompt Id The identifier of the specific prompt to record within the prompt set.

Output

The node outputs JSON data representing the result of the record prompt operation. This typically includes confirmation details about the recorded prompt, such as its ID, status, or any metadata returned by the 3CX API.

If the node supports binary data output (e.g., audio files), it would represent the recorded prompt's audio content; however, based on the provided code and properties, the primary output is JSON data related to the prompt recording action.

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 Id: Ensure the "Id" property is correctly set and corresponds to an existing prompt set entity.
  • Authentication errors: Verify that the API key credential and server URL are correctly configured.
  • Extension or Prompt Id issues: Confirm that the extension number and prompt ID are valid and exist in the 3CX system.
  • Network or API errors: Check connectivity to the 3CX server and ensure the API endpoint is accessible.

Common error messages will likely relate to authentication failures, invalid parameters, or network timeouts. Resolving these involves verifying credentials, input values, and network settings.

Links and References

Discussion