3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to list call forwarding rules associated with a receptionist entity. The "List Forwards" operation under the "Receptionists" resource retrieves forwarding configurations for a given receptionist ID. This is useful in scenarios where you want to programmatically access or audit call forwarding settings, automate updates, or integrate call routing data into other workflows.

Practical examples include:

  • Fetching all forwarding rules for a receptionist to display in a dashboard.
  • Automating checks on forwarding configurations before applying changes.
  • Integrating forwarding data with CRM or helpdesk systems to enhance call handling.

Properties

Name Meaning
Id The unique identifier of the receptionist entity whose forwarding rules are to be listed.
Options A collection of optional query parameters to refine the listing:
- Top: Show only the first n items
- Skip: Skip the first n items
- Search: Search items by search phrases
- Filter: Filter items by property values (e.g., "State eq 'Connected'")
- Count: Include count of items (boolean)
- Orderby: Order items by property values (e.g., "Name desc, CreatedAt asc")
- Select: Select specific properties to be returned (e.g., "Id,Name")
- Expand: Expand related entities (e.g., "RelatedEntity1,RelatedEntity2")

Output

The node outputs JSON data representing the list of forwarding rules for the specified receptionist. Each item in the output array corresponds to a forwarding rule with its properties as returned by the 3CX API. The exact structure depends on the API response but typically includes details such as forwarding destinations, conditions, and status.

If binary data were involved (e.g., recordings), it would be indicated here, but this operation deals solely with JSON data.

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 credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing receptionist Id: Ensure the Id property is provided and corresponds to a valid receptionist entity in 3CX.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network or connectivity issues: Confirm that the 3CX server URL is reachable from the n8n instance.
  • Malformed query options: When using filter, search, or orderby options, ensure syntax matches 3CX API expectations to avoid errors.
  • Empty results: Could indicate no forwarding rules exist for the given receptionist or filters exclude all entries.

Links and References

Discussion