@wppconnect-team/wppconnect - v2.3.5
    Preparing search index...

    Interface BookingMessageOptions

    interface BookingMessageOptions {
        body: string;
        bookingUrl?: string;
        createChat?: boolean;
        delay?: number;
        description?: string;
        detectMentioned?: boolean;
        endTime?: string | Date;
        location?: string;
        managementUrl?: string;
        markIsRead?: boolean;
        mentionedList?: (string | WAJS.whatsapp.Wid)[];
        messageId?: string | MsgKey;
        phoneNumber?: string;
        quotedMsg?: string | MsgKey | MsgModel;
        quotedMsgPayload?: string;
        startTime: string | Date;
        title?: string;
        waitForAck?: boolean;
    }

    Hierarchy (View Summary)

    Index
    body bookingUrl? createChat? delay? description? detectMentioned? endTime? location? managementUrl? markIsRead? mentionedList? messageId? phoneNumber? quotedMsg? quotedMsgPayload? startTime title? waitForAck?

    body

    body: string

    Text shown above the booking details.

    bookingUrl?: string

    URL where the customer can make the booking.

    createChat?: boolean

    Create a new chat to a new contact

    This option is no longer used. Chats are automatically created when sending messages.

    false

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
      createChat: true
    });
    delay?: number

    Delay some time (in ms) before sending message While delaying, Typing Status is used to look like a human interaction

    0

    WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
      delay: 4000
    })
    description?: string
    detectMentioned?: boolean

    Automatic detect and add mentioned contacts with @[number], or mention everyone in a group with

    true

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      detectMentioned: true
    });
    endTime?: string | Date
    location?: string

    Address or human-readable location.

    managementUrl?: string

    URL where the customer can manage an existing booking.

    markIsRead?: boolean

    Automatically mark chat is read after send a message

    true

    WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
      markIsRead: true
    });
    mentionedList?: (string | WAJS.whatsapp.Wid)[]

    Define a mentioned list for a message This option work better with a message with mension

    WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
      mentionedList: ['123@c.us', '456@c.us']
    })
    messageId?: string | MsgKey
    phoneNumber?: string
    quotedMsg?: string | MsgKey | MsgModel

    Quote a message, like a reply message

    WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
      quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
    })
    quotedMsgPayload?: string

    Quote a message using a previously saved payload. The payload must be the JSON string representation of a raw message. Raw messages can be obtained when using getMessageById or getMessages When provided it has priority over quotedMsg.

    startTime: string | Date
    title?: string
    waitForAck?: boolean

    Wait for send while the ACK of message is SENT(1)

    true

    WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
      waitForAck: true
    })

    Settings
    Member Visibility

    On This Page
    Properties