sendblue

sendblue

SendBlue channel — iMessage/SMS API adapter.

Sends and receives iMessages (blue bubbles!) and SMS via the SendBlue API. The agent gets a dedicated phone number; users text that number to interact.

API reference: https://docs.sendblue.com/api-v2/

Classes

SendBlueChannel

SendBlueChannel(*, api_key_id: str = '', api_secret_key: str = '', from_number: str = '', webhook_secret: str = '', bus: Optional[EventBus] = None)

Bases: BaseChannel

SendBlue iMessage/SMS channel adapter.

PARAMETER	DESCRIPTION
api_key_id	SendBlue API key ID. Falls back to SENDBLUE_API_KEY_ID env var. TYPE: str DEFAULT: ''
api_secret_key	SendBlue API secret key. Falls back to SENDBLUE_API_SECRET_KEY env var. TYPE: str DEFAULT: ''
from_number	The SendBlue phone number to send from (E.164 format). Falls back to SENDBLUE_FROM_NUMBER env var. TYPE: str DEFAULT: ''
webhook_secret	Optional secret for verifying incoming webhook requests. TYPE: str DEFAULT: ''
bus	Optional event bus for publishing channel events. TYPE: Optional[EventBus] DEFAULT: None

Source code in src/openjarvis/channels/sendblue.py

def __init__(
    self,
    *,
    api_key_id: str = "",
    api_secret_key: str = "",
    from_number: str = "",
    webhook_secret: str = "",
    bus: Optional[EventBus] = None,
) -> None:
    self._api_key_id = api_key_id or os.environ.get(
        "SENDBLUE_API_KEY_ID", ""
    )
    self._api_secret_key = api_secret_key or os.environ.get(
        "SENDBLUE_API_SECRET_KEY", ""
    )
    self._from_number = from_number or os.environ.get(
        "SENDBLUE_FROM_NUMBER", ""
    )
    self._webhook_secret = webhook_secret
    self._bus = bus
    self._handlers: List[ChannelHandler] = []
    self._status = ChannelStatus.DISCONNECTED

Attributes

from_number property

from_number: str

The SendBlue phone number this channel sends from.

Functions

connect

connect() -> None

Validate credentials and mark as connected.

Source code in src/openjarvis/channels/sendblue.py

def connect(self) -> None:
    """Validate credentials and mark as connected."""
    if not self._api_key_id or not self._api_secret_key:
        logger.warning("No SendBlue API credentials configured")
        self._status = ChannelStatus.ERROR
        return
    self._status = ChannelStatus.CONNECTED

disconnect

disconnect() -> None

Mark as disconnected.

Source code in src/openjarvis/channels/sendblue.py

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 an iMessage/SMS via SendBlue.

PARAMETER	DESCRIPTION
channel	Recipient phone number in E.164 format (e.g. "+15551234567"). TYPE: str
content	Message text to send. TYPE: str

Source code in src/openjarvis/channels/sendblue.py

def send(
    self,
    channel: str,
    content: str,
    *,
    conversation_id: str = "",
    metadata: Dict[str, Any] | None = None,
) -> bool:
    """Send an iMessage/SMS via SendBlue.

    Parameters
    ----------
    channel:
        Recipient phone number in E.164 format (e.g. "+15551234567").
    content:
        Message text to send.
    """
    if not self._api_key_id or not self._api_secret_key:
        logger.warning("Cannot send: no SendBlue credentials configured")
        return False

    try:
        import httpx

        payload: Dict[str, Any] = {
            "number": channel,
            "content": content,
        }
        if self._from_number:
            payload["from_number"] = self._from_number

        resp = httpx.post(
            f"{_API_BASE}/api/send-message",
            headers={
                "sb-api-key-id": self._api_key_id,
                "sb-api-secret-key": self._api_secret_key,
                "Content-Type": "application/json",
            },
            json=payload,
            timeout=30.0,
        )
        if resp.status_code < 300:
            self._publish_sent(channel, content, conversation_id)
            return True
        logger.warning(
            "SendBlue API returned status %d: %s",
            resp.status_code,
            resp.text[:200],
        )
        return False
    except Exception:
        logger.debug("SendBlue send failed", exc_info=True)
        return False

handle_webhook

handle_webhook(payload: Dict[str, Any]) -> None

Process an incoming webhook payload from SendBlue.

Expected fields: from_number, content, to_number, message_handle, is_outbound, status, service.

Source code in src/openjarvis/channels/sendblue.py

def handle_webhook(self, payload: Dict[str, Any]) -> None:
    """Process an incoming webhook payload from SendBlue.

    Expected fields: from_number, content, to_number, message_handle,
    is_outbound, status, service.
    """
    if payload.get("is_outbound", False):
        return  # Ignore outbound status callbacks

    from_number = payload.get("from_number", "")
    content = payload.get("content", "")
    message_handle = payload.get("message_handle", "")

    if not from_number or not content:
        return

    msg = ChannelMessage(
        channel="sendblue",
        sender=from_number,
        content=content,
        message_id=message_handle,
    )

    for handler in self._handlers:
        try:
            handler(msg)
        except Exception:
            logger.exception("Handler failed for SendBlue message")

    if self._bus is not None:
        self._bus.publish(
            EventType.CHANNEL_MESSAGE_RECEIVED,
            {
                "channel": "sendblue",
                "sender": from_number,
                "content": content,
                "message_id": message_handle,
                "service": payload.get("service", ""),
            },
        )

status

status() -> ChannelStatus

Return the current connection status.

Source code in src/openjarvis/channels/sendblue.py

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/sendblue.py

def list_channels(self) -> List[str]:
    """Return available channel identifiers."""
    return ["sendblue"]

on_message

on_message(handler: ChannelHandler) -> None

Register a callback for incoming messages.

Source code in src/openjarvis/channels/sendblue.py

def on_message(self, handler: ChannelHandler) -> None:
    """Register a callback for incoming messages."""
    self._handlers.append(handler)