WTS Chat icon

WTS Chat

Get data from Wts API

Overview

The node interacts with the WTS Chat API to retrieve and manage sequences of contacts. Specifically, the "Get All Sequences" operation fetches a list of sequences, optionally including detailed information about each sequence. This is useful for scenarios where you want to automate workflows involving contact sequences, such as marketing campaigns, follow-ups, or customer engagement tracking.

Practical examples:

  • Retrieve all sequences to display in a dashboard or report.
  • Filter sequences by name or associated contact ID to find specific sequences.
  • Use pagination and sorting options to efficiently handle large datasets.

Properties

Name Meaning
Name Filter sequences by their name (string).
Contact ID Filter sequences associated with a specific contact ID (string).
CreatedAt.After Filter sequences created after this date/time (format: YYYY-MM-DD hh:mm, timezone-aware).
CreatedAt.Before Filter sequences created before this date/time (format: YYYY-MM-DD hh:mm, timezone-aware).
UpdatedAt.After Filter sequences updated after this date/time (format: YYYY-MM-DD hh:mm, timezone-aware).
UpdatedAt.Before Filter sequences updated before this date/time (format: YYYY-MM-DD hh:mm, timezone-aware).
Auto Pagination Boolean flag to enable automatic pagination, fetching multiple pages automatically.
Max Pages Maximum number of pages to fetch when auto pagination is enabled (number between 1 and 100).
Page Number The page number to retrieve when auto pagination is disabled (number, default 1).
Page Size Number of items per page when auto pagination is disabled (number between 1 and 100).
Order By Field name to sort the results by (string).
Order Direction Direction of sorting: Ascending or Descending (options).
Include Details Sequence Whether to include detailed information about each sequence (boolean).

Note: Some properties like "Include Details Sequence" are inferred from usage context though not explicitly listed in the provided JSON but used in the code.

Output

The output is an array of JSON objects representing sequences retrieved from the WTS Chat API. Each item contains sequence data fields as returned by the API, potentially including detailed information if requested.

The json output field structure corresponds directly to the API response for sequences, which typically includes identifiers, names, timestamps, and related metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the WTS Chat API.
  • The node uses the WtsChatService's getAllSequences method to fetch sequences.
  • Network access to https://api.wts.chat is required.
  • No additional environment variables beyond the API key credential are needed.

Troubleshooting

  • Empty or missing SequenceID: If filtering by sequence ID, ensure the ID is correctly provided; otherwise, the API may return errors or empty results.
  • Invalid date formats: Date/time filters must be in the format YYYY-MM-DD hh:mm and respect the time zone; incorrect formatting can cause request failures.
  • API authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Pagination issues: When using auto pagination, setting an excessively high max pages value may lead to long execution times or rate limiting.
  • Network errors: Check connectivity to the WTS Chat API endpoint.

Common error messages thrown by the node are wrapped as NodeApiError with descriptive messages from the API or validation checks.

Links and References


This summary focuses exclusively on the "Sequence" resource and the "Get All Sequences" operation as requested.

Discussion