3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing an operation to list email templates. This operation fetches a collection of email templates from the 3CX system, allowing users to retrieve and manage these templates within their workflows.

Common scenarios where this node is beneficial include:

  • Automating the retrieval of available email templates for use in communication workflows.
  • Filtering and searching email templates based on specific criteria to dynamically select templates.
  • Integrating 3CX email templates into broader customer engagement or notification processes.

For example, a user might want to list all email templates that contain a certain keyword in their name or description, or retrieve only the first 10 templates ordered by creation date.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of email templates:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not already quoted, it will be automatically quoted.
$filter Filter items by property values using expressions (e.g., State eq 'Connected').
$count Include the count of items in the response (boolean).
$orderby Order items 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 the email templates.

Output

The output consists of JSON data representing the list of email templates retrieved from the 3CX system. Each item in the output array corresponds to an email template object with properties as requested via the $select option or default properties if none are specified.

If the $count option is enabled, the output may also include metadata about the total number of items matching the query.

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token provided in credentials is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other options can cause API errors. Verify the query expressions conform to 3CX API specifications.
  • Empty results: If no templates are returned, check the filter and search criteria; also verify that email templates exist in the 3CX system.
  • Network issues: Confirm that the server URL is correct and accessible from the n8n environment.

Links and References

  • 3CX API documentation (for details on query parameters and email template resource): [User should refer to official 3CX API docs]

Discussion