{ "openapi": "3.0.0", "info": { "version": "2.0.0", "title": "WPPConnect API Rest", "description": "Welcome to the wppconnect-server API documentation. This API provides a set of endpoints to interact with the wppconnect-server application, allowing you to build integrations and automate interactions with WhatsApp." }, "tags": [ { "name": "Auth", "description": "" }, { "name": "Chat", "description": "Manages chat-related operations." }, { "name": "Messages", "description": "Handles message-related operations, including sending, receiving, and managing messages." }, { "name": "Profile", "description": "Manages user profile-related operations, such as retrieving and updating profile information" }, { "name": "Status Stories", "description": "Handles operations related to status stories, such as viewing, updating, and managing status stories" }, { "name": "Labels", "description": "Manages labels or tags associated with chats or messages for organization and categorization purposes." }, { "name": "Contact", "description": "Handles operations related to contacts, such as managing contact lists, adding or removing contacts, and retrieving contact information." }, { "name": "Group", "description": "Manages operations related to WhatsApp groups, such as creating, modifying, and managing group settings." }, { "name": "Catalog & Bussiness", "description": "Handles operations related to catalogs and business-related functionalities, such as managing product catalogs and business information." }, { "name": "Misc", "description": "Handles miscellaneous operations that do not fit into other specific categories." } ], "paths": { "/api/{session}/{secretkey}/generate-token": { "post": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "secretkey", "in": "path", "required": true, "schema": { "type": "string", "example": "THISISMYSECURETOKEN" } } ], "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/{secretkey}/show-all-sessions": { "get": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "secretkey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "session", "schema": { "type": "string", "example": "NERDWHATS_AMERICA" }, "in": "query" }, { "name": "authorization", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{secretkey}/start-all": { "post": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "secretkey", "in": "path", "required": true, "schema": { "type": "string", "example": "THISISMYSECURECODE" } }, { "name": "session", "schema": { "type": "string", "example": "NERDWHATS_AMERICA" }, "in": "query" }, { "name": "authorization", "in": "header", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/check-connection-session": { "get": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-media-by-message/{messageId}": { "get": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "messageId" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/status-session": { "get": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "clearSession": { "type": "boolean", "example": false } }, "required": ["clearSession"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/qrcode-session": { "get": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/start-session": { "post": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "waitQrCode": { "type": "boolean", "example": false } }, "required": ["waitQrCode"] } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/logout-session": { "post": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/close-session": { "post": { "tags": ["Auth"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "clearSession": { "type": "boolean", "example": false } }, "required": ["clearSession"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/subscribe-presence": { "post": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "all": { "type": "string", "example": "false" } }, "required": ["phone", "isGroup", "all"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/download-media": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "messageId": { "type": "string", "example": "" } }, "required": ["messageId"] } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-message": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "message": { "type": "string", "example": "Hello, welcome to WPPConnect" }, "isGroup": { "type": "boolean", "example": false } }, "required": ["phone", "message", "isGroup"] } } ], "responses": { "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-image": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "filename": { "type": "string", "example": "file name lol" }, "caption": { "type": "string", "example": "caption for my file" }, "base64": { "type": "string", "example": " string" } }, "required": ["phone", "isGroup", "filename", "caption", "base64"] } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-sticker": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": true }, "path": { "type": "string", "example": "" } }, "required": ["phone", "isGroup", "path"] } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-sticker-gif": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": true }, "path": { "type": "string", "example": "" } }, "required": ["phone", "isGroup", "path"] } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-reply": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Reply to message" }, "messageId": { "type": "string", "example": "" } }, "required": ["phone", "isGroup", "message", "messageId"] } } ], "responses": { "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-file": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "filename": { "type": "string", "example": "file name lol" }, "caption": { "type": "string", "example": "caption for my file" }, "base64": { "type": "string", "example": " string" } }, "required": ["phone", "isGroup", "filename", "caption", "base64"] } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-file-base64": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "filename": { "type": "string", "example": "file name lol" }, "caption": { "type": "string", "example": "caption for my file" }, "base64": { "type": "string", "example": " string" } }, "required": ["phone", "isGroup", "filename", "caption", "base64"] } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-voice": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "path": { "type": "string", "example": "" }, "quotedMessageId": { "type": "undefined" } }, "required": ["phone", "isGroup", "path", "quotedMessageId"] } } ], "responses": { "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-voice-base64": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "base64Ptt": { "type": "string", "example": "" } }, "required": ["phone", "isGroup", "base64Ptt"] } } ], "responses": { "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-status": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Post text status" } }, "required": ["message"] } } ], "responses": { "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-link-preview": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "url": { "type": "string", "example": "http://www.link.com" }, "caption": { "type": "string", "example": "Text for describe link" } }, "required": ["phone", "isGroup", "url", "caption"] } } ], "responses": { "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-location": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "lat": { "type": "string", "example": "-89898322" }, "lng": { "type": "string", "example": "-545454" }, "title": { "type": "string", "example": "Rio de Janeiro" }, "address": { "type": "string", "example": "Av. N. S. de Copacabana, 25, Copacabana" } }, "required": ["phone", "isGroup", "lat", "lng", "title", "address"] } } ], "responses": { "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-mentioned": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Your text message" }, "mentioned": { "type": "array", "example": ["@556593077171@c.us"], "items": { "type": "string" } } }, "required": ["phone", "isGroup", "message", "mentioned"] } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-buttons": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ], "deprecated": true } }, "/api/{session}/send-list-message": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ], "deprecated": true } }, "/api/{session}/send-poll-message": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "name": { "type": "string", "example": "Poll name" }, "choices": { "type": "array", "example": ["Option 1", "Option 2", "Option 3"], "items": { "type": "string" } }, "options": { "type": "object", "properties": { "selectableCount": { "type": "string", "example": "1" } }, "required": ["selectableCount"] } }, "required": ["phone", "isGroup", "name", "choices", "options"] } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/all-broadcast-list": { "get": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/all-groups": { "get": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-members/{groupId}": { "get": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" } }, "required": ["groupId"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-admins/{groupId}": { "get": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" } }, "required": ["groupId"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-invite-link/{groupId}": { "get": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" } }, "required": ["groupId"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-revoke-link/{groupId}": { "get": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" } }, "required": ["groupId"] } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-members-ids/{groupId}": { "get": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/create-group": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "participants": { "type": "array", "example": ["5521999999999"], "items": { "type": "string" } }, "name": { "type": "string", "example": "Group name" } }, "required": ["participants", "name"] } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/leave-group": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" } }, "required": ["groupId"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/join-code": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "inviteCode": { "type": "string", "example": "5644444" } }, "required": ["inviteCode"] } } ], "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/add-participant-group": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "5521999999999" } }, "required": ["groupId", "phone"] } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/remove-participant-group": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "5521999999999" } }, "required": ["groupId", "phone"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/promote-participant-group": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "5521999999999" } }, "required": ["groupId", "phone"] } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/demote-participant-group": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "phone": { "type": "string", "example": "5521999999999" } }, "required": ["groupId", "phone"] } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-info-from-invite-link": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "invitecode": { "type": "string", "example": "" } }, "required": ["invitecode"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-description": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Desription for your group" } }, "required": ["groupId", "description"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-property": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "property": { "type": "string", "example": "announcement" }, "value": { "type": "boolean", "example": true } }, "required": ["groupId", "property", "value"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-subject": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "title": { "type": "string", "example": "Title for your group" } }, "required": ["groupId", "title"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/messages-admins-only": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "value": { "type": "boolean", "example": true } }, "required": ["groupId", "value"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/group-pic": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "path": { "type": "string", "example": "path_of_your_file" } }, "required": ["groupId", "path"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/change-privacy-group": { "post": { "tags": ["Group"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "groupId": { "type": "string", "example": "" }, "status": { "type": "boolean", "example": true } }, "required": ["groupId", "status"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/all-chats": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/all-chats-with-messages": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/all-messages-in-chat/{phone}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } }, { "name": "isGroup", "schema": { "type": "string", "example": "false" }, "in": "query" }, { "name": "includeMe", "schema": { "type": "string", "example": "true" }, "in": "query" }, { "name": "includeNotifications", "schema": { "type": "string", "example": "true" }, "in": "query" } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/all-new-messages": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/unread-messages": { "get": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ], "deprecated": true } }, "/api/{session}/all-unread-messages": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/chat-by-id/{phone}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } }, { "name": "isGroup", "schema": { "type": "string", "example": "false" }, "in": "query" } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/message-by-id/{messageId}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/chat-is-online/{phone}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/last-seen/{phone}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/list-mutes/{type}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "example": "all" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/load-messages-in-chat/{phone}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } }, { "name": "includeMe", "schema": { "type": "string", "example": "true" }, "in": "query" }, { "name": "includeNotifications", "schema": { "type": "string", "example": "false" }, "in": "query" } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ], "deprecated": true } }, "/api/{session}/get-messages/{phone}": { "get": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999@c.us" } }, { "name": "count", "schema": { "type": "string", "example": "20" }, "in": "query" }, { "name": "direction", "schema": { "type": "string", "example": "before" }, "in": "query" }, { "name": "id", "schema": { "type": "string", "example": "" }, "in": "query" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/archive-chat": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "value": { "type": "boolean", "example": true } }, "required": ["phone", "isGroup"] } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/archive-all-chats": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/clear-chat": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false } }, "required": ["phone", "isGroup"] } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/clear-all-chats": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/delete-chat": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false } }, "required": ["phone", "isGroup"] } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/delete-all-chats": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/delete-message": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "messageId": { "type": "string", "example": "" } }, "required": ["phone", "isGroup"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/react-message": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "msgId": { "type": "string", "example": "" }, "reaction": { "type": "string", "example": "😜" } }, "required": ["msgId", "reaction"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/forward-messages": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "messageId": { "type": "string", "example": "" } }, "required": ["phone", "isGroup", "messageId"] } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/mark-unseen": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false } }, "required": ["phone", "isGroup"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/pin-chat": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "state": { "type": "boolean", "example": true } }, "required": ["phone", "isGroup", "state"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/contact-vcard": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "name": { "type": "string", "example": "Name of contact" }, "contactsId": { "type": "array", "example": ["5521999999999"], "items": { "type": "string" } } }, "required": ["phone", "isGroup", "name", "contactsId"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-mute": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "time": { "type": "string", "example": "1" }, "type": { "type": "string", "example": "hours" } }, "required": ["phone", "isGroup", "time", "type"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-seen": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false } }, "required": ["phone", "isGroup"] } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/chat-state": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "chatstate": { "type": "string", "example": "1" } }, "required": ["phone", "isGroup", "chatstate"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ], "deprecated": true } }, "/api/{session}/temporary-messages": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "value": { "type": "boolean", "example": true } }, "required": ["phone", "isGroup", "value"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/typing": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "value": { "type": "boolean", "example": true } }, "required": ["phone", "isGroup", "value"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/recording": { "post": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false }, "duration": { "type": "string", "example": "5" }, "value": { "type": "boolean", "example": true } }, "required": ["phone", "isGroup", "duration", "value"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/star-message": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "messageId": { "type": "string", "example": "" }, "star": { "type": "string", "example": "true" } }, "required": ["messageId", "star"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/reactions/{id}": { "get": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "schema": { "type": "string", "example": "" }, "in": "query" } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/votes/{id}": { "get": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "schema": { "type": "string", "example": "" }, "in": "query" } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/reject-call": { "post": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "callId": { "type": "string", "example": "" } }, "required": ["callId"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-products": { "get": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "query", "schema": { "type": "string", "example": "5521999999999" } }, { "name": "qnt", "in": "query", "schema": { "type": "string", "example": "10" } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-product-by-id": { "get": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "query", "schema": { "type": "string", "example": "5521999999999" } }, { "name": "id", "in": "query", "schema": { "type": "string", "example": "10" } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/add-product": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Product name" }, "image": { "type": "string", "example": "" }, "description": { "type": "string", "example": "Description for your product" }, "price": { "type": "string", "example": "8890" }, "url": { "type": "string", "example": "http://link_for_your_product.com" }, "retailerId": { "type": "string", "example": "SKU001" }, "currency": { "type": "string", "example": "BRL" } }, "required": [ "name", "image", "description", "price", "url", "retailerId", "currency" ] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/edit-product": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "options": { "type": "object", "properties": { "name": { "type": "string", "example": "New name for product" } }, "required": ["name"] } }, "required": ["id", "options"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/del-products": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "" } }, "required": ["id"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/change-product-image": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "base64": { "type": "string", "example": "" } }, "required": ["id", "base64"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/add-product-image": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "base64": { "type": "string", "example": "" } }, "required": ["id", "base64"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/remove-product-image": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "index": { "type": "string", "example": "1" } }, "required": ["id", "index"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-collections": { "get": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "schema": { "type": "string", "example": "5521999999999" }, "in": "query" }, { "name": "qnt", "schema": { "type": "string", "example": "10" }, "in": "query" }, { "name": "max", "schema": { "type": "string", "example": "10" }, "in": "query" } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/create-collection": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Collection name" }, "products": { "type": "array", "example": ["", ""], "items": { "type": "string" } } }, "required": ["name", "products"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/edit-collection": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "options": { "type": "object", "properties": { "name": { "type": "string", "example": "New name for collection" } } } }, "required": ["id", "options"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/del-collection": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "" } }, "required": ["id"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-link-catalog": { "post": { "tags": ["Messages"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phones": { "type": "array", "example": ["" }, "value": { "type": "boolean", "example": false } }, "required": ["id", "value"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/set-cart-enabled": { "post": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } }, "required": ["enabled"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-text-storie": { "post": { "tags": ["Status Stories"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "My new storie" }, "options": { "type": "object", "properties": { "backgroundColor": { "type": "string", "example": "#0275d8" }, "font": { "type": "number", "example": 2 } } } }, "required": ["text", "options"] } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-image-storie": { "post": { "tags": ["Status Stories"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "path": { "type": "string", "example": "Path of your image" } }, "required": ["path"] } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/send-video-storie": { "post": { "tags": ["Status Stories"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "path": { "type": "string", "example": "Path of your video" } }, "required": ["path"] } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/add-new-label": { "post": { "tags": ["Labels"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Name of your label" }, "options": { "type": "object", "properties": { "labelColor": { "type": "number", "example": 4292849392 } } } }, "required": ["name", "options"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/add-or-remove-label": { "post": { "tags": ["Labels"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "chatIds": { "type": "array", "example": ["5521999999999"], "items": { "type": "string" } }, "options": { "type": "array", "items": { "type": "object", "properties": { "labelId": { "type": "string", "example": "75" }, "type": { "type": "string", "example": "remove" } } } } }, "required": ["chatIds", "options"] } } ], "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-all-labels": { "get": { "tags": ["Labels"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/delete-all-labels": { "put": { "tags": ["Labels"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/delete-label/{id}": { "put": { "tags": ["Labels"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "201": { "description": "Created" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/check-number-status/{phone}": { "get": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/all-contacts": { "get": { "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {} } }, "/api/{session}/contact/{phone}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/profile/{phone}": { "get": { "tags": ["Chat"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ], "deprecated": true } }, "/api/{session}/profile-pic/{phone}": { "get": { "tags": ["Contact"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/profile-status/{phone}": { "get": { "tags": ["Contact"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string", "example": "5521999999999" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/blocklist": { "get": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/block-contact": { "post": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false } }, "required": ["phone", "isGroup"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/unblock-contact": { "post": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "5521999999999" }, "isGroup": { "type": "boolean", "example": false } }, "required": ["phone", "isGroup"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-battery-level": { "get": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/host-device": { "get": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-phone-number": { "get": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/set-profile-pic": { "post": { "tags": ["Profile"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "file", "in": "formData", "required": true, "schema": { "type": "file" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/profile-status": { "post": { "tags": ["Profile"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "My new status" } }, "required": ["status"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/change-username": { "post": { "tags": ["Profile"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "New name" } }, "required": ["name"] } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/edit-business-profile": { "post": { "tags": ["Profile"], "description": "Edit your bussiness profile", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "adress": { "type": "string", "example": "Av. Nossa Senhora de Copacabana, 315" }, "email": { "type": "string", "example": "test@test.com.br" }, "categories": { "type": "object", "properties": { "id": { "type": "string", "example": "133436743388217" }, "localized_display_name": { "type": "string", "example": "Artes e entretenimento" }, "not_a_biz": { "type": "boolean", "example": false } }, "required": ["id", "localized_display_name", "not_a_biz"] }, "website": { "type": "array", "example": [ "https://www.wppconnect.io", "https://www.teste2.com.br" ], "items": { "type": "string" } } }, "required": ["adress", "email", "categories", "website"] } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-business-profiles-products": { "get": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/get-order-by-messageId": { "get": { "tags": ["Catalog & Bussiness"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "messageId": { "type": "string", "example": "" } }, "required": ["messageId"] } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/api/{secretkey}/backup-sessions": { "get": { "tags": ["Misc"], "description": "Please, open the router in your browser, in swagger this not run", "produces": ["application/zip"], "parameters": [ { "name": "secretkey", "in": "path", "required": true, "schema": { "type": "string", "example": "THISISMYSECURETOKEN" } } ], "responses": { "200": { "description": "A ZIP file contaings your backup. Please, open this link in your browser", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/{secretkey}/restore-sessions": { "post": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "secretkey", "in": "path", "required": true, "schema": { "type": "string", "example": "THISISMYSECURETOKEN" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": ["file"] } } } } } }, "/api/{session}/take-screenshot": { "get": { "tags": ["Misc"], "description": "", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/{session}/chatwoot": { "post": { "tags": ["Misc"], "description": "You can point your Chatwoot to this route so that it can perform functions.", "parameters": [ { "name": "session", "in": "path", "required": true, "schema": { "type": "string", "example": "NERDWHATS_AMERICA" } }, { "name": "obj", "in": "body", "schema": { "type": "object", "properties": { "event": { "type": "string", "example": "conversation_status_changed" }, "private": { "type": "string", "example": "false" } }, "required": ["event", "private"] } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" } }, "security": [ { "bearerAuth": [] } ] } }, "/api-docs": { "get": { "description": "", "parameters": [], "responses": {} } }, "/healthz": { "get": { "tags": ["Misc"], "description": "This endpoint can be used to check the health status of the API. It returns a response with a status code indicating the API", "parameters": [], "responses": {} } }, "/unhealthy": { "get": { "tags": ["Misc"], "description": "This endpoint is used to force the API into an unhealthy state. It can be useful for testing error handling or simulating service disruptions.", "parameters": [], "responses": {} } } }, "components": { "schemas": { "session": { "type": "string", "schema": "NERDWHATS_AMERICA" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }