📱 WhatsApp QR
🔽 POST /api/public/web-whatsapp-message/send/{phoneId}/message – Send a Web WhatsApp Message
POST /api/public/web-whatsapp-message/send/{phoneId}/message – Send a Web WhatsApp MessageSends 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
| Name | Type | Required | Description |
|---|---|---|---|
phoneId | string | ✅ | The ID of the phone sending the message via WhatsApp Web |
🔹 Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
message | string | ✅ | The content of the message you want to send |
stage | string | ❌ | Contextual tag for the message (e.g., "checkout") |
x-api-key | string | ✅ | Your API key for authenticating the request |
🔹 Body
| Name | Type | Required | Description |
|---|---|---|---|
phone | string | ✅ | The Phone Number you want to send the message to |
🔹 Example Request (cURL)
curl --request POST \
'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'Replace:
abc123with your actualphoneIdYOUR_API_KEYwith your real API keymessageandstageas 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
POST /api/public/ticket/open/web-whatsapp/{phoneId} – Open a New TicketCreates a ticket linked to a specific WhatsApp phone sender. Includes support for metadata, contact info, and message content.
Click to expand full details
🔹 URL
POST /api/public/ticket/open/web-whatsapp/{phoneId}🔹 Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
phoneId | string | ✅ | The phone ID used to send the WhatsApp message |
🔹 Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
contact_name | string | ❌ | Name of the contact |
to_phone_number | string | ✅ | WhatsApp number of the recipient |
contact_metadata | object | ❌ | Optional extra info about the contact |
ticket_metadata | object | ❌ | Optional structured data about the ticket |
email | string | ❌ | Email address linked to the ticket |
message | object | ❌ | Initial message content |
stage_id | string | ✅ | UUID of the pipeline stage where ticket starts |
🔹 Example Request
curl --request POST \
'https://iris-backend-production.up.railway.app/api/public/ticket/open/web-whatsapp/phone_123' \
--header 'Content-Type: application/json' \
--data-raw '{
}
'🔹 Success Response
🟢 200 Ticket created successfully
Updated 10 days ago