Signal

Interact with Signal CLI API

Actions8

Overview

This node integrates with the Signal CLI API to perform various operations related to Signal messaging, groups, contacts, reactions, and receipts. Specifically for the Contact - List operation, it retrieves a list of contacts associated with a specified Signal account.

Common scenarios where this node is beneficial include:

  • Automating contact management workflows by fetching all contacts from a Signal account.
  • Synchronizing Signal contacts with other systems or databases.
  • Using the contact list as input for further messaging or group management operations.

For example, you could use this node to pull all contacts from your Signal account and then send targeted messages or create groups based on those contacts.

Properties

Name Meaning
Account The identifier (string) of the Signal account whose contacts you want to list. Required.

Output

The node outputs an array containing one item with a json property. This json contains the raw response data returned by the Signal CLI API's listContacts method. The structure depends on the API but typically includes details about each contact such as phone numbers and names.

Example output structure (simplified):

{
  "result": [
    {
      "number": "+1234567890",
      "name": "Alice"
    },
    {
      "number": "+1987654321",
      "name": "Bob"
    }
  ]
}

No binary data is produced by this operation.

Dependencies

  • Requires access to the Signal CLI API endpoint URL configured in the node credentials.
  • Needs an API authentication token or key set up in the credentials to authorize requests.
  • Uses HTTP POST requests to communicate with the Signal CLI API via JSON-RPC.

Troubleshooting

  • Missing API URL: If the Signal CLI API URL is not set in the credentials, the node will throw an error indicating this. Ensure the URL is correctly configured.
  • API Communication Errors: Network issues or incorrect credentials can cause request failures. Check connectivity and credential validity.
  • Unexpected Response Format: If the API changes its response format, the node may not parse results correctly. Verify the API version compatibility.
  • Empty Contact List: If no contacts are returned, confirm that the specified account has contacts and that the account identifier is correct.

Links and References

Discussion