3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve onboard meeting information under the "Conference Settings" resource. The "Get Onboard Meetings" operation fetches a list of onboard meetings configured in the 3CX system. This is useful for scenarios where users want to automate the retrieval and processing of conference or meeting data from their telephony system, such as integrating meeting schedules into other workflows, monitoring active conferences, or generating reports.

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 quoted phrases for exact matches.
- Filter ($filter) Filters items based on property values using OData-like syntax (e.g., State eq 'Connected').
- Count ($count) Boolean flag to include the total count of items in the response.

Output

The node outputs JSON data representing the onboard meetings retrieved from the 3CX system. Each item in the output corresponds to an onboard meeting with its associated properties as provided by the 3CX API. The structure typically includes details such as meeting identifiers, status, participants, and other relevant metadata.

If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON data output.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers (Accept: application/json).

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed filter expressions) may result in API errors.
    • Network connectivity issues can prevent successful API calls.

  • Error Messages:

    • Authentication errors typically indicate invalid or expired credentials; verify and update the API key.
    • Query parameter errors suggest checking the syntax of filters, search phrases, and numeric inputs.
    • Timeout or connection errors require checking network access to the 3CX server URL.

Links and References

Discussion