3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to set an alternate pronunciation for a prompt set. This operation is useful in scenarios where you want to customize how certain prompts are pronounced within your telephony system, improving clarity or adapting to specific language requirements.

For example, if you have a prompt set that includes names or terms that are often mispronounced by default, you can use this node to specify an alternate pronunciation to ensure callers hear the correct version.

Properties

Name Meaning
Id The unique identifier of the prompt set entity to update. Supports expressions like {{$json.Id}}.
Alternate Pronunciation A boolean flag indicating whether to set an alternate pronunciation (true) or not (false).

Output

The node outputs JSON data representing the result of the API call to the 3CX system after setting the alternate pronunciation. The exact structure depends on the 3CX API response but typically includes confirmation of the update or details about the modified prompt set.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Invalid Id: If the provided Id does not correspond to an existing prompt set, the API will likely return an error. Ensure the Id is correct and accessible.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key or OAuth2 token is correctly configured.
  • Network Issues: Connectivity problems to the 3CX server will prevent the node from functioning. Check network access and server URL correctness.
  • Incorrect Property Types: Ensure the Alternate Pronunciation property is a boolean value; otherwise, the request may fail or behave unexpectedly.

Links and References

Discussion