Everest icon

Everest

Interact with Everest TMS (Transport Management System)

Walter → Send Message

AI-generated

Overview

The Walter Send Message operation allows sending a message from Walter to a specified user. It supports sending a custom message, optionally specifying the user ID to whom the message should be sent (defaulting to the authenticated user if not provided). Additionally, it can save the message to the conversation history and supports sending multiple commands with parameters along with the message. This operation is useful for automating communication and command execution within the Everest TMS system.

Use Case Examples

  1. Sending a notification message to a user about a system update.
  2. Sending commands to a user to trigger specific actions or retrieve information.

Properties

Name Meaning
Message The content of the message to be sent from Walter.
User ID The ID of the user to whom Walter should send the message. If not specified, defaults to the authenticated user.
Save to History Whether to save the sent message to the conversation history.
Commands A collection of commands to send along with the message. Each command includes a command name and optional parameters (comma-separated).

Output

JSON

  • messageId - The unique identifier of the sent message.
  • status - The status of the message sending operation (e.g., success or failure).
  • sentToUserId - The user ID to whom the message was sent.
  • savedToHistory - Indicates if the message was saved to the conversation history.

Dependencies

  • An API key credential for authenticating with the Everest TMS API.

Troubleshooting

  • Ensure the user ID is valid and the authenticated user has permission to send messages to the specified user.
  • Check that the message content is not empty as it is required.
  • If saving to history fails, verify the system's conversation history service is operational.

Discussion