whatsapp-api-js - v5.2.0
messages
Module messages
Description
A collection of classes to construct WhatsApp API messages.
There are 7 types of messages:
Text
Media
Template
Interactive
Location
Contacts
Reaction
Contacts
Address
Birthday
Contacts
Email
Name
Organization
Phone
Url
BuiltContact
Globals
CatalogProduct
Product
ProductSection
Interactive
ActionButtons
ActionCatalog
ActionCTA
ActionDataExchangeFlow
ActionFlow
ActionList
ActionLocation
ActionNavigateFlow
ActionProduct
ActionProductList
Body
Button
Footer
Header
Interactive
ListSection
Row
Location
Location
Media
Audio
Document
Image
Media
Sticker
Video
Reaction
Reaction
Template
BodyComponent
BodyParameter
ButtonComponent
CarouselCard
CarouselComponent
CatalogComponent
CopyComponent
Currency
DateTime
FlowComponent
HeaderComponent
HeaderParameter
Language
LTOComponent
MPMComponent
PayloadComponent
SkipButtonComponent
Template
URLComponent
ButtonParameter
Text
Text
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Contacts
Address
Birthday
Contacts
Email
Name
Organization
Phone
Url
Built
Contact
Globals
Catalog
Product
Product
Product
Section
Interactive
Action
Buttons
Action
Catalog
ActionCTA
Action
Data
Exchange
Flow
Action
Flow
Action
List
Action
Location
Action
Navigate
Flow
Action
Product
Action
Product
List
Body
Button
Footer
Header
Interactive
List
Section
Row
Location
Location
Media
Audio
Document
Image
Media
Sticker
Video
Reaction
Reaction
Template
Body
Component
Body
Parameter
Button
Component
Carousel
Card
Carousel
Component
Catalog
Component
Copy
Component
Currency
Date
Time
Flow
Component
Header
Component
Header
Parameter
Language
LTOComponent
MPMComponent
Payload
Component
Skip
Button
Component
Template
URLComponent
Button
Parameter
Text
Text
whatsapp-api-js - v5.2.0
emitters
OnMessage
OnMessageArgs
OnSent
OnSentArgs
OnStatus
OnStatusArgs
errors
WhatsAppAPIError
WhatsAppAPIFailedToVerifyError
WhatsAppAPIFailedToVerifyTokenError
WhatsAppAPIMissingAppSecretError
WhatsAppAPIMissingCryptoSubtleError
WhatsAppAPIMissingRawBodyError
WhatsAppAPIMissingSearchParamsError
WhatsAppAPIMissingSignatureError
WhatsAppAPIMissingVerifyTokenError
WhatsAppAPIUnexpectedError
messages
ActionButtons
ActionCatalog
ActionCTA
ActionDataExchangeFlow
ActionFlow
ActionList
ActionLocation
ActionNavigateFlow
ActionProduct
ActionProductList
Address
Audio
Birthday
Body
BodyComponent
BodyParameter
Button
ButtonComponent
CarouselCard
CarouselComponent
CatalogComponent
CatalogProduct
Contacts
CopyComponent
Currency
DateTime
Document
Email
FlowComponent
Footer
Header
HeaderComponent
HeaderParameter
Image
Interactive
Language
ListSection
Location
LTOComponent
Media
MPMComponent
Name
Organization
PayloadComponent
Phone
Product
ProductSection
Reaction
Row
SkipButtonComponent
Sticker
Template
Text
Url
URLComponent
Video
BuiltContact
ButtonParameter
middleware
AdonisMiddleware
BunMiddleware
DenoMiddleware
ExpressMiddleware
NextAppMiddleware
NodeHTTPMiddleware
SvelteKitMiddleware
VercelMiddleware
WebStandardMiddleware
WhatsAppAPIMiddleware
setup
Bun
Deno
Node15
Node18
NodeNext
Web
types
ClientLimitedMessageComponent
ClientMessage
ContactComponent
ContactMultipleComponent
ContactUniqueComponent
Section
ClientBuildableMessageComponent
ClientTypedMessageComponent
InteractiveAction
TemplateComponent
ClientMessageNames
ClientMessageRequest
ExtraTypesThatMakeTypescriptWork
GetParams
NoServerError
PostData
SecureLightSwitch
ServerAudioMessage
ServerBlockedError
ServerBlockedUser
ServerBlockFailedUser
ServerBlockResponse
ServerButtonMessage
ServerContacts
ServerContactsMessage
ServerConversation
ServerCreateQRResponse
ServerDeleteQRResponse
ServerDocumentMessage
ServerError
ServerErrorResponse
ServerImageMessage
ServerInitiation
ServerInteractiveMessage
ServerLocationMessage
ServerMarkAsReadResponse
ServerMedia
ServerMediaDeleteResponse
ServerMediaRetrieveResponse
ServerMediaUploadResponse
ServerMessage
ServerMessageResponse
ServerMessageTypes
ServerOrderMessage
ServerPricing
ServerQR
ServerReactionMessage
ServerRequestWelcomeMessage
ServerRetrieveQRResponse
ServerSentMessageResponse
ServerStatus
ServerStickerMessage
ServerSuccessResponse
ServerSystemMessage
ServerTextMessage
ServerUnblockResponse
ServerUnknownMessage
ServerUpdateQRResponse
ServerVideoMessage
TheBasicConstructorArguments
ValidMimeTypes
WhatsAppAPIConstructorArguments
DEFAULT_API_VERSION
utils
AtLeastOne
MaybePromise
XOR
escapeUnicode
WhatsAppAPI
WhatsAppAPI
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R
Description
A collection of classes to construct WhatsApp API messages.
There are 7 types of messages: