3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation "Ge Crmt Templates" under the "Crm Templates" resource is designed to retrieve CRM template records from a 3CX telephony system via its API. It allows users to query and fetch CRM templates with various filtering, searching, sorting, and pagination options. This is useful in scenarios where you want to integrate or synchronize CRM templates from 3CX into your workflows, for example, to display available templates, automate template selection, or analyze CRM data.

Practical examples:

  • Fetch the top 10 CRM templates to show in a dashboard.
  • Search CRM templates by name or description using search phrases.
  • Retrieve CRM templates filtered by specific properties such as state or category.
  • Get CRM templates ordered by creation date or name.
  • Expand related entities linked to each CRM template for richer data.

Properties

Name Meaning
Options A collection of optional query parameters to customize the retrieval of CRM templates:
$top Show only the first n items (pagination limit).
$skip Skip the first n items (pagination offset).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be auto-quoted.
$filter Filter items by property values, e.g., State eq 'Connected'.
$count Include count of items in the response (boolean).
$select Select specific properties to be returned, e.g., Id,Name.
$orderby Order items by property values, e.g., Name desc, CreatedAt asc.
$expand Expand related entities to include additional linked data, e.g., RelatedEntity1,RelatedEntity2.

Output

The node outputs JSON data representing the list of CRM templates retrieved from the 3CX API. The structure typically includes an array of CRM template objects with their properties as requested by the $select parameter or all properties if none 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 connection to a 3CX telephony system API.
  • Needs an API authentication token credential configured in n8n (OAuth2 or similar).
  • The base URL for the 3CX API must be set in the node credentials.
  • The node sends HTTP requests with appropriate headers (Accept: application/json) to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials leading to authentication errors.
    • Invalid query parameters causing API request failures.
    • Network connectivity problems preventing access to the 3CX server.
    • Misformatted filter or search strings resulting in no data or errors.

  • Error messages:

    • Authentication errors: Check that the API key or OAuth2 token is valid and properly configured.
    • 400 Bad Request: Verify the syntax of $filter, $search, $orderby, and other query parameters.
    • 404 Not Found: Confirm the base URL and resource path are correct.
    • Timeout or network errors: Ensure the 3CX server is reachable from the n8n instance.

Links and References

Discussion