pysignalclijsonrpc 22.11.9

Python API client for signal-cli JSON-RPC

pysignalclijsonrpc - Python API client for signal-cli JSON-RPC

Python client for signal-cli 0.11.5+ native HTTP endpoint for JSON-RPC methods.

Installation

pip install pysignalclijsonrpc

Usage

Initalization

Default

from pysignalclijsonrpc.api import SignalCliJSONRPCApi

signal_cli_rest_api = SignalCliJSONRPCApi(
    endpoint="http://localhost:3000/api/v1/rpc",
    account="[phone]" # one of your registered signal-cli accounts
)

Basic authentication

from pysignalclijsonrpc.api import SignalCliJSONRPCApi

signal_cli_rest_api = SignalCliJSONRPCApi(
    endpoint="http://localhost:8080/api/v1/rpc",
    account="[phone]",
    auth=("user", "password")
)

HTTPS w/ self-signed certificates

from pysignalclijsonrpc.api import SignalCliJSONRPCApi

signal_cli_rest_api = SignalCliJSONRPCApi(
    endpoint="https://localhost:8443/api/v1/rpc",
    account="[phone]",
    verify_ssl=False
)

Send message

Plain text message

signal_cli_rest_api.send_message("Test")

Plain text message w/ attachment from file

signal_cli_rest_api.send_message("Test", filenames=["/tmp/some-image.png"])