3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing functionality to retrieve web meeting zones under the "Conference Settings" resource. The "Get Web Meeting Zones" operation fetches a list of available web meeting zones, which can be useful for managing or displaying conferencing options within an automation workflow.

Typical use cases include:

  • Automatically retrieving and displaying available web meeting zones for scheduling or reporting.
  • Filtering or searching through web meeting zones based on specific criteria.
  • Paginating results when dealing with large numbers of web meeting zones.

Properties

Name Meaning
Options A collection of optional query parameters to customize the request:
- Top ($top) Limits the number of items returned to the first n entries.
- Skip ($skip) Skips the first n items in the result set, useful for pagination.
- Search ($search) Searches items by phrases; supports automatic quoting if the phrase contains spaces.
- Filter ($filter) Filters items by property values using expressions (e.g., State eq 'Connected').
- Count ($count) Boolean flag to include the count of total items in the response.

Output

The node outputs JSON data representing the retrieved web meeting zones. Each item corresponds to a web meeting zone object as returned by the 3CX API. The exact structure depends on the API response but typically includes details such as zone identifiers, names, and status.

If the API supports it, the output may also include a count of total items when the $count option is enabled.

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 server, configured in the credentials.
  • The node sends 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 filter or search syntax may cause API errors. Verify expressions conform to the expected OData-like syntax.
  • Empty results: If no web meeting zones are returned, check if the filters or search terms are too restrictive.
  • Pagination issues: When using $top and $skip, ensure values are numeric strings and within valid ranges.

Links and References

Discussion