Skip to content

messenger_channel

messenger_channel

MessengerChannel — Facebook Messenger adapter via pymessenger.

Classes

MessengerChannel 

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

Bases: BaseChannel

Facebook Messenger channel adapter.

Uses the Messenger Platform Send API via pymessenger.

PARAMETER DESCRIPTION
access_token

Facebook page access token. Falls back to MESSENGER_ACCESS_TOKEN env var.

TYPE: str DEFAULT: ''

bus

Optional event bus for publishing channel events.

TYPE: Optional[EventBus] DEFAULT: None

Source code in src/openjarvis/channels/messenger_channel.py 
37
38
39
40
41
42
43
44
45
46
47
48
def __init__(
    self,
    access_token: str = "",
    *,
    bus: Optional[EventBus] = None,
) -> None:
    self._access_token = access_token or os.environ.get(
        "MESSENGER_ACCESS_TOKEN", ""
    )
    self._bus = bus
    self._handlers: List[ChannelHandler] = []
    self._status = ChannelStatus.DISCONNECTED
Functions
connect 
connect() -> None

Validate credentials and mark as connected.

Source code in src/openjarvis/channels/messenger_channel.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def connect(self) -> None:
    """Validate credentials and mark as connected."""
    if not self._access_token:
        logger.warning("No Messenger access_token configured")
        self._status = ChannelStatus.ERROR
        return
    try:
        import pymessenger  # noqa: F401
    except ImportError:
        raise ImportError(
            "pymessenger not installed. Install with: "
            "uv sync --extra channel-messenger"
        )
    self._status = ChannelStatus.CONNECTED
disconnect 
disconnect() -> None

Mark as disconnected.

Source code in src/openjarvis/channels/messenger_channel.py 
67
68
69
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 to a Messenger user.

PARAMETER DESCRIPTION
channel

Facebook user PSID to send to.

TYPE: str

content

Text message content.

TYPE: str

Source code in src/openjarvis/channels/messenger_channel.py 
 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
def send(
    self,
    channel: str,
    content: str,
    *,
    conversation_id: str = "",
    metadata: Dict[str, Any] | None = None,
) -> bool:
    """Send a message to a Messenger user.

    Parameters
    ----------
    channel:
        Facebook user PSID to send to.
    content:
        Text message content.
    """
    if not self._access_token:
        logger.warning("Cannot send: no Messenger credentials configured")
        return False

    try:
        from pymessenger import Bot

        bot = Bot(self._access_token)
        bot.send_text_message(channel, content)

        self._publish_sent(channel, content, conversation_id)
        return True
    except ImportError:
        logger.debug("pymessenger not installed")
        return False
    except Exception:
        logger.debug("Messenger send failed", exc_info=True)
        return False
status 
status() -> ChannelStatus

Return the current connection status.

Source code in src/openjarvis/channels/messenger_channel.py 
109
110
111
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/messenger_channel.py 
113
114
115
def list_channels(self) -> List[str]:
    """Return available channel identifiers."""
    return ["messenger"]
on_message 
on_message(handler: ChannelHandler) -> None

Register a callback for incoming messages.

Source code in src/openjarvis/channels/messenger_channel.py 
117
118
119
def on_message(self, handler: ChannelHandler) -> None:
    """Register a callback for incoming messages."""
    self._handlers.append(handler)