WTS Chat icon

WTS Chat

Get data from Wts API

Overview

The node interacts with the WTS Chat API to manage chat sessions and related messaging activities. Specifically, the "Complete Session" operation under the "Session" resource allows users to conclude a chat session, optionally setting it to reactivate if a new message arrives from the contact. This is useful in customer support or sales scenarios where conversations need to be formally closed but may reopen automatically upon further interaction.

Practical examples:

  • A support agent finishes a conversation with a customer and marks the session as concluded.
  • The session can be set to automatically reactivate if the customer sends another message, ensuring no communication is missed.

Properties

Name Meaning
Session ID The unique identifier of the chat session to be concluded.
Reactivate On New Message Boolean flag indicating whether the session should automatically reactivate when a new message is received from the contact. Defaults to false.

Output

The output is a JSON object representing the result of concluding the session. It typically contains details about the session's updated state after conclusion, such as confirmation of the session being marked as completed and any relevant metadata returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the WTS Chat API.
  • The node depends on the external WTS Chat service endpoints to perform session management operations.
  • No additional environment variables are explicitly required beyond the API key credential configuration.

Troubleshooting

  • Common issues:

    • Missing or empty Session ID: The node throws an error if the Session ID parameter is not provided or is empty.
    • API authentication failure: If the API key is invalid or missing, requests will fail.
    • Network or API errors: Any issues communicating with the WTS Chat API will result in errors.
  • Error messages and resolutions:

    • "SessionID is empty! Fill in the SessionID field": Ensure the Session ID property is correctly set.
    • API errors wrapped as NodeApiError: Check API key validity and network connectivity.
    • Unexpected response or permission errors: Verify that the API key has sufficient permissions to conclude sessions.

Links and References

Discussion