Struct WhatsAppConfig 

pub struct WhatsAppConfig {

    pub access_token: Option<String>,
    pub phone_number_id: Option<String>,
    pub verify_token: Option<String>,
    pub app_secret: Option<String>,
    pub session_path: Option<String>,
    pub pair_phone: Option<String>,
    pub pair_code: Option<String>,
    pub allowed_numbers: Vec<String>,
    pub mode: WhatsAppWebMode,
    pub dm_policy: WhatsAppChatPolicy,
    pub group_policy: WhatsAppChatPolicy,
    pub self_chat_mode: bool,
    pub dm_mention_patterns: Vec<String>,
    pub group_mention_patterns: Vec<String>,
    pub proxy_url: Option<String>,
}

WhatsApp channel configuration (Cloud API or Web mode).

Set phone_number_id for Cloud API mode, or session_path for Web mode.

Fields

access_token: Option<String>

Access token from Meta Business Suite (Cloud API mode)

phone_number_id: Option<String>

Phone number ID from Meta Business API (Cloud API mode)

verify_token: Option<String>

Webhook verify token (you define this, Meta sends it back for verification) Only used in Cloud API mode

app_secret: Option<String>

App secret from Meta Business Suite (for webhook signature verification) Can also be set via CONSTRUCT_WHATSAPP_APP_SECRET environment variable Only used in Cloud API mode

session_path: Option<String>

Session database path for WhatsApp Web client (Web mode) When set, enables native WhatsApp Web mode with wa-rs

pair_phone: Option<String>

Phone number for pair code linking (Web mode, optional) Format: country code + number (e.g., “15551234567”) If not set, QR code pairing will be used

pair_code: Option<String>

Custom pair code for linking (Web mode, optional) Leave empty to let WhatsApp generate one

allowed_numbers: Vec<String>

Allowed phone numbers (E.164 format: +1234567890) or “*” for all

mode: WhatsAppWebMode

Usage mode for WhatsApp Web: “business” (default) or “personal”. In personal mode the bot applies dm_policy, group_policy, and self_chat_mode to decide which chats to respond in.

dm_policy: WhatsAppChatPolicy

Policy for direct messages when mode = “personal”. “allowlist” (default) | “ignore” | “all”.

group_policy: WhatsAppChatPolicy

Policy for group chats when mode = “personal”. “allowlist” (default) | “ignore” | “all”.

self_chat_mode: bool

When true and mode = “personal”, always respond to messages in the user’s own self-chat (Notes to Self). Defaults to false.

dm_mention_patterns: Vec<String>

Regex patterns for DM mention gating (case-insensitive). When non-empty, only direct messages matching at least one pattern are processed; matched fragments are stripped from the forwarded content. Example: ["@?Construct", "\\+?15555550123"]

group_mention_patterns: Vec<String>

Regex patterns for group-chat mention gating (case-insensitive). When non-empty, only group messages matching at least one pattern are processed; matched fragments are stripped from the forwarded content. Example: ["@?Construct", "\\+?15555550123"]

proxy_url: Option<String>

Per-channel proxy URL (http, https, socks5, socks5h). Overrides the global [proxy] setting for this channel only.

Implementations

impl WhatsAppConfig

pub fn backend_type(&self) -> &'static str

Detect which backend to use based on config fields. Returns “cloud” if phone_number_id is set, “web” if session_path is set.

pub fn is_cloud_config(&self) -> bool

Check if this is a valid Cloud API config

pub fn is_web_config(&self) -> bool

Check if this is a valid Web config

pub fn is_ambiguous_config(&self) -> bool

Returns true when both Cloud and Web selectors are present.

Runtime currently prefers Cloud mode in this case for backward compatibility.

Trait Implementations

impl ChannelConfig for WhatsAppConfig

fn name() -> &'static str

human-readable name

fn desc() -> &'static str

short description

impl Clone for WhatsAppConfig

fn clone(&self) -> WhatsAppConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WhatsAppConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WhatsAppConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WhatsAppConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for WhatsAppConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.