Interface ImageMessageOptions

interface ImageMessageOptions {
    buttons?: MessageButtonsTypes[];
    caption?: string;
    createChat?: boolean;
    delay?: number;
    detectMentioned?: boolean;
    filename?: string;
    footer?: string;
    isViewOnce?: boolean;
    markIsRead?: boolean;
    mentionedList?: (string | WAJS.whatsapp.Wid)[];
    messageId?: string | MsgKey;
    mimetype?: string;
    quotedMsg?: string | MsgKey | MsgModel;
    title?: string;
    type: "image";
    waitForAck?: boolean;
}

Hierarchy (view full)

Properties

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

Properties

Optionalbuttons

buttons?: MessageButtonsTypes[]

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

Optionalcaption

caption?: string

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
});

Optionalfilename

filename?: string

Optionalfooter

footer?: string

Footer text for buttons

OptionalisViewOnce

isViewOnce?: boolean

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 | WAJS.whatsapp.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

Optionalmimetype

mimetype?: string

OptionalquotedMsg

quotedMsg?: string | MsgKey | MsgModel

Quote a message, like a reply message

Example

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

Optionaltitle

title?: string

Title for buttons, only for text message

type

type

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