3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to list security refresh tokens. It allows users to retrieve a collection of security refresh tokens with various query options such as filtering, searching, ordering, and pagination. This is useful for managing and auditing active refresh tokens in the 3CX system, for example, to monitor token usage or revoke tokens if needed.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of security refresh tokens:
- Top ($top) Show only the first n items (pagination limit).
- Skip ($skip) Skip the first n items (pagination offset).
- Search ($search) Search items by search phrases; supports phrase quoting automatically if needed.
- Filter ($filter) Filter items by property values, e.g., State eq 'Connected'.
- Count ($count) Include count of total items in the response (boolean).
- Orderby ($orderby) Order items by 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, e.g., RelatedEntity1,RelatedEntity2.

These options correspond to OData-style query parameters that control how the list of security refresh tokens is retrieved and presented.

Output

The node outputs JSON data representing the list of security 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 will also include the total count of matching tokens.

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameter syntax (e.g., malformed filter expressions) may result in API errors.
    • Network connectivity problems can prevent reaching the 3CX server.
  • Error messages:
    • Authentication errors usually indicate invalid or expired credentials; reconfigure the API key.
    • Query parameter errors often return descriptive messages from the 3CX API; verify the syntax and supported fields.
    • Timeout or connection errors suggest network issues or incorrect server URL configuration.

Links and References

Discussion