Whatsapp Messages
Core messaging endpoints. Initiate chats, send messages, templates, and reactions.
Endpoints
| Method | Route | Auth | Description |
|---|---|---|---|
| POST | /api/v1/WhatsappMessage/addgroup | Start a new conversation thread with a contact | |
| POST | /api/v1/WhatsappMessage/groups | Retrieve your active conversation threads | |
| GET | /api/v1/WhatsappMessage/group/{id} | Look up the details of a specific conversation | |
| POST | /api/v1/WhatsappMessage/messages | Retrieve the message history for a conversation | |
| GET | /api/v1/WhatsappMessage/message/{id} | Look up the details of a specific message | |
| POST | /api/v1/WhatsappMessage/sendtemplatemessage | Send an approved template to an existing conversation | |
| POST | /api/v1/WhatsappMessage/sendtemplatebulk | Send a template to multiple contacts at once | |
| POST | /api/v1/WhatsappMessage/sendcustommessage | Send a custom text or media message to a conversation |
POST
/api/v1/WhatsappMessage/sendtemplatemessage
JSON Request
{
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"templateId": "53f191b7-9577-4406-81da-45e0f7690f70",
"phone": "9876543210",
"jsonPayload": "{\"type\":\"text\",\"text\":\"Welcome\"}"
}Payload Details
| Field | Type | Description |
|---|---|---|
groupId | UUID | The unique ID of the active conversation thread where this interaction will be logged. |
templateId | UUID | The unique identifier of the pre-approved Meta WhatsApp template to be sent. |
phone | String | The recipient's WhatsApp phone number (must include the country code). Used by Meta to deliver the template. |
jsonPayload | String | A serialized JSON string containing any dynamic variables, header media parameters, or interactive button parameters required by the specific template structure. |
JSON Response
{
"isSuccess": true,
"data": {
"id": "e43b1740-4221-432d-9872-872f2d937000",
"status": "Sent",
"timestamp": "2026-05-28T10:00:00Z"
}
}POST
/api/v1/WhatsappMessage/sendcustommessage
JSON Request
{
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"bodyText": "Hello! How can we help you today?",
"replyId": null,
"phone": "9876543210",
"phoneCC": "91",
"fileId": null
}Payload Details
| Field | Type | Description |
|---|---|---|
groupId | UUID | The unique ID of the active conversation thread where this custom message will be recorded. |
bodyText | String | The actual text content of the message you want to send to the recipient. |
replyId | UUID? | (Optional) If this message is a direct contextual reply to a previous message, provide the original message's UUID here. |
phone | String | The recipient's local WhatsApp phone number without the country code. |
phoneCC | String | The country code for the recipient's phone number (defaults to "91"). Combined with the phone number for delivery. |
fileId | UUID? | (Optional) The unique ID of an uploaded media file (image, document, audio) to send as an attachment alongside the text. |
JSON Response
{
"isSuccess": true,
"data": {
"id": "c194a28f-1248-4392-8000-092f248fa000",
"status": "Sent",
"timestamp": "2026-05-28T10:05:00Z"
}
}POST
/api/v1/WhatsappMessage/sendtemplatebulk
JSON Request
{
"contactIds": [
"3f9b2c3a-8d19-4a37-b312-d92fa1f78e01",
"1a2b3c4d-5e6f-7a8b-9c0d-e1f2a3b4c5d6"
],
"templateId": "53f191b7-9577-4406-81da-45e0f7690f70"
}JSON Response
{
"isSuccess": true,
"data": true
}