Skip to content

signal_channel

signal_channel

SignalChannel — Signal adapter via signal-cli REST API.

Classes

SignalChannel 

SignalChannel(api_url: str = '', *, phone_number: str = '', bus: Optional[EventBus] = None)

Bases: BaseChannel

Signal channel adapter via signal-cli REST API (send-only).

PARAMETER DESCRIPTION
api_url

Base URL of the signal-cli REST API. Falls back to SIGNAL_API_URL env var.

TYPE: str DEFAULT: ''

phone_number

Sender phone number registered with signal-cli. Falls back to SIGNAL_PHONE_NUMBER env var.

TYPE: str DEFAULT: ''

bus

Optional event bus for publishing channel events.

TYPE: Optional[EventBus] DEFAULT: None

Source code in src/openjarvis/channels/signal_channel.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def __init__(
    self,
    api_url: str = "",
    *,
    phone_number: str = "",
    bus: Optional[EventBus] = None,
) -> None:
    self._api_url = api_url or os.environ.get("SIGNAL_API_URL", "")
    self._phone_number = phone_number or os.environ.get(
        "SIGNAL_PHONE_NUMBER", "",
    )
    self._bus = bus
    self._handlers: List[ChannelHandler] = []
    self._status = ChannelStatus.DISCONNECTED
Functions
connect 
connect() -> None

Mark as connected (send-only — no persistent connection).

Source code in src/openjarvis/channels/signal_channel.py 
55
56
57
58
59
60
61
def connect(self) -> None:
    """Mark as connected (send-only — no persistent connection)."""
    if not self._api_url:
        logger.warning("No Signal API URL configured")
        self._status = ChannelStatus.ERROR
        return
    self._status = ChannelStatus.CONNECTED
disconnect 
disconnect() -> None

Mark as disconnected.

Source code in src/openjarvis/channels/signal_channel.py 
63
64
65
def disconnect(self) -> None:
    """Mark as disconnected."""
    self._status = ChannelStatus.DISCONNECTED
send 
send(channel: str, content: str, *, conversation_id: str = '', metadata: Dict[str, Any] | None = None) -> bool

Send a message via the signal-cli REST API.

Source code in src/openjarvis/channels/signal_channel.py 
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def send(
    self,
    channel: str,
    content: str,
    *,
    conversation_id: str = "",
    metadata: Dict[str, Any] | None = None,
) -> bool:
    """Send a message via the signal-cli REST API."""
    if not self._api_url:
        logger.warning("Cannot send: no Signal API URL configured")
        return False

    try:
        import httpx

        url = f"{self._api_url}/v2/send"
        payload: Dict[str, Any] = {
            "message": content,
            "number": self._phone_number,
            "recipients": [channel],
        }

        resp = httpx.post(url, json=payload, timeout=10.0)
        if resp.status_code < 300:
            self._publish_sent(channel, content, conversation_id)
            return True
        logger.warning(
            "Signal API returned status %d", resp.status_code,
        )
        return False
    except Exception:
        logger.debug("Signal send failed", exc_info=True)
        return False
status 
status() -> ChannelStatus

Return the current connection status.

Source code in src/openjarvis/channels/signal_channel.py 
104
105
106
def status(self) -> ChannelStatus:
    """Return the current connection status."""
    return self._status
list_channels 
list_channels() -> List[str]

Return available channel identifiers.

Source code in src/openjarvis/channels/signal_channel.py 
108
109
110
def list_channels(self) -> List[str]:
    """Return available channel identifiers."""
    return ["signal"]
on_message 
on_message(handler: ChannelHandler) -> None

Register a callback for incoming messages.

Source code in src/openjarvis/channels/signal_channel.py 
112
113
114
def on_message(self, handler: ChannelHandler) -> None:
    """Register a callback for incoming messages."""
    self._handlers.append(handler)