Signal

Interact with Signal CLI API

Actions8

Overview

This node interacts with the Signal CLI API to manage reactions on Signal messages. Specifically, the "Remove Reaction" operation allows users to remove a previously sent reaction from a message in a Signal conversation. This is useful when you want to retract or correct a reaction you have added to a message.

Practical scenarios include:

  • Removing an incorrect or unintended emoji reaction from a message.
  • Managing reactions programmatically in automated workflows, such as clearing reactions after certain conditions are met.

Properties

Name Meaning
Account The Signal account identifier used to send the request.
Recipient Phone number or group ID of the recipient where the reaction was sent and should be removed.
Reaction The specific reaction (emoji or symbol) to remove from the message.
Target Author The author (phone number) of the original message that was reacted to.
Timestamp The timestamp of the original message being reacted to, used to identify the exact message.

Output

The node outputs a JSON object containing the response from the Signal CLI API after attempting to remove the reaction. The structure typically includes:

  • jsonrpc: JSON-RPC protocol version.
  • id: Unique request identifier.
  • result or error: Result of the operation or error details if the removal failed.

No binary data output is involved.

Example output snippet:

{
  "jsonrpc": "2.0",
  "id": "some-uuid",
  "result": {
    "success": true
  }
}

Dependencies

  • Requires access to a running Signal CLI API endpoint.
  • An API URL must be configured in the node credentials.
  • The node uses HTTP POST requests to communicate with the Signal CLI API.
  • Requires an API authentication token or key configured in the credentials (generic API key credential).

Troubleshooting

  • Common issues:

    • Missing or incorrect Signal CLI API URL in credentials will cause the node to throw an error.
    • Incorrect or missing parameters like account, recipient, reaction, target author, or timestamp can lead to failure in removing the reaction.
    • Network connectivity issues to the Signal CLI API endpoint.

  • Error messages:

    • "Signal CLI API URL is not set in credentials": Ensure the API URL is correctly set in the node's credentials.
    • "Error interacting with Signal API": General error indicating the API call failed; check network, credentials, and parameter correctness.

Links and References

Discussion