3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing users to update existing Prompt Sets. A Prompt Set in 3CX typically contains audio prompts used for IVR menus, announcements, or other telephony interactions. This operation is useful when you want to modify the details or contents of a Prompt Set programmatically within an n8n workflow.

Common scenarios include:

  • Updating prompt metadata such as name, description, or language.
  • Changing the folder location or versioning information.
  • Modifying the actual prompts (audio or text) contained within the set.
  • Adjusting settings like alternate number pronunciation.

Practical example: Automatically updating a Prompt Set’s description and prompts after a content review process, ensuring the telephony system always uses the latest approved messages.

Properties

Name Meaning
Id The unique identifier of the Prompt Set to update. Can be provided via expression (e.g., {{$json.Id}}).
Culture Code The culture code associated with the Prompt Set (e.g., "en-US").
Description A textual description of the Prompt Set.
Folder The folder path or name where the Prompt Set is stored.
Language Code The language code for the Prompt Set (e.g., "en").
Prompts JSON array representing the individual prompts within the set. Each prompt can contain its own properties.
Prompt Set Name The display name of the Prompt Set.
Prompt Set Type The type of the Prompt Set; options are "System" or "Custom".
Use Alternate Number Pronunciation Boolean flag indicating whether to use alternate number pronunciation rules.
Version Version string for the Prompt Set, useful for tracking changes.

Output

The node outputs JSON data representing the updated Prompt Set entity as returned by the 3CX API. This typically includes all the fields sent in the update request along with any additional metadata or status information provided by the server.

If the node supports binary data output (not indicated here), it would generally relate to audio files for prompts, but this operation focuses on updating metadata and prompt definitions rather than transferring binary content.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be correctly set in the credentials configuration.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing Id: The update operation requires a valid Prompt Set ID. Ensure the Id property is correctly set and corresponds to an existing Prompt Set.
  • Authentication errors: If the API key or OAuth2 token is invalid or expired, the node will fail. Re-authenticate or refresh credentials.
  • Malformed JSON in Prompts: The Prompts property expects valid JSON. Invalid JSON syntax will cause errors. Validate JSON before input.
  • API endpoint issues: Incorrect base URL or network connectivity problems can prevent communication with the 3CX server.
  • Permission denied: The authenticated user must have rights to update Prompt Sets. Check user permissions in 3CX.

Links and References

This summary is based solely on static analysis of the provided source and property definitions without runtime execution.

Discussion