Superchat icon

Superchat

Retrieve data from the Superchat API

Actions18

Overview

This node allows sending a message through the Superchat platform. It supports sending either plain text messages or media messages (files) to a specified recipient via a selected communication channel. Typical use cases include automating customer support replies, broadcasting notifications, or integrating messaging capabilities into workflows that require direct communication with contacts or users.

For example, you could use this node to send a confirmation SMS or email after a user completes a form, or to deliver multimedia content like images or documents directly to a contact in your Superchat system.

Properties

Name Meaning
Sender Name The name displayed as the sender beneath the message in Superchat.
To (Identifier) The recipient identifier; can be a phone number, an email address, or a Contact ID.
Channel ID The ID of the channel from which the message will be sent. Can be entered manually or selected from a searchable list of available channels.
Content The actual message content. Two options are available:
- Text: Plain text message content.
- Media: A file to send, identified by its file ID, either entered manually or selected from a searchable list of files.

Output

The node outputs a JSON array where each item corresponds to the result of sending a message for each input item processed. The exact structure depends on the Superchat API response but generally includes details about the sent message such as message ID, status, timestamps, and any error information if applicable.

If media is sent, the output confirms the successful transmission of the file along with metadata related to the media.

Dependencies

  • Requires an active connection to the Superchat API using an API key credential.
  • The node depends on the availability of valid channel IDs and optionally file IDs within Superchat.
  • Proper permissions must be granted to the API key to send messages and access channels/files.

Troubleshooting

  • Invalid Identifier: If the "To (Identifier)" field is incorrect or does not correspond to a valid phone number, email, or contact ID, the message will fail to send. Verify the identifier format and existence in Superchat.
  • Channel Not Found: Providing an invalid or unauthorized channel ID will cause errors. Ensure the channel ID exists and the API key has permission to send messages from it.
  • Missing Required Fields: The node requires "Sender Name", "To (Identifier)", "Channel ID", and message content. Omitting any will result in validation errors.
  • File Not Found: When sending media, if the file ID is invalid or inaccessible, the operation will fail. Confirm the file exists and is accessible.
  • API Authentication Errors: If the API key is missing, expired, or lacks necessary scopes, authentication errors will occur. Check credentials configuration.
  • Rate Limits or Quotas: Sending too many messages in a short time may trigger rate limits. Implement retries or throttling as needed.

Links and References

Discussion