Skip to content

WhatsApp Providers

WhatsAppProvider

Bases: ABC

WhatsApp delivery provider.

name property

name

Provider name (e.g. 'meta', 'twilio_wa').

send abstractmethod async

send(event, to)

Send a WhatsApp message.

Parameters:

Name Type Description Default
event RoomEvent

The room event containing the message content.

required
to str

Recipient WhatsApp ID or phone number.

required

Returns:

Type Description
ProviderResult

Result with provider-specific delivery metadata.

parse_webhook async

parse_webhook(payload)

Parse an inbound webhook payload into an InboundMessage.

send_template async

send_template(to, template_name, params=None)

Send a template message.

close async

close()

Release resources. Override in subclasses that hold connections.

MockWhatsAppProvider

MockWhatsAppProvider()

Bases: WhatsAppProvider

Records sent messages for verification in tests.