{ "info": { "name": "WAAPI — Vendor External API", "_postman_id": "00000000-0000-4000-8000-waapi-external", "description": "Public WAAPI WhatsApp API surface. Authenticated with X-API-Key + X-API-Secret. Set the collection variables baseUrl / apiKey / apiSecret before running.\n\nGenerated from the same source as the public /docs page so the two cannot drift.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://betazen.vendor.waapi.easycrm4u.com/api/v1/external", "type": "string" }, { "key": "apiKey", "value": "waapi_REPLACE_ME", "type": "string" }, { "key": "apiSecret", "value": "secr_REPLACE_ME", "type": "string" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "item": [ { "name": "WhatsApp Cloud API — Send Messages (/whatsapp-api)", "description": "WhatsApp Cloud API. Template, interactive, text, media, and the combined send+upsert endpoint. Pick the sending number with fromPhoneNo.", "item": [ { "name": "1. Send Template Message", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/whatsapp-api/messages/template", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-api", "messages", "template" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"917890000198\",\n \"fromPhoneNo\": \"+917890000199\",\n \"name\": \"order_shipped\",\n \"language\": \"en\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Sayantan\"\n },\n {\n \"type\": \"text\",\n \"text\": \"AWB-12345\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Send an approved WhatsApp template by name. The template must be APPROVED in Meta Business Manager. Pass parameters using the Meta-shaped `components` array.\n\nPermissions: messages.send" }, "response": [] }, { "name": "2. Send Interactive Message (Buttons)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/whatsapp-api/messages/buttons", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-api", "messages", "buttons" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"917890000198\",\n \"fromPhoneNo\": \"+917890000199\",\n \"headerText\": \"Order #1234\",\n \"bodyText\": \"Your order is ready. What would you like to do?\",\n \"footerText\": \"WAAPI demo\",\n \"buttons\": [\n {\n \"id\": \"track\",\n \"title\": \"Track\"\n },\n {\n \"id\": \"cancel\",\n \"title\": \"Cancel\"\n },\n {\n \"id\": \"support\",\n \"title\": \"Talk to support\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Send a quick-reply button message — up to 3 buttons. Customer taps a button → you receive a button_reply webhook with the button id you assigned.\n\nPermissions: messages.send" }, "response": [] }, { "name": "3a. Send Text Message", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/whatsapp-api/messages/text", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-api", "messages", "text" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"917890000198\",\n \"fromPhoneNo\": \"+917890000199\",\n \"body\": \"Hello from the WAAPI public API.\",\n \"previewUrl\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Send a plain text message. Outside the 24-hour customer service window only TEMPLATES are allowed; this endpoint will error there.\n\nPermissions: messages.send" }, "response": [] }, { "name": "3b. Send Image", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/whatsapp-api/messages/image", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-api", "messages", "image" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"917890000198\",\n \"fromPhoneNo\": \"+917890000199\",\n \"link\": \"https://example.com/order.jpg\",\n \"caption\": \"Your order, packed\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Send an image by public URL (`link`) or by a previously uploaded Meta media id (`mediaId`). One of the two is required.\n\nPermissions: messages.send" }, "response": [] }, { "name": "3c. Send Document", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/whatsapp-api/messages/document", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-api", "messages", "document" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"917890000198\",\n \"fromPhoneNo\": \"+917890000199\",\n \"link\": \"https://example.com/invoice-1234.pdf\",\n \"filename\": \"Invoice 1234.pdf\",\n \"caption\": \"Your invoice\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Send any document file (PDF, DOCX, XLSX, CSV, etc.) up to 100 MB. The filename you pass is what the recipient sees in WhatsApp.\n\nPermissions: messages.send" }, "response": [] }, { "name": "5. Send Message + Update Contact (combined)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/whatsapp-api/messages/send", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-api", "messages", "send" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"917890000198\",\n \"fromPhoneNo\": \"+917890000199\",\n \"contact\": {\n \"first_name\": \"Sayantan\",\n \"email\": \"sayantan@example.com\",\n \"tags\": [\n \"new-lead\"\n ]\n },\n \"type\": \"text\",\n \"payload\": {\n \"body\": \"Hi Sayantan, thanks for signing up. Your account is now active.\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Flagship endpoint: atomically upserts the contact AND dispatches ANY supported message type in one request. Saves a network round trip for CRM-style flows.\n\nPermissions: messages.send, contacts.write" }, "response": [] } ] }, { "name": "WhatsApp QR — Send Messages (/whatsapp-qr)", "description": "Send via a connected WhatsApp QR session. Requires a key with the WhatsApp QR service enabled.", "item": [ { "name": "QR · Send Text", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/whatsapp-qr/messages/text", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-qr", "messages", "text" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"917890000198\",\n \"fromPhoneNo\": \"+917890000199\",\n \"body\": \"Hello from a WAAPI QR session.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Send a plain text message from a connected WhatsApp QR session. Requires a key with the WhatsApp QR service enabled. No 24-hour customer-service-window restriction applies.\n\nPermissions: messages.send" }, "response": [] }, { "name": "QR · Send Image", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/whatsapp-qr/messages/image", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-qr", "messages", "image" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"917890000198\",\n \"fromPhoneNo\": \"+917890000199\",\n \"link\": \"https://example.com/order.jpg\",\n \"caption\": \"Your order\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Send an image from a connected QR session by public URL.\n\nPermissions: messages.send" }, "response": [] }, { "name": "QR · List Sessions", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" } ], "url": { "raw": "{{baseUrl}}/whatsapp-qr/sessions", "host": [ "{{baseUrl}}" ], "path": [ "whatsapp-qr", "sessions" ] }, "description": "List the vendor's connected QR sessions so you can discover the numbers you can send from.\n\nPermissions: messages.read" }, "response": [] } ] }, { "name": "Contacts", "description": "Update existing contacts. POST /contacts upserts; PATCH /contacts only mutates the fields you pass.", "item": [ { "name": "4. Update Contact", "request": { "method": "PATCH", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ] }, "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"917890000198\",\n \"countryCode\": \"+91\",\n \"updates\": {\n \"first_name\": \"Sayantan\",\n \"last_name\": \"Kar\",\n \"tags\": [\n \"vip\",\n \"crm-sync\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Partial update keyed by phone number. Only the fields you include in `updates` are written — every other field is untouched. Use this for CRM-driven name/email/tag sync without risking data loss.\n\nPermissions: contacts.write" }, "response": [] } ] }, { "name": "Authentication", "description": "Health check that verifies your X-API-Key + X-API-Secret are valid.", "item": [ { "name": "Authentication", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" } ], "url": { "raw": "{{baseUrl}}/ping", "host": [ "{{baseUrl}}" ], "path": [ "ping" ] }, "description": "Every request must carry both the X-API-Key header AND the X-API-Secret header. A key is bound to one or more of your WhatsApp numbers; every send must name which one to use via `fromPhoneNo` (E.164), alongside the recipient `to`. The ping endpoint echoes back your vendor id and the name of the key you authenticated with.\n\nPermissions: none" }, "response": [] } ] }, { "name": "Webhook Examples", "description": "These are NOT requests you make to WAAPI — they document the EXACT JSON payloads Meta sends to your webhook URL when you receive a message or status update. Inspect, fork, and replay against your own server.", "item": [ { "name": "Incoming Text Message", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}{your-callback-url}", "host": [ "{{baseUrl}}" ], "path": [ "{your-callback-url}" ] }, "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"959648497055756\",\n \"changes\": [\n {\n \"field\": \"messages\",\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"+91 78900 00199\",\n \"phone_number_id\": \"1226212787235581\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Sayantan Kar\"\n },\n \"wa_id\": \"917890000198\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"917890000198\",\n \"id\": \"wamid.HBgMOTE4NTk3NDA2Njk0FQIAEhgUM0EwMzQy...\",\n \"timestamp\": \"1718635789\",\n \"text\": {\n \"body\": \"Hi, is the order shipped?\"\n },\n \"type\": \"text\"\n }\n ]\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Delivered when a customer sends you a text message. Acknowledge with HTTP 200 within 5 seconds (Meta retries with exponential backoff if you don't).\n\nPermissions: none" }, "response": [] }, { "name": "Incoming Image (with caption)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}{your-callback-url}", "host": [ "{{baseUrl}}" ], "path": [ "{your-callback-url}" ] }, "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"959648497055756\",\n \"changes\": [\n {\n \"field\": \"messages\",\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"+91 78900 00199\",\n \"phone_number_id\": \"1226212787235581\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Sayantan Kar\"\n },\n \"wa_id\": \"917890000198\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"917890000198\",\n \"id\": \"wamid.HBgMO...\",\n \"timestamp\": \"1718635892\",\n \"type\": \"image\",\n \"image\": {\n \"caption\": \"Is this the right colour?\",\n \"mime_type\": \"image/jpeg\",\n \"sha256\": \"A2k...\",\n \"id\": \"1234567890123456\"\n }\n }\n ]\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Delivered when a customer sends a picture. Use `image.id` + GET /media to download bytes.\n\nPermissions: none" }, "response": [] }, { "name": "Incoming Button Reply", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}{your-callback-url}", "host": [ "{{baseUrl}}" ], "path": [ "{your-callback-url}" ] }, "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"959648497055756\",\n \"changes\": [\n {\n \"field\": \"messages\",\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"+91 78900 00199\",\n \"phone_number_id\": \"1226212787235581\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Sayantan Kar\"\n },\n \"wa_id\": \"917890000198\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"917890000198\",\n \"id\": \"wamid.HBgMO...\",\n \"timestamp\": \"1718635950\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"button_reply\",\n \"button_reply\": {\n \"id\": \"track\",\n \"title\": \"Track\"\n }\n },\n \"context\": {\n \"from\": \"+91 78900 00199\",\n \"id\": \"wamid.HBgMO_THE_MESSAGE_THAT_HAD_BUTTONS\"\n }\n }\n ]\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Delivered when a customer taps a button on an interactive message you sent.\n\nPermissions: none" }, "response": [] }, { "name": "Status — Delivered (with pricing + conversation)", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}{your-callback-url}", "host": [ "{{baseUrl}}" ], "path": [ "{your-callback-url}" ] }, "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"959648497055756\",\n \"changes\": [\n {\n \"field\": \"messages\",\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"+91 78900 00199\",\n \"phone_number_id\": \"1226212787235581\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.HBgMOTE4NTk3NDA2Njk0FQIAEhgUM0EwMzQy...\",\n \"status\": \"delivered\",\n \"timestamp\": \"1718635790\",\n \"recipient_id\": \"917890000198\",\n \"conversation\": {\n \"id\": \"7e8d9f3a1c2b4d5e8f9a0b1c2d3e4f5a\",\n \"expiration_timestamp\": \"1718722190\",\n \"origin\": {\n \"type\": \"marketing\"\n }\n },\n \"pricing\": {\n \"billable\": true,\n \"pricing_model\": \"CBP\",\n \"category\": \"marketing\",\n \"type\": \"regular\"\n }\n }\n ]\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Delivered when Meta finishes routing a message to the recipient device. Includes the `conversation` block (24-hour billing window id) and the `pricing` block (category Meta charged at).\n\nPermissions: none" }, "response": [] }, { "name": "Status — Failed", "request": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "type": "text", "description": "Public API key (waapi_*)" }, { "key": "X-API-Secret", "value": "{{apiSecret}}", "type": "text", "description": "Secret token (secr_*)" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "" } ], "url": { "raw": "{{baseUrl}}{your-callback-url}", "host": [ "{{baseUrl}}" ], "path": [ "{your-callback-url}" ] }, "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"959648497055756\",\n \"changes\": [\n {\n \"field\": \"messages\",\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"+91 78900 00199\",\n \"phone_number_id\": \"1226212787235581\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.HBgMO...\",\n \"status\": \"failed\",\n \"timestamp\": \"1718635800\",\n \"recipient_id\": \"917890000198\",\n \"errors\": [\n {\n \"code\": 131026,\n \"title\": \"Message undeliverable\",\n \"error_data\": {\n \"details\": \"Recipient phone number does not have WhatsApp installed\"\n }\n }\n ]\n }\n ]\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Delivered when a message could not be delivered. `errors[]` has Meta's error code + reason.\n\nPermissions: none" }, "response": [] } ] } ] }