3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to update playlists within 3CX. The "Update Playlist" operation lets you modify various attributes of an existing playlist such as its name, audio files, volume settings, and playback options like shuffle and auto gain.

Common scenarios for this node include:

  • Automating updates to call queue or IVR playlists based on dynamic data.
  • Managing audio prompts or music on hold by programmatically changing playlist contents.
  • Adjusting playback parameters (e.g., volume, shuffle) to optimize caller experience without manual intervention.

For example, you could use this node in a workflow that updates a playlist's audio files daily from a repository or changes the prompt name based on campaign needs.

Properties

Name Meaning
Name The unique identifier (entity key) of the playlist to update. Supports expressions.
Auto Gain Boolean flag to enable or disable automatic gain control on the playlist's audio files.
Files JSON array representing the list of audio files included in the playlist.
Max Volume Percent Numeric value specifying the maximum volume level as a percentage for playback.
Prompt Name Name of the prompt associated with the playlist.
Repository Path File path in the repository where playlist files are stored or referenced.
Shuffle Boolean flag indicating whether the playlist should play files in random order (shuffle mode).

Output

The node outputs JSON data representing the updated playlist object returned by the 3CX API after the update operation. This typically includes all playlist properties reflecting the new state post-update.

If the node supports binary data output (not indicated here), it would represent audio files or related media content, but this is not evident from the provided code.

Dependencies

  • Requires an active connection to a 3CX telephony system via an API endpoint.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be set correctly in the node credentials.
  • The node uses HTTP requests with JSON payloads to interact with the 3CX API.

Troubleshooting

  • Invalid Playlist Name: If the specified playlist name does not exist, the API may return a "not found" error. Verify the playlist name is correct and exists in 3CX.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the OAuth2 or API key credentials are properly configured.
  • Malformed JSON in Files Property: The Files property expects valid JSON. Incorrect formatting can cause parsing errors. Use proper JSON syntax when providing file lists.
  • API Endpoint Issues: Incorrect server URL or network connectivity problems can prevent successful API calls. Confirm the base URL and network access.
  • Volume Percent Out of Range: Providing a max volume percent outside acceptable bounds (usually 0-100) might cause errors. Validate input values.

Links and References

Discussion