3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node provides an operation to retrieve CRM integration data from the 3CX telephony system via its API. It allows users to query and fetch CRM integration records with flexible filtering, searching, ordering, and selection of fields. This is useful for scenarios where you want to synchronize or analyze CRM integration details within your workflows, such as listing connected CRM systems, checking their status, or extracting specific CRM-related metadata.

Practical examples:

  • Fetch the first 10 CRM integrations currently connected.
  • Search CRM integrations by name or other searchable fields.
  • Retrieve only selected properties like Id and Name for display or further processing.
  • Expand related entities to get detailed linked information in one request.

Properties

Name Meaning
$top Show only the first n items (limit the number of results returned).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be wrapped in quotes automatically.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of items in the response (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (comma-separated list, e.g., Id,Name).
$expand Expand related entities to include additional linked data (comma-separated list).

These options are provided inside a collection named "Options" under the resource "crmIntegration" and operation "getCrmIntegration".

Output

The output JSON field contains an array of CRM integration objects matching the query parameters. Each object includes the properties requested via $select or all properties if none specified. If $expand is used, related entities are included as nested objects.

If $count is true, the response also includes the total count of matching items.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system's API.
  • The base URL for the API is configured dynamically based on the credential's server URL.
  • The node sends HTTP requests with Accept: application/json header to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing API credentials: Ensure that the API key or OAuth2 token for 3CX is correctly configured and valid.
  • Incorrect base URL: Verify that the server URL in credentials does not have trailing slashes or is properly formatted.
  • Malformed OData queries: Errors may occur if $filter, $orderby, or $search strings are not correctly formed according to OData syntax.
  • Empty or no results: Check if filters or search terms are too restrictive or incorrect.
  • API rate limits or connectivity issues: Network problems or API throttling can cause failures; verify network access and API usage limits.

Links and References

Discussion