WTS Chat icon

WTS Chat

Get data from Wts API
Join our community

Actions39

Overview

This node operation retrieves a list of chat sessions from the WTS Chat API. It supports filtering sessions based on various criteria such as tags, user, department, contact, channels, activity dates, status, and more. It also allows including detailed information about agents, channels, classifications, contacts, and departments in the response. Pagination and sorting options are available to control the number of sessions returned and their order.

Use Case Examples

  1. A customer support team can use this node to fetch all active chat sessions filtered by specific tags or departments to monitor ongoing conversations.
  2. A sales team can retrieve sessions associated with particular users or contacts to analyze customer interactions.
  3. An analytics system can use this node to gather session data within a specific date range for reporting purposes.

Properties

Name Meaning
Tag Names or IDs Filter sessions by specific tag names or IDs.
User Name or ID Filter sessions by a specific user name or ID.
Department Name or ID Filter sessions by a specific department name or ID.
Contact ID Filter sessions by a specific contact ID.
Channel Names or IDs Filter sessions by specific channel names or IDs.
ActiveAt.After Filter sessions with activity after this date and time.
ActiveAt.Before Filter sessions with activity before this date and time.
EndAt.After Filter sessions that ended after this date and time.
EndAt.Before Filter sessions that ended before this date and time.
LastInteractionAt.After Filter sessions with last interaction after this date and time.
LastInteractionAt.Before Filter sessions with last interaction before this date and time.
Status Session Filter sessions by their status (e.g., Completed, Hidden, In Progress, Pending, Started).
Include Details Specify additional details to include in the session data (e.g., AgentDetails, ChannelDetails, ContactDetails).
CreatedAt.After Filter sessions created after this date and time.
CreatedAt.Before Filter sessions created before this date and time.
UpdatedAt.After Filter sessions updated after this date and time.
UpdatedAt.Before Filter sessions updated before this date and time.
Auto Pagination Enable automatic pagination to retrieve multiple pages of results.
Max Pages Maximum number of pages to retrieve when auto pagination is enabled.
Page Number The page number to retrieve when auto pagination is disabled.
Page Size Number of items per page when auto pagination is disabled.
Order By Field to sort the sessions by.
Order Direction Direction of sorting (Ascending or Descending).

Output

JSON

  • json - The JSON output contains the list of sessions matching the specified filters and options.

Dependencies

  • WTS Chat API
  • an API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access session data.
  • Verify that all required parameters, such as session filters and pagination settings, are correctly set to avoid empty or incomplete results.
  • Check for proper date-time format (YYYY-MM-DD hh:mm) in date filters to prevent errors.
  • If using pagination, ensure the max pages and page size are within allowed limits to avoid request failures.

Links

Discussion