{ "info": { "name": "Shumoul WhatsApp Integration", "description": "Official Postman collection for the WhatsApp Integration Library and its ERP-facing API surface (Shumoul.Saas.WhatsAppIntegration + Shumoul.Saas.Api). Generated from the certified API reference — see docs/frameworks/whatsapp-integration.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://{tenant}.shumoul.app", "type": "string" }, { "key": "token", "value": "", "type": "string" }, { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001", "type": "string" } ], "item": [ { "name": "Authentication", "item": [ { "name": "Get JWT Token (Login)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/Tokens/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "Tokens", "Create" ] }, "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"966549000191\",\n \"password\": \"Aa@123321\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/Tokens/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "Tokens", "Create" ] }, "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"966549000191\",\n \"password\": \"Aa@123321\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"token\": \"eyJhbGciOi...\",\n \"refreshToken\": \"...\",\n \"refreshTokenExpiryTime\": \"2026-07-12T00:00:00Z\"\n }\n}" } ], "description": "Platform-wide login endpoint (Shumoul.Api/Controllers/Identity/TokensController.cs) — not WhatsApp-specific, included so the collection is runnable standalone. Tenant is resolved from the request host subdomain, same as every other request in this collection." } ] }, { "name": "Webhook Verification", "item": [ { "name": "Verify Webhook", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/notifications/webhook?hub.mode=subscribe&hub.verify_token=ShumoulWhatsAppWebhook2026&hub.challenge=1158201444", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "notifications", "webhook" ], "query": [ { "key": "hub.mode", "value": "subscribe" }, { "key": "hub.verify_token", "value": "ShumoulWhatsAppWebhook2026" }, { "key": "hub.challenge", "value": "1158201444" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/notifications/webhook?hub.mode=subscribe&hub.verify_token=ShumoulWhatsAppWebhook2026&hub.challenge=1158201444", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "notifications", "webhook" ], "query": [ { "key": "hub.mode", "value": "subscribe" }, { "key": "hub.verify_token", "value": "ShumoulWhatsAppWebhook2026" }, { "key": "hub.challenge", "value": "1158201444" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\\\"1158201444\\\"\"" } ] }, { "name": "Receive Webhook", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-Hub-Signature-256", "value": "sha256=", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/notifications/webhook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "notifications", "webhook" ] }, "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"2091544401399393\",\n \"changes\": [\n {\n \"field\": \"messages\",\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"966501234567\",\n \"phone_number_id\": \"1088505757690326\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Ahmed Al-Otaibi\"\n },\n \"wa_id\": \"966501112222\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"966501112222\",\n \"id\": \"wamid.HBgLxx\",\n \"timestamp\": \"1751500000\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Hello\"\n }\n }\n ]\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-Hub-Signature-256", "value": "sha256=", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/notifications/webhook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "notifications", "webhook" ] }, "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"2091544401399393\",\n \"changes\": [\n {\n \"field\": \"messages\",\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"966501234567\",\n \"phone_number_id\": \"1088505757690326\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Ahmed Al-Otaibi\"\n },\n \"wa_id\": \"966501112222\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"966501112222\",\n \"id\": \"wamid.HBgLxx\",\n \"timestamp\": \"1751500000\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Hello\"\n }\n }\n ]\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"200 OK (empty body)\"" } ] } ] }, { "name": "Templates", "item": [ { "name": "Send Test Text", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/WhatsApp/SendTestText", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "WhatsApp", "SendTestText" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966501112222\",\n \"body\": \"This is a test message from Shumoul\",\n \"previewUrl\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/WhatsApp/SendTestText", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "WhatsApp", "SendTestText" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966501112222\",\n \"body\": \"This is a test message from Shumoul\",\n \"previewUrl\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"messageId\": \"wamid.HBgL...\",\n \"errorCode\": null,\n \"errorMessage\": null\n}" } ] }, { "name": "Send Test Template", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/WhatsApp/SendTestTemplate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "WhatsApp", "SendTestTemplate" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966501112222\",\n \"templateName\": \"hello_world\",\n \"languageCode\": \"en\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Test\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/WhatsApp/SendTestTemplate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "WhatsApp", "SendTestTemplate" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966501112222\",\n \"templateName\": \"hello_world\",\n \"languageCode\": \"en\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Test\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"messageId\": \"wamid.HBgL...\",\n \"errorCode\": null,\n \"errorMessage\": null\n}" } ] }, { "name": "Send Activation Test", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/WhatsApp/SendActivationTest", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "WhatsApp", "SendActivationTest" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966501112222\",\n \"customerName\": \"Ahmed Al-Otaibi\",\n \"organizationName\": \"Al-Otaibi Trading Co.\",\n \"languageCode\": \"ar\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/WhatsApp/SendActivationTest", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "WhatsApp", "SendActivationTest" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966501112222\",\n \"customerName\": \"Ahmed Al-Otaibi\",\n \"organizationName\": \"Al-Otaibi Trading Co.\",\n \"languageCode\": \"ar\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Activation test message sent successfully\"\n}" } ] }, { "name": "Send OTP Test", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/WhatsApp/SendOtpTest", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "WhatsApp", "SendOtpTest" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966501112222\",\n \"otpCode\": \"482913\",\n \"languageCode\": \"ar\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/WhatsApp/SendOtpTest", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "WhatsApp", "SendOtpTest" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"966501112222\",\n \"otpCode\": \"482913\",\n \"languageCode\": \"ar\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"OTP test message sent successfully\"\n}" } ] } ] }, { "name": "Conversations", "item": [ { "name": "Get Conversations", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/GetConversations?status=Open&onlyUnread=false&showArchived=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "GetConversations" ], "query": [ { "key": "status", "value": "Open" }, { "key": "onlyUnread", "value": "false" }, { "key": "showArchived", "value": "false" } ] }, "body": { "mode": "raw", "raw": "{\n \"draw\": 1,\n \"start\": 0,\n \"length\": 25,\n \"search\": {\n \"value\": \"\",\n \"regex\": false\n },\n \"order\": [\n {\n \"column\": 0,\n \"dir\": \"desc\"\n }\n ],\n \"columns\": [\n {\n \"data\": \"lastMessageAt\",\n \"name\": \"\",\n \"searchable\": true,\n \"orderable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/GetConversations?status=Open&onlyUnread=false&showArchived=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "GetConversations" ], "query": [ { "key": "status", "value": "Open" }, { "key": "onlyUnread", "value": "false" }, { "key": "showArchived", "value": "false" } ] }, "body": { "mode": "raw", "raw": "{\n \"draw\": 1,\n \"start\": 0,\n \"length\": 25,\n \"search\": {\n \"value\": \"\",\n \"regex\": false\n },\n \"order\": [\n {\n \"column\": 0,\n \"dir\": \"desc\"\n }\n ],\n \"columns\": [\n {\n \"data\": \"lastMessageAt\",\n \"name\": \"\",\n \"searchable\": true,\n \"orderable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"draw\": 1,\n \"recordsTotal\": 58,\n \"recordsFiltered\": 12,\n \"data\": [\n {\n \"id\": \"c1a2b3c4-...\",\n \"customerWaId\": \"966501112222\",\n \"displayName\": \"Ahmed Al-Otaibi\",\n \"status\": 1,\n \"unreadCount\": 2\n }\n ]\n}" } ] }, { "name": "Get Conversation Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/GetDetails/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "GetDetails", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/GetDetails/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "GetDetails", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"id\": \"c1a2b3c4-...\",\n \"customerWaId\": \"966501112222\",\n \"totalMessages\": 14,\n \"firstResponseSeconds\": 95\n }\n}" } ] }, { "name": "Assign Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Assign/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Assign", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"userId\": \"5f1a3b2c-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Assign/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Assign", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"userId\": \"5f1a3b2c-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Unassign Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Unassign/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Unassign", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Unassign/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Unassign", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Transfer Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Transfer/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Transfer", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"targetUserId\": \"5f1a3b2c-0000-0000-0000-000000000002\",\n \"comment\": \"Escalating — customer requesting refund\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Transfer/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Transfer", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"targetUserId\": \"5f1a3b2c-0000-0000-0000-000000000002\",\n \"comment\": \"Escalating — customer requesting refund\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Mark As Read", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/MarkAsRead/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "MarkAsRead", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/MarkAsRead/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "MarkAsRead", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Mark As Unread", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/MarkAsUnread/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "MarkAsUnread", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/MarkAsUnread/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "MarkAsUnread", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Close Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Close/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Close", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Resolved — refund processed\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Close/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Close", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Resolved — refund processed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Reopen Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Reopen/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Reopen", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Reopen/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Reopen", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Archive Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Archive/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Archive", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Archive/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Archive", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Unarchive Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Unarchive/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Unarchive", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Unarchive/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Unarchive", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Pin Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Pin/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Pin", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Pin/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Pin", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Unpin Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Unpin/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Unpin", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Unpin/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Unpin", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Favorite Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Favorite/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Favorite", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Favorite/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Favorite", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Unfavorite Conversation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Unfavorite/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Unfavorite", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Unfavorite/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Unfavorite", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Get Favorites", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Favorites" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Favorites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Favorites" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": [\n {\n \"id\": \"f1...\",\n \"conversationId\": \"c1...\"\n }\n ]\n}" } ] }, { "name": "Get Read State", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/ReadState/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "ReadState", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/ReadState/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "ReadState", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"conversationId\": \"c1...\",\n \"unreadCount\": 0\n }\n}" } ] }, { "name": "Get Customer Profile", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/CustomerProfile/:customerWaId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "CustomerProfile", ":customerWaId" ], "variable": [ { "key": "customerWaId", "value": "966501112222" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/CustomerProfile/:customerWaId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "CustomerProfile", ":customerWaId" ], "variable": [ { "key": "customerWaId", "value": "966501112222" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"customerWaId\": \"966501112222\",\n \"totalConversations\": 4\n }\n}" } ] }, { "name": "Export Conversation (JSON)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Export/:conversationId/json", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Export", ":conversationId", "json" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Export/:conversationId/json", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Export", ":conversationId", "json" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"conversationId\": \"c1...\",\n \"messages\": [],\n \"notes\": []\n }\n}" } ] }, { "name": "Export Conversation (Text)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Export/:conversationId/text", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Export", ":conversationId", "text" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Export/:conversationId/text", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Export", ":conversationId", "text" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"" } ] }, { "name": "Get Unread Count", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/UnreadCount", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "UnreadCount" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/UnreadCount", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "UnreadCount" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"unreadConversations\": 3,\n \"totalUnreadMessages\": 7\n }\n}" } ] }, { "name": "Get Inbox Summary", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Summary" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Summary" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"totalOpen\": 12,\n \"totalPending\": 3,\n \"totalClosed\": 43\n }\n}" } ] } ] }, { "name": "Inbox", "item": [ { "name": "Get Dashboard", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Dashboard" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Dashboard" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"openConversations\": 12,\n \"onlineAgents\": 4\n }\n}" } ] }, { "name": "Get Messages", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/GetMessages/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "GetMessages", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"draw\": 1,\n \"start\": 0,\n \"length\": 25,\n \"search\": {\n \"value\": \"\",\n \"regex\": false\n },\n \"order\": [\n {\n \"column\": 0,\n \"dir\": \"desc\"\n }\n ],\n \"columns\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/GetMessages/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "GetMessages", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"draw\": 1,\n \"start\": 0,\n \"length\": 25,\n \"search\": {\n \"value\": \"\",\n \"regex\": false\n },\n \"order\": [\n {\n \"column\": 0,\n \"dir\": \"desc\"\n }\n ],\n \"columns\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"draw\": 1,\n \"recordsTotal\": 14,\n \"recordsFiltered\": 14,\n \"data\": [\n {\n \"id\": \"m1...\",\n \"direction\": 1,\n \"textBody\": \"Hello\"\n }\n ]\n}" } ] }, { "name": "Send Reply", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/SendReply/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "SendReply", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Thank you for reaching out, checking your order now.\",\n \"previewUrl\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/SendReply/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "SendReply", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Thank you for reaching out, checking your order now.\",\n \"previewUrl\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"m2b3c4d5-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Send Template Reply", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/SendTemplateReply/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "SendTemplateReply", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"templateName\": \"order_status_update\",\n \"languageCode\": \"ar\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"12500 SAR\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/SendTemplateReply/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "SendTemplateReply", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"templateName\": \"order_status_update\",\n \"languageCode\": \"ar\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"12500 SAR\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"m2b3c4d5-0000-0000-0000-000000000002\"\n}" } ] }, { "name": "Get Media Info", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/MediaInfo/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "MediaInfo", ":messageId" ], "variable": [ { "key": "messageId", "value": "m1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/MediaInfo/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "MediaInfo", ":messageId" ], "variable": [ { "key": "messageId", "value": "m1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"mediaId\": \"1234567890\",\n \"mimeType\": \"image/jpeg\",\n \"sizeBytes\": 84213\n }\n}" } ] }, { "name": "Download Media", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Media/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Media", ":messageId" ], "variable": [ { "key": "messageId", "value": "m1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/inbox/Media/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "inbox", "Media", ":messageId" ], "variable": [ { "key": "messageId", "value": "m1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"" } ] } ] }, { "name": "Notes", "item": [ { "name": "Get Notes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/notes/GetNotes/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "notes", "GetNotes", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/notes/GetNotes/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "notes", "GetNotes", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": [\n {\n \"id\": \"n1...\",\n \"body\": \"Customer confirmed refund by bank transfer.\"\n }\n ]\n}" } ] }, { "name": "Add Note", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/notes/AddNote/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "notes", "AddNote", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Escalated to billing team\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/notes/AddNote/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "notes", "AddNote", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Escalated to billing team\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"n1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Update Note", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/notes/UpdateNote/:noteId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "notes", "UpdateNote", ":noteId" ], "variable": [ { "key": "noteId", "value": "n1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"n1a2b3c4-0000-0000-0000-000000000001\",\n \"body\": \"Escalated to billing team — awaiting response\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/notes/UpdateNote/:noteId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "notes", "UpdateNote", ":noteId" ], "variable": [ { "key": "noteId", "value": "n1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"n1a2b3c4-0000-0000-0000-000000000001\",\n \"body\": \"Escalated to billing team — awaiting response\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"n1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Delete Note", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/notes/DeleteNote/:noteId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "notes", "DeleteNote", ":noteId" ], "variable": [ { "key": "noteId", "value": "n1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/notes/DeleteNote/:noteId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "notes", "DeleteNote", ":noteId" ], "variable": [ { "key": "noteId", "value": "n1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"n1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] } ] }, { "name": "Saved Replies", "item": [ { "name": "Get Saved Replies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/GetSavedReplies?search=refund&includePersonal=true&includeShared=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "GetSavedReplies" ], "query": [ { "key": "search", "value": "refund" }, { "key": "includePersonal", "value": "true" }, { "key": "includeShared", "value": "true" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/GetSavedReplies?search=refund&includePersonal=true&includeShared=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "GetSavedReplies" ], "query": [ { "key": "search", "value": "refund" }, { "key": "includePersonal", "value": "true" }, { "key": "includeShared", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": [\n {\n \"id\": \"s1...\",\n \"title\": \"رد الاسترجاع\",\n \"fTitle\": \"Refund Reply\",\n \"shortcut\": \"/refund\"\n }\n ]\n}" } ] }, { "name": "Get Saved Reply Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/GetDetails/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "GetDetails", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/GetDetails/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "GetDetails", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"id\": \"s1...\",\n \"title\": \"رد الاسترجاع\",\n \"createdByUserName\": \"Sara Al-Harbi\"\n }\n}" } ] }, { "name": "Get Saved Reply For Edit", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/GetEdit/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "GetEdit", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/GetEdit/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "GetEdit", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"id\": \"s1...\",\n \"title\": \"رد الاسترجاع\",\n \"fTitle\": \"Refund Reply\",\n \"isActive\": true\n }\n}" } ] }, { "name": "Create Saved Reply", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Create" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"رد الاسترجاع\",\n \"fTitle\": \"Refund Reply\",\n \"body\": \"تم استرجاع مبلغكم...\",\n \"shortcut\": \"/refund\",\n \"category\": \"Billing\",\n \"isShared\": true,\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Create" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"رد الاسترجاع\",\n \"fTitle\": \"Refund Reply\",\n \"body\": \"تم استرجاع مبلغكم...\",\n \"shortcut\": \"/refund\",\n \"category\": \"Billing\",\n \"isShared\": true,\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"s1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Update Saved Reply", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Update/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Update", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"s1a2b3c4-0000-0000-0000-000000000001\",\n \"title\": \"رد الاسترجاع\",\n \"fTitle\": \"Refund Reply (Updated)\",\n \"body\": \"تم استرجاع مبلغكم بالكامل...\",\n \"shortcut\": \"/refund\",\n \"category\": \"Billing\",\n \"isShared\": true,\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Update/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Update", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"s1a2b3c4-0000-0000-0000-000000000001\",\n \"title\": \"رد الاسترجاع\",\n \"fTitle\": \"Refund Reply (Updated)\",\n \"body\": \"تم استرجاع مبلغكم بالكامل...\",\n \"shortcut\": \"/refund\",\n \"category\": \"Billing\",\n \"isShared\": true,\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"s1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Delete Saved Reply", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Delete/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Delete", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Delete/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Delete", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"s1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Restore Saved Reply", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Restore/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Restore", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Restore/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Restore", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"s1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Activate Saved Reply", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Activate/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Activate", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Activate/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Activate", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"s1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Deactivate Saved Reply", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Deactivate/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Deactivate", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/saved-replies/Deactivate/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "saved-replies", "Deactivate", ":id" ], "variable": [ { "key": "id", "value": "s1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"s1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] } ] }, { "name": "Tags", "item": [ { "name": "Get Tags", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/GetTags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "GetTags" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/GetTags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "GetTags" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": [\n {\n \"id\": \"t1...\",\n \"name\": \"عميل مميز\",\n \"fName\": \"VIP\",\n \"color\": \"#FFD700\"\n }\n ]\n}" } ] }, { "name": "Get Conversation Tags", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/GetConversationTags/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "GetConversationTags", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/GetConversationTags/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "GetConversationTags", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": [\n {\n \"id\": \"t1...\",\n \"name\": \"عميل مميز\",\n \"fName\": \"VIP\"\n }\n ]\n}" } ] }, { "name": "Create Tag", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/CreateTag", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "CreateTag" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"عميل مميز\",\n \"fName\": \"VIP\",\n \"color\": \"#FFD700\",\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/CreateTag", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "CreateTag" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"عميل مميز\",\n \"fName\": \"VIP\",\n \"color\": \"#FFD700\",\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"t1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Update Tag", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/UpdateTag/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "UpdateTag", ":tagId" ], "variable": [ { "key": "tagId", "value": "t1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"t1a2b3c4-0000-0000-0000-000000000001\",\n \"name\": \"عميل مميز\",\n \"fName\": \"VIP\",\n \"color\": \"#FFC300\",\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/UpdateTag/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "UpdateTag", ":tagId" ], "variable": [ { "key": "tagId", "value": "t1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"t1a2b3c4-0000-0000-0000-000000000001\",\n \"name\": \"عميل مميز\",\n \"fName\": \"VIP\",\n \"color\": \"#FFC300\",\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"t1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Delete Tag", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/DeleteTag/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "DeleteTag", ":tagId" ], "variable": [ { "key": "tagId", "value": "t1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/DeleteTag/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "DeleteTag", ":tagId" ], "variable": [ { "key": "tagId", "value": "t1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"t1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Assign Tag", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/AssignTag/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "AssignTag", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"tagId\": \"t1a2b3c4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/AssignTag/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "AssignTag", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] }, "body": { "mode": "raw", "raw": "{\n \"tagId\": \"t1a2b3c4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Remove Tag", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/RemoveTag/:conversationId/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "RemoveTag", ":conversationId", ":tagId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" }, { "key": "tagId", "value": "t1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/tags/RemoveTag/:conversationId/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "tags", "RemoveTag", ":conversationId", ":tagId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" }, { "key": "tagId", "value": "t1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"c1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] } ] }, { "name": "Timeline", "item": [ { "name": "Get Timeline", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/timeline/GetTimeline/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "timeline", "GetTimeline", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/timeline/GetTimeline/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "timeline", "GetTimeline", ":conversationId" ], "variable": [ { "key": "conversationId", "value": "c1a2b3c4-0000-0000-0000-000000000001" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": [\n {\n \"id\": \"e1...\",\n \"eventTypeName\": \"Assigned\",\n \"triggeredOn\": \"2026-07-05T10:15:00Z\"\n }\n ]\n}" } ] } ] }, { "name": "Diagnostics", "item": [ { "name": "Get Health", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Health" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"overallStatus\": 1,\n \"whatsAppStatus\": {\n \"status\": 1,\n \"isConfigured\": true\n }\n }\n}" } ] }, { "name": "Run Email Smoke Test", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/SmokeTest", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "SmokeTest" ] }, "body": { "mode": "raw", "raw": "{\n \"toEmail\": \"qa@tenant.com\",\n \"languageCode\": \"ar\",\n \"testType\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/SmokeTest", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "SmokeTest" ] }, "body": { "mode": "raw", "raw": "{\n \"toEmail\": \"qa@tenant.com\",\n \"languageCode\": \"ar\",\n \"testType\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"passed\": true,\n \"executionTimeMs\": 890\n }\n}" } ] }, { "name": "Run WhatsApp Smoke Test", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/SmokeTest/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "SmokeTest", "WhatsApp" ] }, "body": { "mode": "raw", "raw": "{\n \"toPhone\": \"966501112222\",\n \"languageCode\": \"ar\",\n \"testType\": 6\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/SmokeTest/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "SmokeTest", "WhatsApp" ] }, "body": { "mode": "raw", "raw": "{\n \"toPhone\": \"966501112222\",\n \"languageCode\": \"ar\",\n \"testType\": 6\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"passed\": true,\n \"executionTimeMs\": 1840,\n \"steps\": [\n {\n \"name\": \"ConfigurationCheck\",\n \"passed\": true\n }\n ]\n }\n}" } ] }, { "name": "Diagnose Provider Resolution", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Diagnostics/Providers?channel=WhatsApp&templateBaseName=send_document&languageCode=ar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Diagnostics", "Providers" ], "query": [ { "key": "channel", "value": "WhatsApp" }, { "key": "templateBaseName", "value": "send_document" }, { "key": "languageCode", "value": "ar" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Diagnostics/Providers?channel=WhatsApp&templateBaseName=send_document&languageCode=ar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Diagnostics", "Providers" ], "query": [ { "key": "channel", "value": "WhatsApp" }, { "key": "templateBaseName", "value": "send_document" }, { "key": "languageCode", "value": "ar" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"providerSelected\": \"Meta WhatsApp Cloud API\",\n \"templateResolved\": \"send_document_ar\"\n }\n}" } ] }, { "name": "Validate Email Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Diagnostics/Email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Diagnostics", "Email" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Diagnostics/Email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Diagnostics", "Email" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"isValid\": true,\n \"errors\": [],\n \"warnings\": []\n }\n}" } ] }, { "name": "Validate WhatsApp Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Diagnostics/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Diagnostics", "WhatsApp" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Diagnostics/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Diagnostics", "WhatsApp" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"isValid\": true,\n \"errors\": [],\n \"warnings\": [\n \"WebhookEnabled is false\"\n ]\n }\n}" } ] }, { "name": "Validate Print Preview", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Diagnostics/PrintPreview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Diagnostics", "PrintPreview" ] }, "body": { "mode": "raw", "raw": "{\n \"recipientPhone\": \"966501112222\",\n \"languageCode\": \"ar\",\n \"channel\": 2,\n \"documentType\": \"Invoice\",\n \"documentNumber\": \"INV-2026-00451\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Diagnostics/PrintPreview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Diagnostics", "PrintPreview" ] }, "body": { "mode": "raw", "raw": "{\n \"recipientPhone\": \"966501112222\",\n \"languageCode\": \"ar\",\n \"channel\": 2,\n \"documentType\": \"Invoice\",\n \"documentNumber\": \"INV-2026-00451\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"isValid\": true,\n \"providerConfigured\": true,\n \"providerEnabled\": true\n }\n}" } ] } ] }, { "name": "Communication APIs", "item": [ { "name": "Send Email", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Email" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0,\n \"email\": \"customer@example.com\",\n \"name\": \"Ahmed\"\n },\n \"subject\": \"Your Invoice\",\n \"body\": \"

Please find attached...

\",\n \"isHtml\": true,\n \"referenceType\": \"Invoice\",\n \"referenceNumber\": \"INV-2026-00451\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Email" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0,\n \"email\": \"customer@example.com\",\n \"name\": \"Ahmed\"\n },\n \"subject\": \"Your Invoice\",\n \"body\": \"

Please find attached...

\",\n \"isHtml\": true,\n \"referenceType\": \"Invoice\",\n \"referenceNumber\": \"INV-2026-00451\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"h1a2b3c4-0000-0000-0000-000000000001\"\n}" } ] }, { "name": "Send WhatsApp", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "WhatsApp" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0,\n \"phone\": \"966501112222\",\n \"name\": \"Ahmed\",\n \"languageCode\": \"ar\"\n },\n \"eventKey\": \"InvoiceIssued\",\n \"templateName\": \"send_document_invoice\",\n \"data\": {\n \"customerName\": \"Ahmed\",\n \"amount\": \"12500.00\",\n \"invoiceNumber\": \"INV-2026-00451\"\n },\n \"referenceType\": \"Invoice\",\n \"referenceNumber\": \"INV-2026-00451\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "WhatsApp" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0,\n \"phone\": \"966501112222\",\n \"name\": \"Ahmed\",\n \"languageCode\": \"ar\"\n },\n \"eventKey\": \"InvoiceIssued\",\n \"templateName\": \"send_document_invoice\",\n \"data\": {\n \"customerName\": \"Ahmed\",\n \"amount\": \"12500.00\",\n \"invoiceNumber\": \"INV-2026-00451\"\n },\n \"referenceType\": \"Invoice\",\n \"referenceNumber\": \"INV-2026-00451\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"h1a2b3c4-0000-0000-0000-000000000002\"\n}" } ] }, { "name": "Send SMS", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Sms" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0,\n \"phone\": \"966501112222\"\n },\n \"messageText\": \"Your OTP is 482913\",\n \"referenceType\": \"Otp\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Sms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Sms" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0,\n \"phone\": \"966501112222\"\n },\n \"messageText\": \"Your OTP is 482913\",\n \"referenceType\": \"Otp\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"h1a2b3c4-0000-0000-0000-000000000003\"\n}" } ] }, { "name": "Send Push", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Push", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Push" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0\n },\n \"title\": \"Order Shipped\",\n \"body\": \"Your order is on its way\",\n \"eventKey\": \"OrderShipped\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Push", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Push" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0\n },\n \"title\": \"Order Shipped\",\n \"body\": \"Your order is on its way\",\n \"eventKey\": \"OrderShipped\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"h1a2b3c4-0000-0000-0000-000000000004\"\n}" } ] }, { "name": "Send Notification", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Notification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Notification" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0\n },\n \"eventKey\": \"PurchaseInvoicePosted\",\n \"data\": {\n \"amount\": \"12500.00\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Notification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Notification" ] }, "body": { "mode": "raw", "raw": "{\n \"recipient\": {\n \"type\": 0\n },\n \"eventKey\": \"PurchaseInvoicePosted\",\n \"data\": {\n \"amount\": \"12500.00\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"h1a2b3c4-0000-0000-0000-000000000005\"\n}" } ] }, { "name": "Send Document", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Document", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Document" ] }, "body": { "mode": "raw", "raw": "{\n \"channel\": 2,\n \"recipient\": {\n \"phone\": \"966501112222\",\n \"languageCode\": \"ar\"\n },\n \"documentType\": \"Invoice\",\n \"documentNumber\": \"INV-2026-00451\",\n \"templateName\": \"send_document_invoice\",\n \"data\": {\n \"amount\": \"12500.00\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Send/Document", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Send", "Document" ] }, "body": { "mode": "raw", "raw": "{\n \"channel\": 2,\n \"recipient\": {\n \"phone\": \"966501112222\",\n \"languageCode\": \"ar\"\n },\n \"documentType\": \"Invoice\",\n \"documentNumber\": \"INV-2026-00451\",\n \"templateName\": \"send_document_invoice\",\n \"data\": {\n \"amount\": \"12500.00\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"h1a2b3c4-0000-0000-0000-000000000006\"\n}" } ] }, { "name": "Preview", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Preview" ] }, "body": { "mode": "raw", "raw": "{\n \"channel\": 2,\n \"recipient\": {\n \"phone\": \"966501112222\",\n \"languageCode\": \"ar\"\n },\n \"documentType\": \"Invoice\",\n \"documentNumber\": \"INV-2026-00451\",\n \"templateName\": \"send_document_invoice\",\n \"data\": {\n \"amount\": \"12500.00\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Preview" ] }, "body": { "mode": "raw", "raw": "{\n \"channel\": 2,\n \"recipient\": {\n \"phone\": \"966501112222\",\n \"languageCode\": \"ar\"\n },\n \"documentType\": \"Invoice\",\n \"documentNumber\": \"INV-2026-00451\",\n \"templateName\": \"send_document_invoice\",\n \"data\": {\n \"amount\": \"12500.00\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"channel\": 2,\n \"body\": \"مرحباً أحمد...\",\n \"isValid\": true\n }\n}" } ] }, { "name": "Validate Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/ValidateSettings/:channel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "ValidateSettings", ":channel" ], "variable": [ { "key": "channel", "value": "2" } ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/ValidateSettings/:channel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "ValidateSettings", ":channel" ], "variable": [ { "key": "channel", "value": "2" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"isValid\": true,\n \"errors\": [],\n \"warnings\": []\n }\n}" } ] }, { "name": "Get Email Provider Info", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/ProviderInfo/Email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "ProviderInfo", "Email" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/ProviderInfo/Email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "ProviderInfo", "Email" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"providerName\": \"SMTP\",\n \"isConfigured\": true\n }\n}" } ] }, { "name": "Get WhatsApp Provider Info", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/ProviderInfo/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "ProviderInfo", "WhatsApp" ] } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/ProviderInfo/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "ProviderInfo", "WhatsApp" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": {\n \"providerName\": \"Meta WhatsApp Cloud API\",\n \"isConfigured\": true,\n \"senderIdentity\": \"966501234567\"\n }\n}" } ] }, { "name": "Test Email", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Test/Email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Test", "Email" ] }, "body": { "mode": "raw", "raw": "{\n \"toEmail\": \"admin@tenant.com\",\n \"subject\": \"Shumoul Test Email\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Test/Email", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Test", "Email" ] }, "body": { "mode": "raw", "raw": "{\n \"toEmail\": \"admin@tenant.com\",\n \"subject\": \"Shumoul Test Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"h1a2b3c4-0000-0000-0000-000000000007\"\n}" } ] }, { "name": "Test WhatsApp", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Test/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Test", "WhatsApp" ] }, "body": { "mode": "raw", "raw": "{\n \"toPhone\": \"966501112222\",\n \"templateName\": \"hello_world\",\n \"languageCode\": \"ar\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Sample Response", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/Communication/Test/WhatsApp", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "Communication", "Test", "WhatsApp" ] }, "body": { "mode": "raw", "raw": "{\n \"toPhone\": \"966501112222\",\n \"templateName\": \"hello_world\",\n \"languageCode\": \"ar\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"succeeded\": true,\n \"data\": \"h1a2b3c4-0000-0000-0000-000000000008\"\n}" } ] } ] } ] }