Skip to content

whatsapp

whatsapp

WhatsAppChannel — WhatsApp Cloud API adapter.

Classes

WhatsAppChannel 

WhatsAppChannel(access_token: str = '', *, phone_number_id: str = '', bus: Optional[EventBus] = None)

Bases: BaseChannel

WhatsApp Cloud API channel adapter (send-only).

PARAMETER DESCRIPTION
access_token

WhatsApp Cloud API access token. Falls back to WHATSAPP_ACCESS_TOKEN env var.

TYPE: str DEFAULT: ''

phone_number_id

WhatsApp phone number ID. Falls back to WHATSAPP_PHONE_NUMBER_ID env var.

TYPE: str DEFAULT: ''

bus

Optional event bus for publishing channel events.

TYPE: Optional[EventBus] DEFAULT: None

Source code in src/openjarvis/channels/whatsapp.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def __init__(
    self,
    access_token: str = "",
    *,
    phone_number_id: str = "",
    bus: Optional[EventBus] = None,
) -> None:
    self._token = access_token or os.environ.get("WHATSAPP_ACCESS_TOKEN", "")
    self._phone_number_id = phone_number_id or os.environ.get(
        "WHATSAPP_PHONE_NUMBER_ID", "",
    )
    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/whatsapp.py 
55
56
57
58
59
60
61
def connect(self) -> None:
    """Mark as connected (send-only — no persistent connection)."""
    if not self._token:
        logger.warning("No WhatsApp access token configured")
        self._status = ChannelStatus.ERROR
        return
    self._status = ChannelStatus.CONNECTED
disconnect 
disconnect() -> None

Mark as disconnected.

Source code in src/openjarvis/channels/whatsapp.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 WhatsApp Cloud API.

Source code in src/openjarvis/channels/whatsapp.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
103
104
105
106
107
108
109
110
111
112
def send(
    self,
    channel: str,
    content: str,
    *,
    conversation_id: str = "",
    metadata: Dict[str, Any] | None = None,
) -> bool:
    """Send a message via the WhatsApp Cloud API."""
    if not self._token:
        logger.warning("Cannot send: no WhatsApp access token")
        return False

    try:
        import httpx

        url = (
            f"https://graph.facebook.com/v21.0/"
            f"{self._phone_number_id}/messages"
        )
        headers = {
            "Authorization": f"Bearer {self._token}",
            "Content-Type": "application/json",
        }
        payload: Dict[str, Any] = {
            "messaging_product": "whatsapp",
            "to": channel,
            "type": "text",
            "text": {"body": content},
        }

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

Return the current connection status.

Source code in src/openjarvis/channels/whatsapp.py 
114
115
116
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/whatsapp.py 
118
119
120
def list_channels(self) -> List[str]:
    """Return available channel identifiers."""
    return ["whatsapp"]
on_message 
on_message(handler: ChannelHandler) -> None

Register a callback for incoming messages.

Source code in src/openjarvis/channels/whatsapp.py 
122
123
124
def on_message(self, handler: ChannelHandler) -> None:
    """Register a callback for incoming messages."""
    self._handlers.append(handler)