3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve emergency outbound rules when using the "Get Emergency Outbound Rules" operation under the "Outbound Rules" resource. It is useful for scenarios where users need to programmatically access and manage emergency call routing configurations within their 3CX environment. For example, a user might want to fetch these rules to audit or synchronize them with another system.

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.
- Search ($search) Searches items by phrases; supports automatic quoting if the phrase contains spaces.
- Filter ($filter) Filters items based on property values (e.g., State eq 'Connected').
- Count ($count) Includes the count of items in the response when set to true.
- Select ($select) Specifies which properties to return (e.g., Id,Name).
- Orderby ($orderby) Orders items by specified property values (e.g., Name desc, CreatedAt asc).
- Expand ($expand) Expands related entities in the response (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the emergency outbound rules retrieved from the 3CX system. The structure corresponds to the properties selected or returned by default from the API, typically including details such as rule identifiers, names, states, and related configuration data.

If binary data were involved, it would be summarized here, but this operation deals solely with JSON data.

Dependencies

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

Troubleshooting

  • Common issues:

    • Incorrect or missing API authentication token can cause authorization errors.
    • Invalid filter or query syntax may lead to API errors or empty results.
    • Network connectivity problems to the 3CX server will prevent data retrieval.

  • Error messages:

    • Authorization failures usually indicate invalid or expired credentials; re-authenticate or update the API key.
    • Query parameter errors suggest malformed $filter, $search, or other options; verify syntax against 3CX API documentation.
    • Timeout or connection errors require checking network access and server availability.

Links and References

Discussion