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 parking groups within the "Parkings" resource. The "List Parking Groups" operation retrieves a collection of parking group entities associated with a given entity ID. This is useful in scenarios where you need to manage or monitor call parking groups in 3CX, such as fetching available parking groups for call routing or reporting purposes.

Practical examples include:

  • Fetching all parking groups linked to a specific entity to display them in a dashboard.
  • Filtering parking groups based on certain criteria like name or status.
  • Paginating through large sets of parking groups using top and skip options.

Properties

Name Meaning
Id Entity ID to specify which entity's parking groups to list. Can be set dynamically via expressions.
Options Collection of optional query parameters to refine the list:
- Top ($top) Show only the first n items (pagination).
- Skip ($skip) Skip the first n items (pagination offset).
- Search ($search) Search items by search phrases; supports phrase quoting automatically if needed.
- Filter ($filter) Filter items by property values, e.g., filtering by state or other attributes.
- Count ($count) Include count of total items in the response (boolean).
- Orderby ($orderby) Order items by specified property values, e.g., "Name desc, CreatedAt asc".
- Select ($select) Select specific properties to be returned, e.g., "Id,Name".
- Expand ($expand) Expand related entities to include additional data, e.g., related entities.

Output

The node outputs JSON data representing the list of parking groups retrieved from the 3CX API. Each item in the output corresponds to a parking group entity with its properties as returned by the API, potentially filtered or shaped according to the input options.

If binary data were involved (not indicated here), it would typically represent files or media, but this node focuses on JSON data about parking groups.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node uses HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Invalid Entity ID: If the provided Id does not correspond to a valid entity, the API may return an error or empty results. Verify the correctness of the ID.
  • Authentication Errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Query Parameter Issues: Incorrectly formatted filter, search, or orderby strings can cause API errors. Use correct OData syntax and verify expressions.
  • Empty Results: May occur if filters are too restrictive or no parking groups exist for the given entity.
  • Network/Server Errors: Check connectivity to the 3CX server and ensure the base URL is correct.

Links and References

Discussion