Struct WhatsAppChannel 

pub struct WhatsAppChannel { /* private fields */ }

Runtime Negotiation

This Cloud API channel is automatically selected when phone_number_id is set in the config. Use WhatsAppWebChannel (with session_path) for native Web mode.

Implementations

impl WhatsAppChannel

pub fn new( access_token: String, endpoint_id: String, verify_token: String, alias: impl Into<String>, peer_resolver: Arc<dyn Fn() -> Vec<String> + Sync + Send>, ) -> WhatsAppChannel

pub fn alias(&self) -> &str

Return the alias under [channels.whatsapp.<alias>] that this channel handle is bound to.

pub fn with_approval_timeout_secs(self, secs: u64) -> WhatsAppChannel

pub fn pending_approvals( &self, ) -> &Arc<Mutex<HashMap<String, Sender<ChannelApprovalResponse>>>>

Access the process-wide pending-approvals map shared across every WhatsAppChannel instance. See [PENDING_APPROVALS] for why this must be a static rather than per-instance.

pub fn with_proxy_url(self, proxy_url: Option<String>) -> WhatsAppChannel

Set a per-channel proxy URL that overrides the global proxy config.

pub fn with_dm_mention_patterns(self, patterns: Vec<String>) -> WhatsAppChannel

Set mention patterns for DM mention gating. Each pattern string is compiled as a case-insensitive regex. Invalid patterns are logged and skipped.

pub fn with_group_mention_patterns( self, patterns: Vec<String>, ) -> WhatsAppChannel

Set mention patterns for group-chat mention gating. Each pattern string is compiled as a case-insensitive regex. Invalid patterns are logged and skipped.

pub fn compile_mention_patterns(patterns: &[String]) -> Vec<Regex>

Compile raw pattern strings into case-insensitive regexes. Invalid or excessively large patterns are logged and skipped.

pub fn text_matches_patterns(patterns: &[Regex], text: &str) -> bool

Check whether text matches any pattern in the given slice.

pub fn apply_mention_gating( dm_patterns: &[Regex], group_patterns: &[Regex], content: &str, is_group: bool, ) -> Option<String>

Apply mention-pattern gating for a message.

Selects the appropriate pattern set based on is_group. When the pattern set is non-empty, messages that do not match any pattern are dropped (None); matched messages pass through unchanged. Empty pattern sets always admit.

pub fn verify_token(&self) -> &str

Get the verify token for webhook verification

pub fn parse_webhook_payload(&self, payload: &Value) -> Vec<ChannelMessage>

Parse an incoming webhook payload from Meta and extract messages

Trait Implementations

impl Attributable for WhatsAppChannel

fn role(&self) -> Role

fn alias(&self) -> &str

impl Channel for WhatsAppChannel

fn name(&self) -> &str

Human-readable channel name

fn send<'life0, 'life1, 'async_trait>( &'life0 self, message: &'life1 SendMessage, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, WhatsAppChannel: 'async_trait,

Send a message through this channel

fn request_approval<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, recipient: &'life1 str, request: &'life2 ChannelApprovalRequest, ) -> Pin<Box<dyn Future<Output = Result<Option<ChannelApprovalResponse>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, WhatsAppChannel: 'async_trait,

Request interactive tool-call approval from the channel operator.

fn listen<'life0, 'async_trait>( &'life0 self, _tx: Sender<ChannelMessage>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, WhatsAppChannel: 'async_trait,

Start listening for incoming messages (long-running)

fn health_check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where 'life0: 'async_trait, WhatsAppChannel: 'async_trait,

Check if channel is healthy

fn start_typing<'life0, 'life1, 'async_trait>( &'life0 self, _recipient: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Signal that the bot is processing a response (e.g. “typing” indicator).

fn stop_typing<'life0, 'life1, 'async_trait>( &'life0 self, _recipient: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Stop any active typing indicator.

fn supports_draft_updates(&self) -> bool

Whether this channel supports progressive message updates via draft edits.

fn self_handle(&self) -> Option<String>

Self-loop guard for multi-agent runs.

fn self_addressed_mention(&self) -> Option<String>

The exact form the bot expects to see when addressed by users on this channel. Discord wraps the snowflake as <@1088...>, Telegram presents @bot_username, Matrix presents @bot:server, Slack wraps the user ID as <@U02...>. Returned verbatim into the per-channel system prompt so the agent recognizes its own mention without guessing, and uses the same form to tag itself or peers in outbound replies.

fn drop_self_messages(&self, msg: &ChannelMessage) -> bool

Whether the orchestrator should drop an inbound message as self-authored (multi-agent self-loop guard).

fn supports_multi_message_streaming(&self) -> bool

Whether this channel supports multi-message streaming delivery.

fn multi_message_delay_ms(&self) -> u64

Minimum delay (ms) between sending each paragraph in multi-message mode.

fn send_draft<'life0, 'life1, 'async_trait>( &'life0 self, _message: &'life1 SendMessage, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Send an initial draft message. Returns a platform-specific message ID for later edits.

fn update_draft<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _recipient: &'life1 str, _message_id: &'life2 str, _text: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Update a previously sent draft message with new accumulated content.

fn update_draft_progress<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _recipient: &'life1 str, _message_id: &'life2 str, _text: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Show a progress/status update (e.g. tool execution status).

fn finalize_draft<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _recipient: &'life1 str, _message_id: &'life2 str, _text: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Finalize a draft with the complete response (e.g. apply Markdown formatting).

fn cancel_draft<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _recipient: &'life1 str, _message_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Cancel and remove a previously sent draft message if the channel supports it.

fn add_reaction<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _channel_id: &'life1 str, _message_id: &'life2 str, _emoji: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Add a reaction (emoji) to a message.

fn remove_reaction<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _channel_id: &'life1 str, _message_id: &'life2 str, _emoji: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Remove a reaction (emoji) from a message previously added by this bot.

fn pin_message<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _channel_id: &'life1 str, _message_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Pin a message in the channel.

fn unpin_message<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _channel_id: &'life1 str, _message_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Unpin a previously pinned message.

fn redact_message<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _channel_id: &'life1 str, _message_id: &'life2 str, _reason: Option<String>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Redact (delete) a message from the channel.

fn request_choice<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _question: &'life1 str, _choices: &'life2 [String], _timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Ask the user a multiple-choice question and return the chosen option’s text.

fn supports_free_form_ask(&self) -> bool

Whether this channel can answer free-form (no-choices) ask_user questions via the standard send + listen flow.