{ "openapi": "3.0.0", "info": { "title": "WhatsApp API", "description": "API Wrapper for WhatsAppWebJS", "version": "1.0.0" }, "servers": [ { "url": "", "description": "" }, { "url": "http://localhost:3000", "description": "localhost" } ], "tags": [ { "name": "Session", "description": "Handling multiple sessions logic, creation and deletion" }, { "name": "Client", "description": "All functions related to the client" }, { "name": "Message", "description": "May fail if the message is too old (Only from the last 100 Messages of the given chat)" } ], "paths": { "/ping": { "get": { "tags": [ "Various" ], "description": "", "parameters": [], "responses": { "200": { "description": "OK" } } } }, "/localCallbackExample": { "post": { "tags": [ "Various" ], "description": "", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/session/start/{sessionId}": { "get": { "tags": [ "Session" ], "summary": "Start new session", "description": "Starts a session for the given session ID.", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "Status of the initiated session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartSessionResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/session/status/{sessionId}": { "get": { "tags": [ "Session" ], "summary": "Get session status", "description": "Status of the session with the given session ID.", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "Status of the session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusSessionResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/session/qr/{sessionId}": { "get": { "tags": [ "Session" ], "summary": "Get session QR code", "description": "QR code of the session with the given session ID.", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/session/qr/{sessionId}/image": { "get": { "tags": [ "Session" ], "summary": "Get session QR code as image", "description": "QR code as image of the session with the given session ID.", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "QR image.", "content": { "image/png": {} } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/session/terminate/{sessionId}": { "get": { "tags": [ "Session" ], "summary": "Terminate session", "description": "Terminates the session with the given session ID.", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "Sessions terminated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateSessionResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/session/terminateInactive": { "get": { "tags": [ "Session" ], "summary": "Terminate inactive sessions", "description": "Terminates all inactive sessions.", "parameters": [], "responses": { "200": { "description": "Sessions terminated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateSessionsResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "500": { "description": "Server Failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/session/terminateAll": { "get": { "tags": [ "Session" ], "summary": "Terminate all sessions", "description": "Terminates all sessions.", "parameters": [], "responses": { "200": { "description": "Sessions terminated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateSessionsResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "500": { "description": "Server Failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/getClassInfo/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/acceptInvite/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteCode": { "type": "string", "description": "Invitation code", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "inviteCode": { "type": "string", "description": "Invitation code", "example": "" } } } } } } } }, "/client/archiveChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/createGroup/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/getBlockedContacts/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/getChatById/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/getChatLabels/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/getChats/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/getChatsByLabelId/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "description": "ID of the label", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "description": "ID of the label", "example": "" } } } } } } } }, "/client/getCommonGroups/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "The whatsapp user's ID (_serialized format)", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "The whatsapp user's ID (_serialized format)", "example": "" } } } } } } } }, "/client/getContactById/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "The whatsapp user's ID", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "The whatsapp user's ID", "example": "" } } } } } } } }, "/client/getContacts/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/getInviteInfo/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteCode": { "type": "string", "description": "Invitation code", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "inviteCode": { "type": "string", "description": "Invitation code", "example": "" } } } } } } } }, "/client/getLabelById/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "description": "ID of the label", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "description": "ID of the label", "example": "" } } } } } } } }, "/client/getLabels/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/addOrRemoveLabels/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "labelIds": { "type": "array", "description": "Array of label IDs", "example": [] }, "chatIds": { "type": "array", "description": "Array of chat IDs", "example": [] } } } }, "application/xml": { "schema": { "type": "object", "properties": { "labelIds": { "type": "array", "description": "Array of label IDs", "example": [] }, "chatIds": { "type": "array", "description": "Array of chat IDs", "example": [] } } } } } } } }, "/client/getNumberId/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "number": { "type": "string", "description": "The number or ID ('@c.us' will be automatically appended if not specified)", "example": "6281288888888" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "number": { "type": "string", "description": "The number or ID ('@c.us' will be automatically appended if not specified)", "example": "6281288888888" } } } } } } } }, "/client/isRegisteredUser/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "number": { "type": "string", "description": "The number or ID ('@c.us' will be automatically appended if not specified)", "example": "6281288888888" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "number": { "type": "string", "description": "The number or ID ('@c.us' will be automatically appended if not specified)", "example": "6281288888888" } } } } } } } }, "/client/getProfilePicUrl/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "The contact ID's of profile", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "The contact ID's of profile", "example": "6281288888888@c.us" } } } } } } } }, "/client/getState/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/markChatUnread/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/muteChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" }, "unmuteDate": { "type": "string", "description": "Date when the chat will be muted, leave as is to mute forever", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" }, "unmuteDate": { "type": "string", "description": "Date when the chat will be muted, leave as is to mute forever", "example": "" } } } } } } } }, "/client/pinChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/searchMessages/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search string", "example": "" }, "options": { "type": "object", "description": "Search options", "example": {} } } } }, "application/xml": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search string", "example": "" }, "options": { "type": "object", "description": "Search options", "example": {} } } } } } } } }, "/client/sendMessage/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message (Group or Individual)" }, "contentType": { "type": "string", "description": "The type of message content, must be one of the following: string, MessageMedia, MessageMediaFromURL, Location, Buttons, or List" }, "content": { "type": "object", "description": "The content of the message, can be a string or an object" }, "options": { "type": "object", "description": "The message send options" } } }, "examples": { "string": { "value": { "chatId": "6281288888888@c.us", "contentType": "string", "content": "Hello World!" } }, "MessageMedia": { "value": { "chatId": "6281288888888@c.us", "contentType": "MessageMedia", "content": { "mimetype": "image/jpeg", "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "filename": "image.jpg" } } }, "MessageMediaFromURL": { "value": { "chatId": "6281288888888@c.us", "contentType": "MessageMediaFromURL", "content": "https://api.qrserver.com/v1/create-qr-code/?size=150x150&data=Example" } }, "Location": { "value": { "chatId": "6281288888888@c.us", "contentType": "Location", "content": { "latitude": -6.2, "longitude": 106.8, "description": "Jakarta" } } }, "Buttons": { "value": { "chatId": "6281288888888@c.us", "contentType": "Buttons", "content": { "body": "Hello World!", "buttons": [ { "body": "button 1" } ], "title": "Hello World!", "footer": "Hello World!" } } }, "List": { "value": { "chatId": "6281288888888@c.us", "contentType": "List", "content": { "body": "Hello World!", "buttonText": "Hello World!", "sections": [ { "title": "sectionTitle", "rows": [ { "id": "customId", "title": "ListItem2", "description": "desc" }, { "title": "ListItem2" } ] } ], "title": "Hello World!", "footer": "Hello World!" } } }, "Contact": { "value": { "chatId": "6281288888888@c.us", "contentType": "Contact", "content": { "contactId": "6281288888889@c.us" } } }, "Poll": { "value": { "chatId": "6281288888888@c.us", "contentType": "Poll", "content": { "pollName": "Cats or Dogs?", "pollOptions": [ "Cats", "Dogs" ], "options": { "allowMultipleAnswers": true } } } } } } } } } }, "/client/sendPresenceAvailable/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/sendPresenceUnavailable/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/client/sendSeen/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/setDisplayName/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "displayName": { "type": "string", "description": "New display name", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "displayName": { "type": "string", "description": "New display name", "example": "" } } } } } } } }, "/client/setProfilePicture/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pictureMimetype": { "type": "string", "description": "The mimetype of the picture to set as the profile picture for the user WhatsApp account.", "example": "image/png" }, "pictureData": { "type": "string", "description": "The base64 data of the picture to set as the profile picture for the user WhatsApp account.", "example": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX +/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII=" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "pictureMimetype": { "type": "string", "description": "The mimetype of the picture to set as the profile picture for the user WhatsApp account.", "example": "image/png" }, "pictureData": { "type": "string", "description": "The base64 data of the picture to set as the profile picture for the user WhatsApp account.", "example": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX +/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII=" } } } } } } } }, "/client/setStatus/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "New status message", "example": "I'm running WhatsApp Web Api" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "New status message", "example": "I'm running WhatsApp Web Api" } } } } } } } }, "/client/unarchiveChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/unmuteChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/unpinChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "ID of the chat", "example": "" } } } } } } } }, "/client/getWWebVersion/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/chat/getClassInfo/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/chat/clearMessages/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/chat/clearState/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/chat/delete/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/chat/fetchMessages/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" }, "searchOptions": { "type": "object", "description": "Search options for fetching messages", "example": "{}" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" }, "searchOptions": { "type": "object", "description": "Search options for fetching messages", "example": "{}" } } } } } } } }, "/chat/getContact/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/chat/sendStateRecording/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/chat/sendStateTyping/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/getClassInfo/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/addParticipants/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/demoteParticipants/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/getInviteCode/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/leave/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/promoteParticipants/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/removeParticipants/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/revokeInvite/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/setDescription/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/setInfoAdminsOnly/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/setMessagesAdminsOnly/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/setSubject/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/setPicture/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/groupChat/deletePicture/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Unique whatsApp identifier for the given Chat (either group or personnal)", "example": "6281288888888@c.us" } } } } } } } }, "/message/getClassInfo/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/delete/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/downloadMedia/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/forward/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/getInfo/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/getMentions/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/getOrder/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/getPayment/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/getQuotedMessage/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/react/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/reply/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/star/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/message/unstar/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "description": "The Chat id which contains the message", "example": "6281288888888@c.us" }, "messageId": { "type": "string", "description": "Unique whatsApp identifier for the message", "example": "ABCDEF999999999" } } } } } } } }, "/contact/getClassInfo/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } } } } } }, "/contact/block/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } } } } } }, "/contact/getAbout/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } } } } } }, "/contact/getChat/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } } } } } }, "/contact/unblock/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } } } } } }, "/contact/getFormattedNumber/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } } } } } }, "/contact/getCountryCode/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } } } } } }, "/contact/getProfilePicUrl/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the session (alphanumeric and - allowed)", "example": "f8377d8d-a589-4242-9ba6-9486a04ef80c" } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Not Found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Unprocessable Entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Unique whatsApp identifier for the contact", "example": "6281288888888@c.us" } } } } } } } } }, "components": { "schemas": { "StartSessionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Session initiated successfully" } }, "xml": { "name": "StartSessionResponse" } }, "StatusSessionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "state": { "type": "string", "example": "CONNECTED" }, "message": { "type": "string", "example": "session_connected" } }, "xml": { "name": "StatusSessionResponse" } }, "TerminateSessionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Logged out successfully" } }, "xml": { "name": "TerminateSessionResponse" } }, "TerminateSessionsResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Flush completed successfully" } }, "xml": { "name": "TerminateSessionsResponse" } }, "ErrorResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Some server error" } }, "xml": { "name": "ErrorResponse" } }, "NotFoundResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Some server error" } }, "xml": { "name": "NotFoundResponse" } }, "ForbiddenResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Invalid API key" } }, "xml": { "name": "ForbiddenResponse" } } }, "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } } } }