@wppconnect/wa-js - v3.19.3
    Preparing search index...

    Interface DocumentMessageOptions

    interface DocumentMessageOptions {
        buttons?: MessageButtonsTypes[];
        caption?: string;
        createChat?: boolean;
        delay?: number;
        detectMentioned?: boolean;
        filename?: string;
        footer?: string;
        markIsRead?: boolean;
        mentionedList?: (string | Wid)[];
        messageId?: string | MsgKey;
        mimetype?: string;
        quotedMsg?: string | MsgModel | MsgKey;
        quotedMsgPayload?: string;
        title?: string;
        type: "document";
        waitForAck?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    buttons? caption? createChat? delay? detectMentioned? filename? footer? markIsRead? mentionedList? messageId? mimetype? quotedMsg? quotedMsgPayload? title? type waitForAck?

    Properties

    buttons?: MessageButtonsTypes[]

    List of buttons, with at least 1 option and a maximum of 3

    caption?: string
    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
    })
    detectMentioned?: boolean

    Automatic detect and add the mentioned contacts with @[number]

    true

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

    Footer text for buttons

    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 | 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
    mimetype?: string
    quotedMsg?: string | MsgModel | MsgKey

    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.

    title?: string

    Title for buttons, only for text message

    type: "document"
    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