Woztell Sender

Send messages through Woztell API

Overview

The Woztell Sender node allows you to send various types of messages through the Woztell API. It supports sending text messages as well as media files such as images, videos, audio, and generic files to specific members within a given channel.

This node is useful in scenarios where you want to automate communication with users on messaging platforms supported by Woztell, for example:

  • Sending notifications or alerts to users.
  • Delivering multimedia content like promotional images or videos.
  • Responding to user interactions with personalized messages.

Practical example: You could use this node to automatically send a welcome message (text) to new members joining a channel, or share a product brochure (PDF file) via a media URL.

Properties

Name Meaning
Channel ID The unique identifier of the channel where the message will be sent.
Member ID The unique identifier of the member who will receive the message.
Response Type The type of message to send. Options: Audio, File, Image, Text, Video.
Text Message The text content of the message (required if Response Type is Text).
Media URL The URL of the media file to send (required if Response Type is Audio, File, Image, Video).
Caption Optional text caption accompanying media files (Audio, File, Image, Video).
API Endpoint The Woztell API endpoint URL used to send the message. Defaults to https://bot.api.woztell.com/sendResponses.

Output

The node outputs an array of JSON objects, each representing the result of sending a message for each input item. Each output object contains:

  • success: Boolean indicating if the message was sent successfully.
  • channelId: The channel ID used.
  • memberId: The member ID targeted.
  • responseType: The type of response sent (Text, Image, etc.).
  • apiResponse: The raw response returned from the Woztell API.
  • sentData: The data payload that was sent to the API.

If sending fails and the node is configured to continue on failure, the output includes:

  • success: false
  • error: The error message describing what went wrong.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Woztell API (referred generically as "an API key credential").
  • Uses HTTP POST requests to the specified Woztell API endpoint.
  • The default API endpoint is https://bot.api.woztell.com/sendResponses, but it can be customized.

Troubleshooting

  • Common issues:

    • Invalid or missing Channel ID or Member ID will cause the API call to fail.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Providing an invalid media URL or unsupported media format may cause the API to reject the request.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "Failed to send message: <error message>" indicates the node encountered an error during the HTTP request.
    • If the node is set to stop on failure, it will throw an error stopping execution; otherwise, it logs the error in the output.

  • Resolutions:

    • Verify all required fields are correctly filled.
    • Ensure the API key credential is valid and has necessary permissions.
    • Check media URLs are accessible and point to supported file types.
    • Confirm network access to the Woztell API endpoint.

Links and References

Discussion