Page cover

Whapi.Cloud WhatsApp Integration

Easily send and receive WhatsApp messages, media, and group interactions using the Whapi.Cloud Mini App integrated with Rapidbott. This guide explains setup, API token configuration, and the details of each supported action.


🚀 Overview

The Whapi.Cloud Mini App enables:

  • Retrieve WhatsApp Group IDs

  • Fetch WhatsApp message info & metadata

  • Send messages with Call/Link buttons

  • Send/Reply media in groups

  • Send/Reply text in groups

  • Send/Reply media to a user’s phone

  • Send/Reply text to a user’s phone

All actions are securely processed via Whapi.Cloud and can be automated in Rapidbott flows.


🔧 Installation Instructions

  1. Login to your Rapidbott workspace.

  2. Navigate to Mini Apps in the sidebar.

  3. Click Install Mini App.

  4. Select Whapi.Cloud Integration.

  5. Enter your Whapi.Cloud API Token when prompted.

  6. Save and you’re ready to use the actions.


🔑 Requirements

  • Active Whapi.Cloud account

  • WhatsApp phone number linked to Whapi.Cloud

  • Generated API Token


🔐 API Token Configuration

  1. Go to your Whapi.Cloud Dashboard.

  2. Generate an API Token for your WhatsApp number.

  3. Copy the token and paste it into the Rapidbott Mini App setup.


📌 Available Actions & Fields

1. Action: Find WhatsApp Group ID

Purpose Retrieve the unique ID of any WhatsApp group linked to your Whapi.Cloud number. This ID is needed to send messages, media, or replies to a group.


How it works (screenshot reference):

  1. Select a group from the dropdown list of all groups linked to your Whapi cloud WhatsApp number.

  2. The system fetches the Group ID automatically.

  3. Optionally, map the Group ID to a custom field for re-use in later actions.


🔹 Inputs

Field
Description
Required
Example

Select Group

Dropdown showing all groups linked to your WhatsApp number.

✅ Required

“Rapidbott Community”


🔹 Outputs

Field
Description
Example

Group ID

Unique ID of the WhatsApp group (ends with @g.us).

Group Name

Human-readable name of the group.

“Rapidbott Community”

Participants

List of members in the group (if available).

[919544694583, 919812345678]

Last Message

Metadata of the most recent message.

{ id, type, from, timestamp, text }


Notes

  • Always save Group ID in a custom field or variable to use it later.

  • If the group doesn’t appear, confirm your WhatsApp number is a member of that group.

  • Group IDs always end with @g.us.


2. Action: Retrieve WhatsApp Message Info

Purpose Fetch metadata for a specific WhatsApp Message ID. Useful to know what type of message was sent (text, image, doc, etc.), who sent it, and to extract captions.


How it works (screenshot reference):

  1. Enter the Message ID (from webhook or Get Messages response).

  2. Map desired outputs (e.g., Sender Phone, Media Caption) to Custom Fields.

  3. Use the mapped data in later steps to reply or trigger automations.


🔹 Inputs

Field
Description
Required
Example

Message ID

Unique identifier of the WhatsApp message.

✅ Required

XyZ123abcDEF_9-KLmNopQRsTUWV


🔹 Outputs

Field
Description
Example

Message Type

Type of message: text, image, video, doc, audio, etc.

image

User/Group Name

Display name of sender or group name.

“Rapidbott Demo”

WhatsApp Message

The actual message text (if type = text).

“Hello team!”

Sender Name

WhatsApp profile name of sender.

“Vajan Saju”

Sender Phone

Sender’s number (with country code, no “+”).

919544694583

Quoted Message ID

ID of the message being replied to.

ABC123xyz

Timestamp

When the message was sent (Unix).

1724148000

Doc File Name

File name if message type = document.

invoice.pdf

Media Caption

Caption if message contains media.

“Please check this file.”

Whapi Output

Full raw JSON payload from Whapi.Cloud.

{...}


Notes

  • Always map Sender Phone if you plan to reply directly.

  • Use Media Caption consistently for all media messages.

  • Convert Timestamp to readable date/time using a processor if needed.

  • Great for conditional flows: e.g., “If Message Type = Image, then…”.


✅ Now you have all three actions (Find Group ID, Retrieve Message Info, Send Call/Link Buttons) in the same polished format.


Purpose Send a WhatsApp message with up to two CTA buttons:

  • Call Now → opens the phone dialer.

  • Website Link → opens a website in the browser.

This makes messages more interactive and actionable.


How it works (screenshot reference):

  1. Add optional Header Text (short title).

  2. Write your Message Body (required).

  3. Add optional Footer Text (notes, disclaimers).

  4. Configure one or both CTA buttons:

    • Call Now Button → enter phone number with country code.

    • Website Link Button → enter full URL.

  5. Enter the Recipient Phone or Group ID to send the message.

  6. Optionally map WhAPI Data and Message Status into custom fields for later use.


🔹 Inputs

Field
Description
Required
Example

Header Text

Appears above the message body. Keep short (≤ 60 chars).

Optional

“Support Team”

Message Body

Main text content (≤ 1000 chars).

✅ Required

“Need help? Reach us instantly.”

Footer Text

Appears below the message body (≤ 60 chars).

Optional

“Available Mon–Fri, 9AM–6PM”

Call Now Button

Phone number with country code (no “+”). Creates a dial button.

Optional

919876543210

Website Link Button

Full URL. Creates a link button.

Optional

https://rapidbott.com

Recipient Phone or Group ID

Target chat. Phone = digits with country code. Group = ends with @g.us.

✅ Required

919544694583 or [email protected]


🔹 Outputs

Field
Description
Example

WhAPI Data

Raw JSON response from Whapi.Cloud.

{...}

Message Status

Status of the message (sent/delivered/failed).

sent


Notes

  • If both Call Now and Website Link are empty, the action will fail.

  • Use short button titles so WhatsApp UI displays them cleanly.

  • Test with your own WhatsApp number before sending to live users.

  • For groups, always use the full Group ID (from Find WhatsApp Group ID).


✅ Example Setup:

  • Header → Support Team

  • Message Body → Need help? You can reach us right away.

  • Call Button → 919544694583

  • Link Button → https://rapidbott.com

  • Recipient → 919876543210

Result in WhatsApp: User receives a message with two interactive buttons: Call Us and Visit Website.


4. Action: Send/Reply Media in WhatsApp Group

Purpose Send or reply with a media file (image, video, audio, or document) in a WhatsApp group. You can also add a caption, set dimensions, or make media viewable only once.


How it works (screenshot reference):

  1. Choose your Media Type (image, video, audio, document).

  2. Select the Group from the dropdown (or provide Group ID).

  3. (Optional) Add a Quoted Msg ID if you want to reply to a specific message.

  4. Paste the Media File URL (must be public).

  5. (Optional) Add a Caption, dimensions (Width/Height), or file name.

  6. Select View Once if you want the file to disappear after being viewed once.

  7. (Optional) Use DM Sender from Group → “Yes” will DM the user privately instead of replying in the group (only works with Quoted Msg ID).

  8. Save, and map outputs (Message Status, WhAPI Output) to fields if needed.


🔹 Inputs

Field
Description
Required
Example

Select Media Type

Type of media to send (image, video, audio, doc).

✅ Required

image

Select Group

WhatsApp group where the media will be sent.

✅ Required

“Rapidbott Community”

Quoted Msg ID

Message ID to reply to (for threading).

Optional

A3C74B...

Media File

Public URL to the media file.

✅ Required

https://cdn.example.com/file.jpg

Caption

Text shown below the media.

Optional

“Here’s the product photo.”

Width

Pixel width (for images/videos).

Optional

800

Height

Pixel height (for images/videos).

Optional

600

View Once

Choose if media should only be viewable once.

✅ Required

Yes or No

File Name

File name (only for docs).

Optional

invoice.pdf

DM Sender from Group

Choose “Yes” to DM the sender privately instead of replying in the group (only works with Quoted Msg ID).

Optional

Yes


🔹 Outputs

Field
Description
Example

Message Status

Status of the media message (sent, delivered, failed).

sent

WhAPI Output

Full raw response from Whapi.Cloud.

{...}


Notes

  • Media File URL must be public (e.g., hosted on CDN, S3, or Whapi file upload).

  • Use Caption instead of creating separate caption fields for different media types.

  • View Once is best for sensitive images/videos (e.g., OTP screenshots).

  • If DM Sender from Group = Yes, the reply goes privately to the sender (instead of inside the group).

  • Always map Message Status to track delivery success/failure.


✅ Example Setup:

  • Media Type → image

  • Group → Rapidbott Demo

  • Media File → https://cdn.mysite.com/product1.jpg

  • Caption → “New stock available!”

  • View Once → No

Result in WhatsApp: The selected group receives the image with the caption below it.


5. Action: Send/Reply Text Messages in WhatsApp Group

Purpose Send or reply with a text message inside a WhatsApp group. Supports plain text, emojis, and URLs. You can also simulate typing delays, reply to a specific message (threaded), or choose to DM the sender privately instead of posting in the group.


How it works (screenshot reference):

  1. Choose the Group from the dropdown list.

  2. (Optional) Add a Typing Delay/Time (in seconds) to make the interaction feel more natural.

  3. (Optional) Add a Quoted Msg ID if you want to reply directly to a specific message.

  4. Enter the WA Message Body (your text).

  5. (Optional) Select DM Sender from Group → Yes to send a private message to the user instead of replying in the group (works only if Quoted Msg ID is provided).

  6. Optionally map Message Status and WhAPI Output to custom fields for tracking.


🔹 Inputs

Field
Description
Required
Example

Select Group

Group where the message will be sent.

✅ Required

“Rapidbott Demo”

Typing Delay/Time

Delay before sending (in seconds). Simulates human typing.

Optional

3

Quoted Msg ID

Message ID to reply to (threaded reply).

Optional

A3C74B...

WA Message Body

The text message content. Supports text, emojis, URLs.

✅ Required

“Welcome to the group 🚀”

DM Sender from Group

Choose “Yes” to DM the user privately instead of replying in the group (requires Quoted Msg ID).

Optional

Yes


🔹 Outputs

Field
Description
Example

Message Status

Status of the sent message (sent, delivered, failed).

sent

WhAPI Output

Full raw response from Whapi.Cloud.

{...}


Notes

  • Always use Quoted Msg ID when you want to reply inline (threaded).

  • Typing Delay/Time helps make bot replies feel human-like (e.g., add a 2–3 second delay).

  • DM Sender from Group = Yes works only when you provide a Quoted Msg ID. Without it, the system won’t know who to DM.

  • Message body supports line breaks and emojis; they will render correctly in WhatsApp.


✅ Example Setup:

  • Group → Rapidbott Community

  • Typing Delay → 2

  • Message Body → “Thanks for sharing! We’ll get back to you shortly 🙂”

  • Quoted Msg ID → XYZ123abc

Result in WhatsApp:

  • Group receives a threaded text reply OR

  • If DM Sender = Yes, the sender gets a private DM with the same message.


6. Action: Send/Reply WhatsApp Media to Recipient’s Phone

Purpose Send or reply with media messages (image, video, audio, or document) directly to a user’s WhatsApp number. You can include captions, set media dimensions, and even enable View Once for sensitive files.


How it works (screenshot reference):

  1. Select the Media Type (image, video, audio, document).

  2. Enter the Recipient WhatsApp Number (country code + number, no “+”).

  3. (Optional) Add a Quoted Msg ID if you want to reply to a specific message.

  4. (Optional) Set Width/Height for images/videos.

  5. Choose View Once if the media should disappear after being viewed once.

  6. Paste the Media File URL (must be public).

  7. (Optional) Add a Caption or File Name (for docs).

  8. Map outputs like Message Status or WhAPI Output if you want to track results.


🔹 Inputs

Field
Description
Required
Example

Select Media Type

Choose type: image, video, audio, document.

✅ Required

image

Recipient WhatsApp Number

Full phone number with country code (no “+”).

✅ Required

919544694583

Quoted Msg ID

Reply to a specific message.

Optional

A3C74B...

Width

Width in pixels (for images/videos).

Optional

800

Height

Height in pixels (for images/videos).

Optional

600

View Once

Whether media should be viewable only once.

✅ Required

Yes or No

Media File

Direct public URL to the media file.

✅ Required

https://cdn.example.com/file.jpg

Caption

Text shown below the media.

Optional

“Here’s the brochure.”

File Name

File name for docs (include extension).

Optional

report.pdf


🔹 Outputs

Field
Description
Example

Message Status

Status of the media message (sent, delivered, failed).

sent

WhAPI Output

Full JSON response from Whapi.Cloud.

{...}


Notes

  • The Media File URL must be public and accessible; otherwise the send will fail.

  • Recipient Number must include the country code, but no “+” sign. Example: 919876543210.

  • View Once is ideal for sensitive content (e.g., tickets, passwords, private files).

  • Always test with your own number first to confirm formatting.

  • For documents, always specify File Name (with extension like .pdf, .docx).


✅ Example Setup:

  • Media Type → document

  • Recipient → 919876543210

  • Media File → https://cdn.mysite.com/invoice123.pdf

  • File Name → invoice123.pdf

  • Caption → “Here’s your invoice.”

  • View Once → No

Result in WhatsApp: The recipient receives a PDF document with the caption “Here’s your invoice.”


7. Action: Send/Reply WhatsApp Text to Recipient’s Phone

Purpose Send or reply with a plain text message directly to any WhatsApp user’s phone. Supports emojis, line breaks, and URLs. You can also simulate typing delay or reply inline using a Quoted Message ID.


How it works (screenshot reference):

  1. (Optional) Add Typing Delay/Time (in seconds) to simulate a human typing pause.

  2. (Optional) Add a Quoted Msg ID if replying to a specific message.

  3. Enter the WA Message Body (text content).

  4. Enter the Recipient Phone (country code + number, no “+”).

  5. Optionally map Message Status and WhAPI Output for tracking.


🔹 Inputs

Field
Description
Required
Example

Typing Delay/Time

Delay before sending (in seconds). Makes replies feel natural.

Optional

2

Quoted Msg ID

Message ID to reply to (for context).

Optional

A3C74B...

WA Message Body

The text to send (supports plain text, emojis, URLs).

✅ Required

“Hi 👋 thanks for contacting us!”

Recipient Phone

Full phone number with country code (no “+”).

✅ Required

919876543210


🔹 Outputs

Field
Description
Example

Message Status

Status of the sent message (sent, delivered, failed).

sent

WhAPI Output

Full JSON response from Whapi.Cloud.

{...}


Notes

  • Recipient Phone must include the country code, digits only (no plus sign).

  • Quoted Msg ID is useful when replying contextually in a group/private thread.

  • Supports emojis 👍 and line breaks (\n).

  • Best for notifications, OTPs, reminders, and private follow-ups.


✅ Example Setup:

  • Typing Delay → 3

  • WA Message Body → “Hello! Your order #12345 has been shipped 🚚📦”

  • Recipient Phone → 919544694583

Result in WhatsApp: The user receives a text message with a small simulated typing delay, making the bot feel more human-like.


📋 Field Summary

  • recipient_phone – Digits only, with country code.

  • group_id – WhatsApp Group ID (…@g.us).

  • chat_id – Generic target (phone or group).

  • message_text – Message body.

  • caption_text – Caption for media.

  • file_url – Public URL of file.

  • file_name – Optional, for documents.

  • mime_type – e.g., application/pdf, image/jpeg.

  • quoted_msg_id – ID of the message being replied to.


✅ Example Use Cases for Whapi.Cloud Integration

1) Find WhatsApp Group ID

  • Onboarding new members: When a user signs up, automatically add them to the right WhatsApp group and store the group ID for future broadcasts.

  • Support groups: Identify the group ID for “VIP Customers” and send them priority updates.


2) Retrieve WhatsApp Message Info

  • Customer intent detection: If a customer sends a photo with the caption “Invoice issue”, the system detects media + caption and routes it to billing support.

  • Smart replies: Differentiate between text vs. image. If text → send auto-answer; if image → forward to human agent.

  • Data collection: Extract Sender Phone to save the lead automatically into CRM.


  • Customer support shortcut: Send a message with two buttons → “📞 Call Support” and “🌐 Visit Help Center”.

  • Sales promotion: Share a new product announcement with a Buy Now website link and a Call Us button.

  • Event reminders: “Your webinar starts soon. Click to join 👉 [Join Link]”


4) Send/Reply Media in WhatsApp Group

  • Announcements: Share images or flyers in a staff or student group.

  • E-commerce promotions: Send product catalogs (PDFs or images) to customer groups.

  • Education: Teachers send study materials (PDFs, videos) to class groups.

  • Replies with context: Quote a student’s question and reply with a reference image or doc.


5) Send/Reply Text Messages in WhatsApp Group

  • Community management: Auto-greet new members with “Welcome to Rapidbott Community 🚀”.

  • Support automation: If someone posts “How to reset password?” → bot replies with instructions.

  • Feedback collection: Post “How was today’s session? Reply below 👇”


6) Send/Reply WhatsApp Media to Recipient’s Phone

  • Order confirmation: Send a PDF invoice or product image directly to the buyer’s WhatsApp.

  • Travel booking: Share flight tickets or hotel booking PDFs.

  • Healthcare: Send prescriptions, lab results, or reports securely with View Once enabled.

  • E-learning: Deliver personalized lesson videos/documents to each student.


7) Send/Reply WhatsApp Text to Recipient’s Phone

  • Notifications: “Hi John, your order #12345 has been shipped 🚚📦”

  • Reminders: “Your appointment is tomorrow at 10 AM.”

  • Marketing campaigns: Personalized coupon codes → “Hi Sarah, use code SAVE20 for 20% off.”

  • Follow-ups: After a group discussion, DM the user with next steps or links.


🎯 Why this Integration is Useful for Businesses

  • One-to-one + group automation → You can handle both personal chats and group conversations in a single integration.

  • Rich interactions → Not just text; you can send media, documents, and CTAs (call & link buttons).

  • Personalization at scale → Reply privately (DM) to users in groups, making customer engagement feel 1:1 even inside busy groups.

  • Operational efficiency → Automatically fetch message info, detect type, and route to correct workflows (support, sales, CRM).

  • Security options → View-once media ensures sensitive files (e.g., invoices, prescriptions) disappear after opening.


👉 In short, this integration allows a business to automate 80% of repetitive WhatsApp tasks — sending updates, answering FAQs, delivering files — while keeping the option to escalate to a human when needed.


📝 Notes

  • Remove “+” from phone numbers. Use digits only.

  • Store IDs (group_id, chat_id) in variables for reuse.

  • Always log sent_message_id for debugging.

  • Ensure media URLs are public.


☑️ Final Checklist

Last updated

Was this helpful?