3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to list contacts stored within it. It is useful for retrieving contact information in bulk or filtered forms, enabling workflows that require access to phonebook data such as automated calling, CRM synchronization, or contact management.

For example, you can use this node to:

  • Retrieve the first 10 contacts for a quick overview.
  • Search contacts by name or other attributes.
  • Filter contacts based on specific criteria like state or tags.
  • Sort contacts by creation date or name.
  • Select only certain fields to reduce data size.
  • Expand related entities to get more detailed information linked to each contact.

Properties

Name Meaning
Top Show only the first n items (limit the number of contacts returned).
Skip Skip the first n items (useful for pagination).
Search Search contacts by search phrases. If the phrase contains spaces and is not quoted, it will be automatically quoted.
Filter Filter contacts by property values using OData filter syntax (e.g., State eq 'Connected').
Count Include the count of total matching items in the response (boolean).
Orderby Order contacts by specified property values (e.g., Name desc, CreatedAt asc).
Select Select which properties of the contacts to return (e.g., Id,Name).
Expand Expand related entities to include additional linked data (e.g., related entities).

Output

The node outputs JSON data representing the list of contacts retrieved from the 3CX system. Each item in the output array corresponds to a contact object containing the requested properties.

If the "Count" option is enabled, the output may also include metadata about the total number of contacts matching the query.

No binary data output is produced by this node.

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 requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid filter or query syntax: The $filter, $search, $orderby, and other query parameters must follow OData conventions supported by 3CX. Incorrect syntax will cause request failures.
  • Empty results: Check if the filter or search criteria are too restrictive or if there are no contacts matching them.
  • Pagination issues: When using $top and $skip, ensure values are numeric strings and correctly set to paginate through results.
  • Server URL misconfiguration: The base URL must be correct and should not end with a trailing slash; the node trims it automatically if present.

Links and References

Discussion