3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to retrieve details about a playlist entity within 3CX. The "Get Playlist" operation fetches information about a specific playlist identified by its name. This is useful in scenarios where you want to programmatically access playlist configurations or details for reporting, monitoring, or integration purposes.

For example, you might use this node to:

  • Retrieve a playlist's properties before updating or analyzing it.
  • Fetch related entities of a playlist by expanding them in the query.
  • Select only specific fields of the playlist to optimize data transfer.

Properties

Name Meaning
Name The unique identifier (entity key) of the playlist to retrieve. Supports expressions.
Options Additional query options:
- $select Comma-separated list of playlist properties to return (e.g., Id,Name).
- $expand Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the requested playlist entity. The structure corresponds to the playlist's properties as returned by the 3CX API. If $select is used, only those selected properties will be present. If $expand is specified, related entities will be included as nested objects.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for 3CX OAuth2.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Invalid or missing playlist name will cause the API to return an error.
    • Incorrect or expired API credentials will result in authentication failures.
    • Improperly formatted $select or $expand parameters may lead to API errors or incomplete data.

  • Error messages:

    • Authentication errors: Check that the API key/token is valid and has necessary permissions.
    • Not found errors: Verify the playlist name exists in the 3CX system.
    • Bad request errors: Ensure query options are correctly formatted.

Links and References

  • 3CX API documentation (refer to the official 3CX developer resources for detailed API specs)
  • n8n documentation on using OAuth2 credentials and HTTP request nodes for custom integrations

Discussion