3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list playlists. It allows users to retrieve a collection of playlists from the 3CX system with various query options to control the output. This is useful in scenarios where you want to automate or integrate playlist management or reporting within your telephony workflows.

For example, you might use this node to:

  • Retrieve the first 10 playlists for display in a dashboard.
  • Search playlists by name or other criteria.
  • Filter playlists based on their state or other properties.
  • Sort playlists by creation date or name.
  • Include related entities or specific fields in the response.

Properties

Name Meaning
Options A collection of optional query parameters to customize the playlist listing:
$top Show only the first n items (limit the number of playlists returned).
$skip Skip the first n items (useful for pagination).
$search Search playlists by search phrases. If the phrase contains spaces and is not quoted, it will be automatically quoted.
$filter Filter playlists by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include the count of total items in the response (boolean).
$orderby Order playlists by specified property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (e.g., Id,Name).
$expand Expand related entities to include additional data linked to playlists.

Output

The node outputs JSON data representing the list of playlists retrieved from the 3CX API. The structure typically includes an array of playlist objects, each containing properties as requested via $select or default properties if none specified.

If $count is enabled, the output may also include metadata about the total number of playlists available.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to a 3CX telephony system API endpoint.
  • Needs an API authentication token configured via OAuth2 credentials.
  • The base URL for the 3CX API must be provided in the node credentials.
  • The node sends HTTP requests with appropriate headers (Accept: application/json) to the 3CX API.

Troubleshooting

  • Authentication errors: Ensure that the OAuth2 credentials are correctly set up and valid.
  • Invalid query parameters: Using incorrect syntax in $filter, $orderby, or other query options can cause API errors. Verify the syntax matches OData standards.
  • Empty results: Check if filters or search terms are too restrictive or if the 3CX system actually has playlists matching the criteria.
  • API connectivity issues: Confirm the server URL is correct and reachable from n8n.
  • Unexpected response format: If the API changes or returns errors, verify the API version and update the node configuration accordingly.

Links and References

Discussion