WhatsApp

Usage Instructions

Integrate WhatsApp into the workflow. Send messages, templates, media, locations, contacts, interactive messages. Manage read receipts, templates, and media uploads.

Tools

`whatsapp_send_message`

Input

Parameter	Type	Required	Description
`phoneNumber`	string	Yes	No description
`message`	string	Yes	No description
`phoneNumberId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	WhatsApp message send success status
`messageId`	string	Unique WhatsApp message identifier
`phoneNumber`	string	Recipient phone number
`status`	string	Message delivery status
`timestamp`	string	Message send timestamp

`whatsapp_send_template`

Input

Parameter	Type	Required	Description
`to`	string	Yes	No description
`templateName`	string	Yes	No description
`languageCode`	string	Yes	No description
`components`	json	No	No description
`phoneNumberId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Template message send success status
`messageId`	string	Unique WhatsApp message identifier
`status`	string	Message delivery status
`timestamp`	string	Message send timestamp

`whatsapp_send_media`

Input

Parameter	Type	Required	Description
`to`	string	Yes	No description
`mediaType`	string	Yes	No description
`mediaUrl`	string	No	No description
`mediaId`	string	No	No description
`caption`	string	No	No description
`filename`	string	No	No description
`phoneNumberId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Media message send success status
`messageId`	string	Unique WhatsApp message identifier
`status`	string	Message delivery status
`timestamp`	string	Message send timestamp

`whatsapp_send_location`

Input

Parameter	Type	Required	Description
`to`	string	Yes	No description
`latitude`	number	Yes	No description
`longitude`	number	Yes	No description
`name`	string	No	No description
`address`	string	No	No description
`phoneNumberId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Location message send success status
`messageId`	string	Unique WhatsApp message identifier
`status`	string	Message delivery status
`timestamp`	string	Message send timestamp

`whatsapp_send_contacts`

Input

Parameter	Type	Required	Description
`to`	string	Yes	No description
`contacts`	json	Yes	No description
`phoneNumberId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Contacts message send success status
`messageId`	string	Unique WhatsApp message identifier
`status`	string	Message delivery status
`timestamp`	string	Message send timestamp

`whatsapp_send_interactive`

Input

Parameter	Type	Required	Description
`to`	string	Yes	No description
`interactiveType`	string	Yes	No description
`body`	string	Yes	No description
`action`	json	Yes	No description
`header`	string	No	No description
`footer`	string	No	No description
`phoneNumberId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Interactive message send success status
`messageId`	string	Unique WhatsApp message identifier
`status`	string	Message delivery status
`timestamp`	string	Message send timestamp

`whatsapp_mark_as_read`

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	No description
`phoneNumberId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Mark as read success status
`messageId`	string	The ID of the message marked as read
`timestamp`	string	When the message was marked as read

`whatsapp_get_templates`

Input

Parameter	Type	Required	Description
`businessAccountId`	string	Yes	No description
`limit`	number	No	No description
`offset`	number	No	No description
`status`	string	No	No description
`language`	string	No	No description

Output

Parameter	Type	Description
`success`	boolean	Templates fetch success status
`templates`	json	Array of WhatsApp message templates
`paging`	json	Pagination cursors for next/previous pages
`total`	number	Total number of templates returned

`whatsapp_upload_media`

Input

Parameter	Type	Required	Description
`fileUrl`	string	Yes	No description
`mediaType`	string	No	No description
`phoneNumberId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Media upload success status
`mediaId`	string	Uploaded media ID for use in send_media
`mediaUrl`	string	URL of the uploaded media
`mimeType`	string	MIME type of the uploaded file
`fileSize`	number	File size in bytes
`sha256`	string	SHA-256 hash of the uploaded file

WhatsApp

On this page