3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node is designed to interact with the "Sbcs" resource, specifically to retrieve a single SBC (Session Border Controller) entity by its unique key called "Name". This operation is useful when you need to fetch detailed information about a specific SBC in your telephony or communication system.

Common scenarios include:

  • Retrieving configuration details of a particular SBC for monitoring or auditing.
  • Fetching SBC data to use in subsequent workflow steps, such as updating or reporting.
  • Integrating with external systems that require SBC information based on its identifier.

For example, if you have an SBC named "SBC123", you can use this node to get all its properties or selectively retrieve certain fields and related entities.

Properties

Name Meaning
Name The unique key (Name) identifying the SBC entity to retrieve. Supports expressions.
Options Collection of optional query parameters:
- $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 output contains a JSON object representing the requested SBC entity. The structure includes all or selected properties of the SBC, depending on the $select option used. If $expand is specified, related entities are included as nested objects within the JSON.

No binary data output is indicated for this node.

Example output snippet:

{
  "Id": "123",
  "Name": "SBC123",
  "Status": "Active",
  "RelatedEntity1": { ... },
  "RelatedEntity2": { ... }
}

Dependencies

  • Requires an API authentication token or API key credential configured in n8n to authorize requests.
  • Depends on the external service's REST API endpoint that manages SBC entities.
  • The base URL and headers are set via credentials and node defaults.

Troubleshooting

  • Missing or incorrect "Name" property: The node requires the exact key of the SBC to retrieve it. Ensure the "Name" field is correctly set and matches an existing entity.
  • API authentication errors: Verify that the API credentials are valid and have sufficient permissions to access SBC data.
  • Invalid $select or $expand values: Using incorrect property names or related entities may cause errors or empty responses. Confirm these values against the API documentation.
  • Network or connectivity issues: Check network access to the API endpoint and ensure no firewall or proxy blocks the request.

Links and References

  • Refer to the external API documentation for SBC entities to understand available properties and relationships.
  • n8n documentation on using expressions for dynamic property values.
  • General REST API best practices for query options like $select and $expand.

Discussion