3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve Music On Hold settings. It is useful for scenarios where you need to programmatically access or manage the music played to callers when they are placed on hold in a 3CX phone system. For example, you might use this node to fetch current music on hold configurations to audit them, display them in a dashboard, or integrate with other systems that manage telephony settings.

Properties

Name Meaning
Options A collection of query parameters to customize the retrieval of Music On Hold settings:
- $top Show only the first n items
- $skip Skip the first n items
- $search Search items by search phrases
- $filter Filter items by property values (e.g., "State eq 'Connected'")
- $count Include count of items (boolean)
- $orderby Order items by property values (e.g., "Name desc, CreatedAt asc")
- $select Select specific properties to be returned (e.g., "Id,Name")
- $expand Expand related entities (e.g., "RelatedEntity1,RelatedEntity2")

These options allow fine-grained control over which Music On Hold settings are retrieved and how the data is filtered, sorted, and shaped.

Output

The node outputs JSON data representing the Music On Hold settings retrieved from the 3CX system. The structure of the JSON depends on the selected $select and $expand options but generally includes details about each Music On Hold configuration such as identifiers, names, and related entities.

If binary data were involved (e.g., audio files), it would be indicated here, but based on the provided code and properties, the output is purely JSON.

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 HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed $filter or $orderby) may result in API errors.
    • Network connectivity problems to the 3CX server can cause request timeouts or failures.

  • Error messages:

    • Authentication errors typically indicate invalid or expired credentials; verify and update your API key/token.
    • Bad request errors suggest incorrect query syntax; review the OData query options used.
    • Connection errors imply network or server availability issues; check server URL and network status.

Links and References

Discussion