whatsapp-api-js - v6.2.2
    Preparing search index...

    Type Alias OnMessageArgs

    type OnMessageArgs = {
        block: () => ReturnType<WhatsAppAPI["blockUser"]>;
        contact: ServerContacts;
        from: string;
        message: ServerMessage;
        name?: string;
        offload: typeof offload;
        phoneID: string;
        raw: PostData;
        received: (
            indicator?: ClientTypingIndicators,
        ) => ReturnType<WhatsAppAPI["markAsRead"]>;
        recipient: ClientRecipientIdentifier;
        reply: (
            response: ClientMessage,
            context?: boolean,
            biz_opaque_callback_data?: string,
        ) => Promise<ServerMessageResponse | Response>;
        Whatsapp: InstanceType<typeof WhatsAppAPI>;
    }
    Index

    Properties

    block contact from message name? offload phoneID raw received recipient reply Whatsapp

    Properties

    block: () => ReturnType<WhatsAppAPI["blockUser"]>

    Block the user who sent the message

    Type Declaration

    contact: ServerContacts

    The client's contact info

    from: string

    The user's phone number (wa_id), with fallback to parent_user_id and user_id.

    Prefer using contact.wa_id.

    message: ServerMessage

    The messages object

    name?: string

    The user's full name

    Prefer using contact.profile.name.

    offload: typeof offload

    Utility function for offloading code from the main thread, useful for long running tasks such as AI generation

    phoneID: string

    The bot's phoneID

    raw: PostData

    The raw data from the API

    received: (
        indicator?: ClientTypingIndicators,
    ) => ReturnType<WhatsAppAPI["markAsRead"]>

    Mark the received message as read, and optionally display a typing indicator

    Type Declaration

    recipient: ClientRecipientIdentifier

    A client recipient identifier, provided as a helper for replying messages using sendMessage.

    The code prioritize the parent_user_id over user_id, as it is the recommended way to use it based on the API docs.

    whatsapp.on.message = async ({ phoneID, recipient, reply }) => {
        await whatsapp.sendMessage(phoneID, recipient, new Text("Hi!"));
        // Equivalent to
        await reply(new Text("Hi!"));
    }
    reply: (
        response: ClientMessage,
        context?: boolean,
        biz_opaque_callback_data?: string,
    ) => Promise<ServerMessageResponse | Response>

    A method to easily reply to the user who sent the message

    Type Declaration

      • (
            response: ClientMessage,
            context?: boolean,
            biz_opaque_callback_data?: string,
        ): Promise<ServerMessageResponse | Response>

      • Parameters

        • response: ClientMessage

          The message to send as a reply

        • Optionalcontext: boolean

          Wether to mention the current message, defaults to false

        • Optionalbiz_opaque_callback_data: string

          An arbitrary 512B string, useful for tracking

        Returns Promise<ServerMessageResponse | Response>

        The WhatsAppAPI.sendMessage return value

    Whatsapp: InstanceType<typeof WhatsAppAPI>

    The WhatsAppAPI instance that emitted the event

    Settings

    Member Visibility

    On This Page

    Properties