Signal

Interact with Signal CLI API

Actions8

Overview

This node integrates with the Signal CLI API to manage contacts, groups, messages, reactions, and receipts on the Signal messaging platform. Specifically for the Contact resource with the Default operation (which maps to "update" or "list" operations internally), it allows users to update contact information or list existing contacts associated with a specified Signal account.

Common scenarios where this node is beneficial include:

  • Synchronizing contact details in Signal with other systems.
  • Automating updates to contact names based on external data.
  • Retrieving a list of contacts for further processing or reporting.

For example, you could use this node to update a contact's display name after receiving new information from a CRM system or to fetch all contacts linked to a Signal account to cross-reference with another database.

Properties

Name Meaning
Account The identifier of the Signal account to operate on. This is required to specify which Signal user/account the contact actions apply to.

Output

The node outputs a JSON object containing the response from the Signal CLI API. The structure depends on the specific contact operation:

  • For update operation: The response typically confirms the update status of the contact.
  • For list operation: The response contains an array or list of contacts associated with the specified account.

The output is accessible under the json field of the node's output data. There is no binary data output.

Dependencies

  • Requires access to a Signal CLI API endpoint URL configured via credentials.
  • Needs an API key or authentication token as part of the credentials to authorize requests to the Signal CLI API.
  • Uses HTTP POST requests to communicate with the Signal CLI API using JSON-RPC 2.0 protocol.

Troubleshooting

  • Missing API URL: If the Signal CLI API URL is not set in the credentials, the node will throw an error indicating that the URL is missing. Ensure the API URL is correctly configured in the node credentials.
  • API Communication Errors: Network issues or incorrect credentials can cause request failures. Verify network connectivity and credential correctness.
  • Invalid Parameters: Providing invalid or incomplete parameters (e.g., missing account or recipient) may result in errors from the API. Double-check required fields are filled.
  • Unexpected API Responses: If the API returns unexpected data or errors, consult the Signal CLI API documentation and logs to diagnose issues.

Links and References

Discussion