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 create playlists within 3CX. It is useful in scenarios where automated or custom audio playlists need to be managed for telephony prompts, announcements, or call handling workflows. For example, a user might create a playlist of hold music files or prompt messages that can be played during calls.

Properties

Name Meaning
Auto Gain Whether to automatically adjust the gain (volume level) of the audio files in the playlist. Options: true or false.
Files A JSON array representing the list of audio files to include in the playlist.
Max Volume Percent The maximum volume percentage allowed for the playlist's audio playback.
Name The name of the playlist being created.
Prompt Name The name of the prompt associated with the playlist.
Repository Path The path in the repository where the playlist or its files are stored.
Shuffle Whether to shuffle the order of the files in the playlist when played. Options: true or false.

Output

The node outputs JSON data representing the result of the playlist creation operation. This typically includes details about the newly created playlist such as its ID, name, and other metadata returned by the 3CX API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API authentication token credential to connect securely to 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

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or malformed JSON in the "Files" property may lead to request errors.
    • Providing invalid paths or names could result in API rejections.
  • Error messages:
    • Authentication errors usually indicate problems with the API key or OAuth token.
    • Validation errors from the API may point to incorrect property values like empty names or invalid file lists.
  • Resolutions:
    • Verify that the API credentials are correctly set up and have necessary permissions.
    • Ensure the "Files" JSON is well-formed and matches expected structure.
    • Double-check all string inputs for correctness and completeness.

Links and References

Discussion