WTS Chat icon

WTS Chat

Get data from Wts API

Actions17

Overview

The node interacts with the Helena API to manage chat sessions, messages, contacts, and panels. Specifically for the Session resource and the Update Status Session operation, it updates the status of an existing chat session by sending a new status value to the API.

This operation is useful in scenarios where you want to programmatically change the state of a chat session, such as marking it as completed, pending, hidden, or in progress. For example, after finishing a customer support interaction, you might update the session status to "COMPLETED" to indicate that no further action is needed.

Properties

Name Meaning
Session ID The unique identifier of the session whose status you want to update.
Status Session The new status to assign to the session. Options: Completed, Hidden, In Progress, Pending, Started, Undefined

Output

The output is a JSON object representing the updated session status response from the Helena API. It typically contains details confirming the new status of the session and any related metadata returned by the API.

No binary data is output by this operation.

Example output structure (simplified):

{
  "newStatus": "COMPLETED",
  "sessionId": "string",
  "updatedAt": "timestamp",
  // other session-related fields
}

Dependencies

  • Requires an active connection to the Helena API via an API key credential.
  • The base URL used for requests is https://api-test.helena.run.
  • The node uses HTTP PUT requests to update session status at endpoint /chat/v1/session/{sessionId}/status.

Troubleshooting

  • Invalid Session ID: If the provided session ID does not exist or is malformed, the API may return an error. Verify the session ID is correct.
  • Unauthorized / Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Invalid Status Value: The status must be one of the predefined options; otherwise, the API may reject the request.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the Helena API endpoint.

If errors occur, check the error message returned by the API for guidance on correcting input parameters or credentials.

Links and References

Discussion