3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to retrieve details about a single outbound rule by its unique identifier. It is useful in scenarios where you need to fetch configuration or status information about specific outbound call routing rules within 3CX, for example, to audit call routing setups or dynamically adjust workflows based on outbound rule properties.

Properties

Name Meaning
Id The unique identifier of the outbound rule to retrieve. Can be set directly or via expression.
Options Additional query options to customize the returned data:
- $select Comma-separated list of properties to return (e.g., "Id,Name").
- $expand Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the requested outbound rule entity from the 3CX system. The structure depends on the selected properties and expansions specified in the options. The output includes all standard fields of an outbound rule such as its ID, name, and any expanded related entities if requested.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Invalid or missing Id: If the Id property is not provided or invalid, the node will fail to retrieve the outbound rule. Ensure the Id is correct and passed properly.
  • Authentication errors: Incorrect or expired API credentials will cause authentication failures. Verify that the API key/token and server URL are correctly configured.
  • Network issues: Connectivity problems to the 3CX server will result in request timeouts or errors. Check network access and server availability.
  • Incorrect $select or $expand values: Specifying invalid property names or related entities may cause the API to reject the request or return incomplete data. Use valid property names as per 3CX API documentation.

Links and References

Discussion