Interface OrderMessageOptions

interface OrderMessageOptions {
    createChat?: boolean;
    delay?: number;
    detectMentioned?: boolean;
    discount?: number;
    markIsRead?: boolean;
    mentionedList?: (string | Wid)[];
    messageId?: string | MsgKey;
    notes?: string;
    offset?: number;
    payment_instruction?: string;
    pix?: {
        key: string;
        keyType:
            | "CNPJ"
            | "CPF"
            | "PHONE"
            | "EMAIL"
            | "EVP";
        name: string;
    };
    quotedMsg?: string | MsgModel | MsgKey;
    shipping?: number;
    tax?: number;
    waitForAck?: boolean;
}

Hierarchy (view full)

Properties

createChat?: boolean

Create a new chat to a new contact

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
});
discount?: number
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
notes?: string
offset?: number
payment_instruction?: string
pix?: {
    key: string;
    keyType:
        | "CNPJ"
        | "CPF"
        | "PHONE"
        | "EMAIL"
        | "EVP";
    name: 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'
})
shipping?: number
tax?: number
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
})