3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to list refresh tokens associated with the user's account or application. This operation is useful for managing authentication tokens, auditing active sessions, or cleaning up unused tokens to maintain security.

Common scenarios include:

  • Retrieving a paginated list of refresh tokens to monitor active sessions.
  • Searching or filtering tokens based on specific criteria such as state or creation date.
  • Selecting specific properties of tokens to display or process further.
  • Expanding related entities linked to each token for detailed information.

Practical example: An administrator wants to list all refresh tokens that are currently connected and order them by creation date to identify old or potentially compromised tokens.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of refresh tokens:
- Top ($top) Show only the first n items (pagination limit).
- Skip ($skip) Skip the first n items (pagination offset).
- Search ($search) Search tokens by phrases; supports automatic quoting if phrase contains spaces.
- Filter ($filter) Filter tokens by property values, e.g., State eq 'Connected'.
- Count ($count) Include the count of total items in the response (boolean).
- Orderby ($orderby) Order tokens by specified property values, e.g., Name desc, CreatedAt asc.
- Select ($select) Select specific properties to be returned, e.g., Id,Name.
- Expand ($expand) Expand related entities to include additional linked data, e.g., RelatedEntity1.

Output

The node outputs JSON data representing the list of refresh tokens retrieved from the 3CX API. The structure typically includes an array of token objects with properties depending on the $select option or default fields. If $count is enabled, the output also includes the total count of matching tokens.

If binary data were involved (not indicated here), it would represent downloadable content or files related to tokens, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node uses HTTP requests with JSON responses.
  • No other external dependencies are indicated.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in filter, search, or orderby options may cause API errors. Validate expressions carefully.
  • Empty results: May occur if filters or search terms do not match any tokens.
  • Network issues: Verify connectivity to the 3CX server URL.
  • Unexpected response format: Confirm the 3CX API version matches the node's expected version.

Links and References

Discussion