{ "info": { "_postman_id": "cdf3fac2-7d7d-46db-930e-81ed9f5bc23a", "name": "Whatsapp messaging RapidAPI - by Retention Stack", "description": "Production-ready RapidAPI for WhatsApp HTTP API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "24810525" }, "item": [ { "name": "health", "item": [ { "name": "Health check endpoint", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/health", "host": [ "{{baseUrl}}" ], "path": [ "health" ] }, "description": "Health check endpoint" }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/health", "host": [ "{{baseUrl}}" ], "path": [ "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"data\": {\n \"status\": \"\",\n \"timestamp\": \"\",\n \"uptime\": \"\",\n \"environment\": \"\"\n },\n \"timestamp\": \"\"\n}" } ] } ] }, { "name": "v1", "item": [ { "name": "sessions", "item": [ { "name": "{session}", "item": [ { "name": "me", "item": [ { "name": "Get session me", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "me" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "me" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "webhooks", "item": [ { "name": "Add session webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"\",\n \"events\": [\n \"\"\n ],\n \"hmacKey\": \"\",\n \"retries\": {\n \"policy\": \"exponential\",\n \"delaySeconds\": \"\",\n \"attempts\": \"\"\n },\n \"customHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "webhooks" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"\",\n \"events\": [\n \"\"\n ],\n \"hmacKey\": \"\",\n \"retries\": {\n \"policy\": \"exponential\",\n \"delaySeconds\": \"\",\n \"attempts\": \"\"\n },\n \"customHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "webhooks" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete session webhook", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "webhooks" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "webhooks" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "presence", "item": [ { "name": "{chatId}", "item": [ { "name": "subscribe", "item": [ { "name": "Subscribe to chat presence", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/presence/:chatId/subscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "presence", ":chatId", "subscribe" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" }, { "key": "chatId", "value": "+7060@s.whatsapp.net", "description": "(Required) Chat ID in format: 1234567890@c.us or +1234567890@c.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/presence/:chatId/subscribe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "presence", ":chatId", "subscribe" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" }, { "key": "chatId", "value": "+7060@s.whatsapp.net", "description": "(Required) Chat ID in format: 1234567890@c.us or +1234567890@c.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get chat presence", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/presence/:chatId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "presence", ":chatId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" }, { "key": "chatId", "value": "+7060@s.whatsapp.net", "description": "(Required) Chat ID in format: 1234567890@c.us or +1234567890@c.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/presence/:chatId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "presence", ":chatId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" }, { "key": "chatId", "value": "+7060@s.whatsapp.net", "description": "(Required) Chat ID in format: 1234567890@c.us or +1234567890@c.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Set presence", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"presence\": \"typing\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/presence", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "presence" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"presence\": \"typing\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/presence", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "presence" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Get all chats presence", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/presence", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "presence" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/presence", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "presence" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "groups", "item": [ { "name": "count", "item": [ { "name": "Get groups count", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/count", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", "count" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/count", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", "count" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "join", "item": [ { "name": "Join group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/join", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", "join" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/join", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", "join" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "refresh", "item": [ { "name": "Refresh groups", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", "refresh" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", "refresh" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{groupId}", "item": [ { "name": "leave", "item": [ { "name": "Leave group", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/leave", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "leave" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/leave", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "leave" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "subject", "item": [ { "name": "Set group subject", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/subject", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "subject" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/subject", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "subject" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "description", "item": [ { "name": "Set group description", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/description", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "description" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/description", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "description" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "settings", "item": [ { "name": "security", "item": [ { "name": "info-admin-only", "item": [ { "name": "Set info admin-only", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"adminsOnly\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/settings/security/info-admin-only", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "settings", "security", "info-admin-only" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"adminsOnly\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/settings/security/info-admin-only", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "settings", "security", "info-admin-only" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Get info admin-only setting", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/settings/security/info-admin-only", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "settings", "security", "info-admin-only" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/settings/security/info-admin-only", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "settings", "security", "info-admin-only" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "messages-admin-only", "item": [ { "name": "Set messages admin-only", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"adminsOnly\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/settings/security/messages-admin-only", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "settings", "security", "messages-admin-only" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"adminsOnly\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/settings/security/messages-admin-only", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "settings", "security", "messages-admin-only" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Get messages admin-only setting", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/settings/security/messages-admin-only", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "settings", "security", "messages-admin-only" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/settings/security/messages-admin-only", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "settings", "security", "messages-admin-only" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "participants", "item": [ { "name": "add", "item": [ { "name": "Add participants", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"participants\": [\n {\n \"id\": \"35121553@s.whatsapp.net\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/participants/add", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "participants", "add" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"participants\": [\n {\n \"id\": \"35121553@s.whatsapp.net\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/participants/add", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "participants", "add" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "remove", "item": [ { "name": "Remove participants", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"participants\": [\n {\n \"id\": \"410355@c.us\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/participants/remove", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "participants", "remove" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"participants\": [\n {\n \"id\": \"410355@c.us\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/participants/remove", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "participants", "remove" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get participants", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/participants", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "participants" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/participants", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "participants" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "admin", "item": [ { "name": "promote", "item": [ { "name": "Promote to admin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"participants\": [\n {\n \"id\": \"792003711@c.us\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/admin/promote", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "admin", "promote" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"participants\": [\n {\n \"id\": \"792003711@c.us\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/admin/promote", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "admin", "promote" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "demote", "item": [ { "name": "Demote from admin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"participants\": [\n {\n \"id\": \"21@s.us\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/admin/demote", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "admin", "demote" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"participants\": [\n {\n \"id\": \"21@s.us\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/admin/demote", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "admin", "demote" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "invite-code", "item": [ { "name": "revoke", "item": [ { "name": "Revoke invite code", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/invite-code/revoke", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "invite-code", "revoke" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/invite-code/revoke", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "invite-code", "revoke" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get invite code", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/invite-code", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "invite-code" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/invite-code", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "invite-code" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "picture", "item": [ { "name": "Get group picture", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/picture", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "picture" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/picture", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "picture" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Set group picture", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": {\n \"url\": \"\",\n \"mimetype\": \"image/webp\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/picture", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "picture" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": {\n \"url\": \"\",\n \"mimetype\": \"image/webp\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/picture", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "picture" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete group picture", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/picture", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "picture" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId/picture", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId", "picture" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get group", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete group", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups", ":groupId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "groupId", "value": "", "description": "(Required) Group ID in format: 120363...@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Create group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"participants\": [\n {\n \"id\": \"34787@s.whatsapp.net\"\n }\n ],\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"participants\": [\n {\n \"id\": \"34787@s.whatsapp.net\"\n }\n ],\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "List groups (paginated, excludes participants)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups?limit=10&offset=0&sortBy=subject&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups" ], "query": [ { "key": "limit", "value": "10", "description": "Maximum number of groups to return (default: 10, max: 100)" }, { "key": "offset", "value": "0", "description": "Number of groups to skip from the start (default: 0)" }, { "key": "sortBy", "value": "subject", "description": "Field to sort by: id or subject (default: subject) (This can only be one of id,subject)" }, { "key": "sortOrder", "value": "asc", "description": "Sort order: asc (ascending) or desc (descending) (default: asc) (This can only be one of asc,desc)" } ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/groups?limit=10&offset=0&sortBy=subject&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "groups" ], "query": [ { "description": "Maximum number of groups to return (default: 10, max: 100)", "key": "limit", "value": "10" }, { "description": "Number of groups to skip from the start (default: 0)", "key": "offset", "value": "0" }, { "description": "Field to sort by: id or subject (default: subject) (This can only be one of id,subject)", "key": "sortBy", "value": "subject" }, { "description": "Sort order: asc (ascending) or desc (descending) (default: asc) (This can only be one of asc,desc)", "key": "sortOrder", "value": "asc" } ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "channels", "item": [ { "name": "{channelId}", "item": [ { "name": "messages", "item": [ { "name": "preview", "item": [ { "name": "Get channel preview messages", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels/:channelId/messages/preview?downloadMedia=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels", ":channelId", "messages", "preview" ], "query": [ { "key": "downloadMedia", "value": "", "description": "Download media with messages (true/false)" }, { "key": "limit", "value": "", "description": "Number of messages to preview" } ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "channelId", "value": "", "description": "(Required) Channel ID" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels/:channelId/messages/preview?downloadMedia=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels", ":channelId", "messages", "preview" ], "query": [ { "description": "Download media with messages (true/false)", "key": "downloadMedia", "value": "" }, { "description": "Number of messages to preview", "key": "limit", "value": "" } ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "channelId", "value": "", "description": "(Required) Channel ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "Get channel", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels", ":channelId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "channelId", "value": "", "description": "(Required) Channel ID" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels", ":channelId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "channelId", "value": "", "description": "(Required) Channel ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete channel", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels", ":channelId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "channelId", "value": "", "description": "(Required) Channel ID" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels", ":channelId" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "channelId", "value": "", "description": "(Required) Channel ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List channels", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create channel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"picture\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"picture\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/:session/channels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session", "channels" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Delete session", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Get session", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions/:session", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", ":session" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "start", "item": [ { "name": "Start session", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/start", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", "start" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/start", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", "start" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "stop", "item": [ { "name": "Stop session", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"logout\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/stop", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", "stop" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"logout\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/stop", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", "stop" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "logout", "item": [ { "name": "Logout session", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/logout", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", "logout" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sessions/logout", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions", "logout" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Create session", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "List sessions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sessions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{session}", "item": [ { "name": "auth", "item": [ { "name": "qr", "item": [ { "name": "Get QR code", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/:session/auth/qr?format=base64", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":session", "auth", "qr" ], "query": [ { "key": "format", "value": "base64", "description": "Response format: \"binary\" returns PNG image, \"base64\" returns JSON with base64 data (default) (This can only be one of binary,base64)" } ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] }, "description": "Get QR code for session authentication" }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/:session/auth/qr?format=base64", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":session", "auth", "qr" ], "query": [ { "description": "Response format: \"binary\" returns PNG image, \"base64\" returns JSON with base64 data (default) (This can only be one of binary,base64)", "key": "format", "value": "base64" } ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "pairing-code", "item": [ { "name": "Request pairing code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"09933394185930\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:session/auth/pairing-code", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":session", "auth", "pairing-code" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"09933394185930\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:session/auth/pairing-code", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":session", "auth", "pairing-code" ], "variable": [ { "key": "session", "value": "", "description": "(Required) WhatsApp session name (1-100 characters)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "sendText", "item": [ { "name": "Send text message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"text\": \"\",\n \"session\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ],\n \"linkPreview\": \"\",\n \"linkPreviewHighQuality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendText", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendText" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"text\": \"\",\n \"session\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ],\n \"linkPreview\": \"\",\n \"linkPreviewHighQuality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendText", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendText" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sendImage", "item": [ { "name": "Send image", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"file\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\",\n \"data\": \"\"\n },\n \"caption\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendImage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendImage" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"file\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\",\n \"data\": \"\"\n },\n \"caption\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendImage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendImage" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sendFile", "item": [ { "name": "Send file", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"file\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\",\n \"data\": \"\"\n },\n \"caption\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendFile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendFile" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"file\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\",\n \"data\": \"\"\n },\n \"caption\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendFile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendFile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sendVoice", "item": [ { "name": "Send voice message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"file\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\",\n \"data\": \"\"\n },\n \"reply_to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendVoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendVoice" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"file\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\",\n \"data\": \"\"\n },\n \"reply_to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendVoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendVoice" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sendVideo", "item": [ { "name": "Send video", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"file\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\",\n \"data\": \"\"\n },\n \"caption\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendVideo", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendVideo" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"file\": {\n \"mimetype\": \"\",\n \"filename\": \"\",\n \"url\": \"\",\n \"data\": \"\"\n },\n \"caption\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendVideo", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendVideo" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sendLocation", "item": [ { "name": "Send location", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"title\": \"\",\n \"reply_to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendLocation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendLocation" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"title\": \"\",\n \"reply_to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendLocation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendLocation" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sendContactVcard", "item": [ { "name": "Send contact vCard", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"contactsId\": [\n \"\"\n ],\n \"reply_to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendContactVcard", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendContactVcard" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"contactsId\": [\n \"\"\n ],\n \"reply_to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendContactVcard", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendContactVcard" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sendPoll", "item": [ { "name": "Send poll", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"poll\": {\n \"name\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"multipleAnswers\": \"\"\n },\n \"reply_to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendPoll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendPoll" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"poll\": {\n \"name\": \"\",\n \"options\": [\n \"\",\n \"\"\n ],\n \"multipleAnswers\": \"\"\n },\n \"reply_to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendPoll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendPoll" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "reply", "item": [ { "name": "Reply to message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"text\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reply", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reply" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"text\": \"\",\n \"reply_to\": \"\",\n \"mentions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reply", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reply" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "sendSeen", "item": [ { "name": "Mark message as seen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"messageId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendSeen", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendSeen" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\",\n \"messageId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sendSeen", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sendSeen" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "startTyping", "item": [ { "name": "Start typing indicator", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/startTyping", "host": [ "{{baseUrl}}" ], "path": [ "v1", "startTyping" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/startTyping", "host": [ "{{baseUrl}}" ], "path": [ "v1", "startTyping" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "stopTyping", "item": [ { "name": "Stop typing indicator", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/stopTyping", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stopTyping" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"chatId\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/stopTyping", "host": [ "{{baseUrl}}" ], "path": [ "v1", "stopTyping" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "reaction", "item": [ { "name": "Set message reaction", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"\",\n \"session\": \"\",\n \"reaction\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reaction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reaction" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"\",\n \"session\": \"\",\n \"reaction\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reaction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reaction" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "star", "item": [ { "name": "Star or unstar message", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"\",\n \"session\": \"\",\n \"star\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/star", "host": [ "{{baseUrl}}" ], "path": [ "v1", "star" ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"\",\n \"session\": \"\",\n \"star\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/star", "host": [ "{{baseUrl}}" ], "path": [ "v1", "star" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "messages", "item": [ { "name": "Get messages", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/messages?chatId=&session=&limit=100&downloadMedia=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "messages" ], "query": [ { "key": "chatId", "value": "", "description": "(Required) Phone number (e.g., \"1234567890\" or \"+1234567890\"), group ID (e.g., \"120363...@g.us\"), or channel ID (e.g., \"120363...@s.whatsapp.net\"). Phone numbers will be automatically formatted with @c.us suffix." }, { "key": "session", "value": "", "description": "(Required) WhatsApp session name" }, { "key": "limit", "value": "100", "description": "Number of messages to retrieve (default: 100, max: 1000)" }, { "key": "downloadMedia", "value": "true", "description": "Download media files with messages (default: false) (This can only be one of true)" } ] } }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/messages?chatId=&session=&limit=100&downloadMedia=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "messages" ], "query": [ { "description": "(Required) Phone number (e.g., \"1234567890\" or \"+1234567890\"), group ID (e.g., \"120363...@g.us\"), or channel ID (e.g., \"120363...@s.whatsapp.net\"). Phone numbers will be automatically formatted with @c.us suffix.", "key": "chatId", "value": "" }, { "description": "(Required) WhatsApp session name", "key": "session", "value": "" }, { "description": "Number of messages to retrieve (default: 100, max: 1000)", "key": "limit", "value": "100" }, { "description": "Download media files with messages (default: false) (This can only be one of true)", "key": "downloadMedia", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "contacts", "item": [ { "name": "check-exists", "item": [ { "name": "Check if phone number exists on WhatsApp", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/check-exists?phone=867586082329&session=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", "check-exists" ], "query": [ { "key": "phone", "value": "867586082329", "description": "(Required) Phone number (10-15 digits)" }, { "key": "session", "value": "", "description": "(Required) WhatsApp session name" } ] }, "description": "Check whether a phone number is registered on WhatsApp, even if the number is not in your contact list. Returns numberExists (boolean) and chatId (if found). Always call this before sending to a new number — especially for Brazilian numbers (pre-2012 numbers carry a different chatId due to the 9-digit migration)." }, "response": [ { "name": "Default Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/check-exists?phone=867586082329&session=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", "check-exists" ], "query": [ { "description": "(Required) Phone number (10-15 digits)", "key": "phone", "value": "867586082329" }, { "description": "(Required) WhatsApp session name", "key": "session", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"numberExists\": \"\",\n \"chatId\": \"\"\n}" } ] } ] } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-rapidapi-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://whatsapp-messaging-bot.p.rapidapi.com" }, { "key": "apiKey", "value": "" } ] }