WTS Chat icon

WTS Chat

Get data from Wts API

Actions38

Overview

The node "WTS Chat" integrates with the WTS API to manage chat sessions and related entities. Specifically, the Session - Get Session By ID operation retrieves detailed information about a particular chat session using its unique session ID. This operation can optionally include additional details such as agent info, channel info, classification, contact, and department details.

This node is useful in scenarios where you need to fetch comprehensive data about a specific chat session for monitoring, reporting, or further processing within an automation workflow. For example, customer support teams can use it to pull session histories and context before responding to customers, or analytics systems can extract session metadata for performance analysis.

Properties

Name Meaning
Session ID The unique identifier of the chat session to retrieve.
Include Details Optional list of additional details to include in the response. Possible values:
- AgentDetails
- ChannelDetails
- ChannelTypeDetails
- ClassificationDetails
- ContactDetails
- DepartmentsDetails
- Undefined

Output

The output is a JSON object representing the session data retrieved from the WTS API. It includes core session information such as session identifiers, status, timestamps, and optionally enriched details depending on the "Include Details" property selected.

If binary data is involved (not applicable specifically for this operation), it would represent files or media associated with the session.

Example structure (simplified):

{
  "sessionId": "string",
  "status": "string",
  "startAt": "timestamp",
  "endAt": "timestamp",
  "agent": { /* agent details if included */ },
  "channel": { /* channel details if included */ },
  "classification": { /* classification details if included */ },
  "contact": { /* contact details if included */ },
  "departments": { /* departments details if included */ }
}

Dependencies

  • Requires an active connection to the WTS API via an API key credential.
  • The node uses the wtsApi credential to authenticate requests.
  • Network access to https://api.wts.chat is necessary.
  • No other external dependencies are required.

Troubleshooting

  • Error: "SessionID is empty!"
    Occurs if the Session ID input is missing or blank. Ensure the Session ID field is filled correctly.

  • API Errors (e.g., authentication failure, not found)
    These errors are thrown as NodeApiError with messages from the WTS API. Verify that the API key is valid and has sufficient permissions. Also, confirm the session ID exists.

  • Invalid Include Details options
    If unsupported detail options are selected, the API may return incomplete data or errors. Use only the documented options.

  • Network issues
    Failure to connect to the WTS API endpoint will cause errors. Check network connectivity and firewall settings.

Links and References

Discussion