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? delay? detectMentioned? discount? markIsRead? mentionedList? messageId? notes? offset? payment_instruction? pix? quotedMsg? shipping? tax? waitForAck?

Properties

OptionalcreateChat

createChat?: boolean

Create a new chat to a new contact

Default

false

Example

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

Optionaldelay

delay?: number

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

Default

0

Example

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

OptionaldetectMentioned

detectMentioned?: boolean

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

Default

true

Example

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

Optionaldiscount

discount?: number

OptionalmarkIsRead

markIsRead?: boolean

Automatically mark chat is read after send a message

Default

true

Example

WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
  markIsRead: true
});

OptionalmentionedList

mentionedList?: (string | Wid)[]

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

Example

WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
  mentionedList: ['123@c.us', '456@c.us']
})

OptionalmessageId

messageId?: string | MsgKey

Optionalnotes

notes?: string

Optionaloffset

offset?: number

Optionalpayment_instruction

payment_instruction?: string

Optionalpix

pix?: {
    key: string;
    keyType:
        | "CNPJ"
        | "CPF"
        | "PHONE"
        | "EMAIL"
        | "EVP";
    name: string;
}

OptionalquotedMsg

quotedMsg?: string | MsgModel | MsgKey

Quote a message, like a reply message

Example

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

Optionalshipping

shipping?: number

Optionaltax

tax?: number

OptionalwaitForAck

waitForAck?: boolean

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

Default

true

Example

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

Settings

Member Visibility

On This Page

Properties