Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vambe.me/llms.txt

Use this file to discover all available pages before exploring further.

​
🔽 POST /api/public/web-whatsapp-message/send/{phoneId}/message – Send a Web WhatsApp Message

Sends a message from a connected WhatsApp Web session using the specified phoneId. Click to expand full details

​
🔹 URL

POST /api/public/web-whatsapp-message/send/{phoneId}/message

​
🔹 Path Parameters

NameTypeRequiredDescription
phoneIdstring✅The ID of the phone sending the message via WhatsApp Web

​
🔹 Query Parameters

NameTypeRequiredDescription
messagestring✅The content of the message you want to send
stagestring❌Contextual tag for the message (e.g., "checkout")
x-api-keystring✅Your API key for authenticating the request

​
🔹 Body

NameTypeRequiredDescription
phonestring✅The Phone Number you want to send the message to

​
🔹 Example Request (cURL)

'https://iris-backend-production.up.railway.app/api/public/web-whatsapp-message/send/abc123/message?message=Hello%20world&stage=welcome'
\ --header 'x-api-key: YOUR_API_KEY' \ --header 'content-type:
application/json' ```
</CodeGroup>

Replace:

- `abc123` with your actual `phoneId`
- `YOUR_API_KEY` with your real API key
- `message` and `stage` as needed

---

### 🔹 Notes

- The phone must be connected and authenticated via WhatsApp Web.
- This endpoint is useful for real-time messages triggered by events on your own platform
- Avoid excessive usage to prevent rate-limiting.

---

## 🔽 `POST /api/public/ticket/open/web-whatsapp/{phoneId}` – Open a New Ticket

Creates a ticket linked to a specific WhatsApp phone sender. Includes support for metadata, contact info, and message content.

Click to expand full details

### 🔹 URL

​
🔹 Success Response

🟢 200 Ticket created successfully
🔐 API Key 💻 WhatsApp API Ask AI