3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list Emergency Geo Locations. It is useful in scenarios where users need to retrieve and manage emergency location data associated with their telephony setup, such as for compliance, safety, or operational purposes.

For example, a user might want to fetch all configured emergency geo locations to verify their details or integrate this information into another system for monitoring or alerting.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of Emergency Geo Locations:
$top Show only the first n items
$skip Skip the first n items
$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 (e.g., State eq 'Connected')
$count Include count of items (boolean)
$orderby Order items by property values (e.g., Name desc, CreatedAt asc)
$select Select specific properties to be returned (e.g., Id,Name)
$expand Expand related entities (e.g., RelatedEntity1,RelatedEntity2)

Output

The node outputs JSON data representing the list of Emergency Geo Locations retrieved from the 3CX API. The structure corresponds to the queried properties and may include metadata such as counts if requested.

If binary data were involved, it would typically represent files or media, but this node focuses on JSON data about emergency locations.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be provided in the credentials configuration.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in options like $filter, $orderby, or $search can cause API errors. Validate these strings according to OData query conventions.
  • Empty results: If no emergency geo locations are returned, check if the filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL and that the URL is correctly formatted without trailing slashes.

Links and References

Discussion