3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system to list receptionists. It allows users to retrieve a filtered, sorted, and paginated list of receptionist entities from the 3CX API. This is useful in scenarios where you want to automate or analyze receptionist data, such as generating reports, syncing receptionist information with other systems, or managing telephony resources programmatically.

For example, you could use this node to:

  • Fetch the first 10 receptionists currently registered.
  • Search for receptionists by name or other attributes.
  • Retrieve only specific properties of receptionists to optimize data usage.
  • Sort receptionists by creation date or name.

Properties

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

Output

The node outputs JSON data representing the list of receptionists retrieved from the 3CX API. The structure typically includes an array of receptionist objects with properties depending on the $select parameter or default API response fields.

If the $count option is enabled, the output may also include metadata about the total number of receptionists 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 a base URL for the 3CX API server configured in the credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX API.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token provided in credentials is valid and has sufficient permissions.
  • Invalid query parameters: Using incorrect OData syntax in $filter, $orderby, or other options can cause API errors. Validate your queries against 3CX API documentation.
  • Empty results: Check if filters or search terms are too restrictive or if pagination skips all available items.
  • Network issues: Verify connectivity to the 3CX server URL and that the URL is correctly set without trailing slashes.
  • Unexpected response format: Confirm that the 3CX API version matches the expected /xapi/v1 endpoint and that no breaking changes have occurred.

Links and References

Discussion