3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing functionality to retrieve files associated with a Call Flow App entity. The "Get Files" operation fetches files related to a given Call Flow App identified by its ID. This is useful in scenarios where users need to programmatically access media or configuration files linked to call flows, such as retrieving audio prompts, scripts, or other resources managed within 3CX.

Practical examples include:

  • Automatically downloading call flow audio files for backup or processing.
  • Integrating 3CX call flow assets into external systems or workflows.
  • Filtering and searching files related to specific call flow apps based on metadata.

Properties

Name Meaning
Id The unique identifier of the Call Flow App entity whose files you want to retrieve.
Options Additional query parameters to control the file retrieval:
- Top ($top) Limits the number of returned items to the first n entries.
- Skip ($skip) Skips the first n items in the result set, useful for pagination.
- Search ($search) Searches files by phrases; supports quoted phrases for exact matches.
- Filter ($filter) Filters files by property values, e.g., filtering by state or other attributes.
- Count ($count) Boolean flag to include the total count of items in the response.

Output

The node outputs JSON data representing the list of files retrieved for the specified Call Flow App. Each item in the output typically contains metadata about a file, such as its name, type, size, and possibly URLs or identifiers to access the file content.

If binary data is included (not explicitly shown in the provided code), it would represent the actual file contents, allowing downstream nodes to process or save the files.

Dependencies

  • Requires an API key credential for authenticating with the 3CX system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers.

Troubleshooting

  • Invalid or missing Id: Ensure the "Id" property is correctly set and corresponds to an existing Call Flow App entity.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network issues: Confirm that the 3CX server URL is reachable from the n8n instance.
  • Query parameter misuse: Incorrect filter or search syntax may cause API errors; use proper OData-like syntax for filters.
  • Empty results: Could indicate no files exist for the given Id or filters are too restrictive.

Links and References

Discussion