Skip to main content

WhatsAppMessages

@quik/communication

@quik/communication / WhatsAppMessages

Variable: WhatsAppMessages

const WhatsAppMessages: object

Defined in: communication/src/whatsapp/messages.ts:78

Builder helpers for supported WhatsApp message types.

Type Declaration​

audio()​

audio(to, payload, options?): IQWhatsappMessageOptions<QWhatsAppMediaPayload>

Creates an audio message.

Parameters​

to​

string

payload​

QWhatsAppMediaPayload

options?​
from?​

string

Returns​

IQWhatsappMessageOptions<QWhatsAppMediaPayload>

document()​

document(to, payload, options?): IQWhatsappMessageOptions<QWhatsAppMediaPayload>

Creates a document message.

Parameters​

to​

string

payload​

QWhatsAppMediaPayload

options?​
from?​

string

Returns​

IQWhatsappMessageOptions<QWhatsAppMediaPayload>

image()​

image(to, payload, options?): IQWhatsappMessageOptions<QWhatsAppMediaPayload>

Creates an image message.

Parameters​

to​

string

payload​

QWhatsAppMediaPayload

options?​
from?​

string

Returns​

IQWhatsappMessageOptions<QWhatsAppMediaPayload>

location()​

location(to, payload, options?): IQWhatsappMessageOptions<QWhatsAppLocationPayload>

Creates a location message.

Parameters​

to​

string

payload​

QWhatsAppLocationPayload

options?​
from?​

string

Returns​

IQWhatsappMessageOptions<QWhatsAppLocationPayload>

reaction()​

reaction(to, payload, options?): IQWhatsappMessageOptions<QWhatsAppReactionPayload>

Creates a reaction message.

Parameters​

to​

string

payload​

QWhatsAppReactionPayload

options?​
from?​

string

Returns​

IQWhatsappMessageOptions<QWhatsAppReactionPayload>

sticker()​

sticker(to, payload, options?): IQWhatsappMessageOptions<QWhatsAppStickerPayload>

Creates a sticker message.

Parameters​

to​

string

payload​

QWhatsAppStickerPayload

options?​
from?​

string

Returns​

IQWhatsappMessageOptions<QWhatsAppStickerPayload>

template()​

template(to, payload, options?): IQWhatsappMessageOptions<QWhatsAppTemplatePayload>

Creates a template message.

Parameters​

to​

string

payload​

QWhatsAppTemplatePayload

options?​
from?​

string

Returns​

IQWhatsappMessageOptions<QWhatsAppTemplatePayload>

text()​

text(to, body, options?): IQWhatsappMessageOptions<QWhatsAppTextPayload>

Creates a text message.

Parameters​

to​

string

body​

string

options?​
from?​

string

previewUrl?​

boolean

Returns​

IQWhatsappMessageOptions<QWhatsAppTextPayload>

video()​

video(to, payload, options?): IQWhatsappMessageOptions<QWhatsAppMediaPayload>

Creates a video message.

Parameters​

to​

string

payload​

QWhatsAppMediaPayload

options?​
from?​

string

Returns​

IQWhatsappMessageOptions<QWhatsAppMediaPayload>