Poli icon

Poli

Node principal para interagir com a API da Poli

Overview

This node interacts with the "Channel" resource of the Poli API, specifically to list channels associated with a given account. It allows users to retrieve paginated lists of communication channels, optionally filtered and sorted by various criteria.

Common scenarios where this node is beneficial include:

  • Fetching all communication channels for an account to display or process them in workflows.
  • Searching channels by text or raw query strings.
  • Sorting channels by creation date or other fields.
  • Including additional related data fields such as tags, attendant info, last message, etc., to enrich the channel data.

Practical example:

  • A customer support workflow that retrieves all active chat channels for an account, including their current attendance and last message, to monitor ongoing conversations.

Properties

Name Meaning
Account ID The unique identifier of the account whose channels are to be listed. This is required.
Options Collection of optional parameters to refine the listing:
- Search Text string to search channels by name or other searchable fields.
- Query Raw query string for advanced filtering (e.g., id=18&name=gabriel).
- Order Field and direction to sort results, e.g., created_at desc for descending order by creation date.
- Page Page number of results to retrieve (minimum 1). Defaults to 1.
- Per Page Number of items per page (minimum 1, maximum 100). Defaults to 20.
- Include Additional related fields to include in the response. Multiple can be selected from: type, chat_status, read_status, attributes, account, attendant, contact_channels, current_attendance, last_message, tags, addresses, metadata.

Output

The node outputs JSON data representing a list of channels matching the specified criteria. Each channel object may include standard channel properties plus any additional fields requested via the "Include" option.

If binary data were involved, it would be summarized here; however, this operation only returns JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Poli API.
  • The node depends on the Poli API service being accessible and the provided account ID being valid.
  • No additional external dependencies are indicated.

Troubleshooting

  • Error: Resource 'channel' not found — This indicates an invalid resource parameter; ensure "Channel" is selected.
  • Error: Operation 'list' not found for resource 'channel' — Indicates the operation parameter is incorrect; verify "List Channels" is chosen.
  • API authentication errors — Check that the API key credential is correctly configured and has necessary permissions.
  • Invalid Account ID — Ensure the Account ID is correct and exists in the Poli system.
  • Pagination issues — If no results appear, verify the page number and per-page limits; also check if filters exclude all channels.
  • Malformed query string — When using the raw query option, ensure the syntax is correct (e.g., key=value&key2=value2).

Links and References

Discussion