Poli icon

Poli

Node principal para interagir com a API da Poli

Chat → List Chats

AI-generated

Overview

This node operation lists chats associated with a specified account in the Poli API. It supports filtering, pagination, and inclusion of additional fields in the response. This is useful for scenarios where you need to retrieve and manage chat data programmatically, such as monitoring chat activity, analyzing chat statuses, or integrating chat data into other workflows.

Use Case Examples

  1. Retrieve all chats for a given account with default pagination.
  2. Search chats containing specific text or filter by tags, users, or teams.
  3. Include additional fields like read status, chat status, and attendant information in the chat list response.

Properties

Name Meaning
Account UUID The unique identifier of the account for which to list chats, required to specify the account context.
Options Additional parameters to customize the chat list query, including search text, raw query string, pagination (page and per page), fields to include in the response, and various filters such as tags, users, teams, and start date range.

Output

JSON

  • chats - Array of chat objects returned from the API, representing the list of chats.
  • pagination
    • page - Current page number of the results.
    • perPage - Number of items per page in the results.
    • total - Total number of chat items available.

Dependencies

  • Requires an API key credential for authenticating with the Poli API.

Troubleshooting

  • Ensure the 'Account UUID' is correctly provided and valid; missing or incorrect account ID will cause errors.
  • Verify that the API credentials are correctly configured and have the necessary permissions to list chats.
  • Check the format of date filters (Started At From/To) to match 'YYYY-MM-DD HH:mm' format to avoid parsing errors.
  • If using raw query strings or search text, ensure they are properly formatted to avoid API query errors.

Discussion