{"openapi":"3.0.3","info":{"title":"open-wa Easy API","version":"5.0.0"},"servers":[{"url":"http://openwa.apolocrm.es"}],"paths":{"/api/messages/sendText":{"post":{"summary":"Sends a text message to a chat","operationId":"sendText","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"content":{"type":"string","minLength":1,"description":"Message content"},"options":{"description":"Additional message options"}},"required":["to","content"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendText"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]},{"type":"string"}]}}}}}}},"/api/messages/sendTextWithMentions":{"post":{"summary":"Sends a text message that includes @mentions","operationId":"sendTextWithMentions","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"content":{"type":"string","minLength":1,"description":"Message content"},"hideTags":{"description":"Removes all tags within the message","type":"boolean"},"mentions":{"description":"List of mentioned contact IDs","type":"array","items":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}},"required":["to","content"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendTextWithMentions"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendReplyWithMentions":{"post":{"summary":"Sends a reply to a message that includes @mentions","operationId":"sendReplyWithMentions","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"content":{"type":"string","minLength":1,"description":"Message content"},"replyMessageId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"},"hideTags":{"description":"Removes all tags within the message","type":"boolean"},"mentions":{"description":"List of mentioned contact IDs","type":"array","items":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}},"required":["to","content","replyMessageId"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendReplyWithMentions"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendPaymentRequest":{"post":{"summary":"Sends a payment request message","operationId":"sendPaymentRequest","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"amount":{"type":"number","description":"Amount in 1000 format (e.g £10 => 10000)"},"currency":{"type":"string","minLength":3,"maxLength":3,"description":"3 letter currency code"},"message":{"description":"Optional message","type":"string"}},"required":["to","amount","currency"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendPaymentRequest"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendImage":{"post":{"summary":"Sends an image to a chat","operationId":"sendImage","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"imgData":{"description":"Image file (path, URL, DataURL, or Base64)","type":"string","pattern":"^data:.+;base64,.+$"},"filename":{"description":"Filename with extension","type":"string"},"caption":{"description":"Media caption","type":"string"},"id":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"},"waitForId":{"default":false,"description":"Wait for message ID","type":"boolean"}},"required":["to","imgData","waitForId"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendImage"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]},{"type":"string"}]}}}}}}},"/api/messages/sendFile":{"post":{"summary":"Sends a file or document to a chat","operationId":"sendFile","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"file":{"description":"File (path, URL, DataURL, Base64, or Buffer)","type":"string","pattern":"^data:.+;base64,.+$"},"filename":{"description":"Filename with extension","type":"string"},"caption":{"description":"Media caption","type":"string"}},"required":["to","file"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendFile"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"string"}]}}}}}}},"/api/messages/sendAudio":{"post":{"summary":"Sends an audio file to a chat","operationId":"sendAudio","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"file":{"description":"Audio file (path, URL, DataURL, or Base64)","type":"string","pattern":"^data:.+;base64,.+$"},"filename":{"description":"Filename with extension","type":"string"},"quotedMsgId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}},"required":["to","file"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendAudio"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendPtt":{"post":{"summary":"Sends a voice note (push-to-talk) to a chat","operationId":"sendPtt","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"file":{"description":"Audio file (path, URL, DataURL, or Base64)","type":"string","pattern":"^data:.+;base64,.+$"},"quotedMsgId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}},"required":["to","file"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendPtt","POST /api/sendVoiceNote","POST /api/messages/sendVoiceNote"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendVideoAsGif":{"post":{"summary":"Sends a video as an animated GIF","operationId":"sendVideoAsGif","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"file":{"description":"Video file (path, URL, DataURL, or Base64)","type":"string","pattern":"^data:.+;base64,.+$"},"filename":{"description":"Filename with extension","type":"string"},"caption":{"description":"Media caption","type":"string"},"quotedMsgId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}},"required":["to","file"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendVideoAsGif"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendLocation":{"post":{"summary":"Sends a location to a chat","operationId":"sendLocation","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"lat":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"Latitude coordinate"},"lng":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"Longitude coordinate"},"loc":{"description":"Location name or description","type":"string"},"address":{"description":"Address text","type":"string"},"url":{"description":"Address link","type":"string","format":"uri"}},"required":["to","lat","lng"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendLocation"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendVCard":{"post":{"summary":"Sends a contact card (vCard)","operationId":"sendVCard","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"vcard":{"type":"string","description":"vCard string"},"contactName":{"description":"Contact display name","type":"string"},"contactNumber":{"description":"Contact number with country code","type":"string"}},"required":["to","vcard"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendVCard"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/messages/sendContact":{"post":{"summary":"Sends a single contact","operationId":"sendContact","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"contactId":{"anyOf":[{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"},{"type":"array","items":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}]}},"required":["to","contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendContact"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendContacts":{"post":{"summary":"Sends multiple contacts","operationId":"sendMultipleContacts","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"contactIds":{"type":"array","items":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}},"required":["to","contactIds"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendMultipleContacts","POST /api/sendContacts","POST /api/messages/sendMultipleContacts"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendButtons":{"post":{"summary":"Sends a button message (deprecated)","operationId":"sendButtons","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"body":{"anyOf":[{"type":"string"},{}],"description":"Message body or location"},"buttons":{"maxItems":3,"type":"array","items":{},"description":"Array of buttons (max 3)"},"title":{"description":"Message title","type":"string"},"footer":{"description":"Message footer","type":"string"}},"required":["to","body","buttons"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendButtons"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendAdvancedButtons":{"post":{"summary":"Sends an advanced button message with media (deprecated)","operationId":"sendAdvancedButtons","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"body":{"anyOf":[{"type":"string"},{}],"description":"Message body, location, or media"},"buttons":{"maxItems":3,"type":"array","items":{},"description":"Array of advanced buttons (max 3)"},"text":{"type":"string","description":"Message text"},"footer":{"type":"string","description":"Message footer"},"filename":{"type":"string","description":"Filename if body is a file"}},"required":["to","body","buttons","text","footer","filename"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendAdvancedButtons"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendList":{"post":{"summary":"Sends a list/menu message (deprecated)","operationId":"sendListMessage","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"sections":{"type":"array","items":{},"description":"List sections"},"title":{"type":"string","description":"List title"},"description":{"type":"string","description":"List description"},"actionText":{"type":"string","description":"Action button text"}},"required":["to","sections","title","description","actionText"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendListMessage","POST /api/sendList"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendPoll":{"post":{"summary":"Sends a poll message","operationId":"sendPoll","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"name":{"type":"string","description":"Poll question"},"options":{"minItems":2,"maxItems":12,"type":"array","items":{"type":"string"},"description":"Poll options (2-12)"},"selectableCount":{"default":1,"description":"Number of selectable options","type":"number"}},"required":["to","name","options","selectableCount"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendPoll"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendBanner":{"post":{"summary":"Sends a banner image","operationId":"sendBanner","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"base64":{"type":"string","description":"Base64 encoded JPEG"}},"required":["to","base64"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendBanner"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendYouTubeLink":{"post":{"summary":"Sends a YouTube link with auto-generated preview","operationId":"sendYouTubeLink","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"url":{"type":"string","format":"uri","description":"YouTube URL"},"text":{"default":"","type":"string","minLength":1,"description":"Message content"},"thumbnail":{"description":"Base64 thumbnail override","type":"string"},"quotedMsgId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"},"customSize":{"description":"Custom thumbnail size","type":"object","properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["height","width"],"additionalProperties":false}},"required":["to","url","text"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendYouTubeLink","POST /api/sendYoutubeLink","POST /api/messages/sendYoutubeLink"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendLinkWithAutoPreview":{"post":{"summary":"Sends a link with auto-generated preview","operationId":"sendLinkWithAutoPreview","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"url":{"type":"string","format":"uri","description":"Link URL"},"text":{"type":"string","minLength":1,"description":"Message content"},"thumbnail":{"description":"Base64 thumbnail override","type":"string"},"quotedMsgId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"},"customSize":{"description":"Custom thumbnail size","type":"object","properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["height","width"],"additionalProperties":false}},"required":["to","url"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendLinkWithAutoPreview","POST /api/sendLink","POST /api/messages/sendLink"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/sendLinkWithThumbnail":{"post":{"summary":"Sends a link preview message with custom thumbnail","operationId":"sendMessageWithThumb","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"thumb":{"type":"string","description":"Base64 thumbnail (max 200x200px)"},"url":{"type":"string","format":"uri","description":"Link URL"},"title":{"type":"string","description":"Link title"},"description":{"type":"string","description":"Link description"},"content":{"type":"string","minLength":1,"description":"Message content"},"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"quotedMsgId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"},"customSize":{"description":"Custom thumbnail size","type":"object","properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["height","width"],"additionalProperties":false}},"required":["thumb","url","title","description","content","to"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendMessageWithThumb","POST /api/sendLinkWithThumbnail","POST /api/messages/sendWithThumb"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}},{"type":"boolean"}]}}}}}}},"/api/messages/forward":{"post":{"summary":"Forwards messages to a chat","operationId":"forwardMessages","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"messages":{"anyOf":[{"type":"array","items":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}},{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}],"description":"Message ID(s) to process"},"skipMyMessages":{"default":false,"description":"Skip own messages","type":"boolean"}},"required":["to","messages","skipMyMessages"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/forwardMessages"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"_serialized":{"type":"string"}},"required":["_serialized"],"additionalProperties":{}}},{"type":"boolean"}]}}}}}}},"/api/messages/delete":{"delete":{"summary":"Deletes a message","operationId":"deleteMessage","tags":["messages"],"parameters":[{"name":"chatId","in":"query","required":true,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},{"name":"messageId","in":"query","required":true,"description":"Message ID(s) to process","schema":{"anyOf":[{"type":"array","items":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}},{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}],"description":"Message ID(s) to process"}},{"name":"onlyLocal","in":"query","required":true,"description":"Delete only locally","schema":{"default":false,"description":"Delete only locally","type":"boolean"}}],"x-openwa-aliases":["DELETE /api/deleteMessage"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/messages/get":{"get":{"summary":"Retrieves a specific message by ID","operationId":"getMessageById","tags":["messages"],"parameters":[{"name":"messageId","in":"query","required":true,"description":"Message ID","schema":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}}],"x-openwa-aliases":["GET /api/getMessageById","GET /api/getMessage","GET /api/messages/getById"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/messages/getAll":{"get":{"summary":"Retrieves all messages in the session","operationId":"getAllMessages","tags":["messages"],"parameters":[{"name":"chatId","in":"query","required":false,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},{"name":"includeMe","in":"query","required":true,"description":"Include own messages","schema":{"default":true,"description":"Include own messages","type":"boolean"}},{"name":"includeNotifications","in":"query","required":true,"description":"Include notification messages","schema":{"default":false,"description":"Include notification messages","type":"boolean"}}],"x-openwa-aliases":["GET /api/getAllMessages","GET /api/listMessages","GET /api/messages/all","GET /api/messages/list"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/messages/getMyLast":{"get":{"summary":"Get last message sent by host","operationId":"getMyLastMessage","tags":["messages"],"parameters":[{"name":"chatId","in":"query","required":false,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}}],"x-openwa-aliases":["GET /api/getMyLastMessage"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/messages/getStarred":{"get":{"summary":"Get starred messages","operationId":"getStarredMessages","tags":["messages"],"parameters":[{"name":"chatId","in":"query","required":false,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}}],"x-openwa-aliases":["GET /api/getStarredMessages"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/messages/getUnsent":{"get":{"summary":"Get unsent/pending messages","operationId":"getUnsentMessages","tags":["messages"],"parameters":[],"x-openwa-aliases":["GET /api/getUnsentMessages"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/messages/getInfo":{"get":{"summary":"Get message delivery info","operationId":"getMessageInfo","tags":["messages"],"parameters":[{"name":"messageId","in":"query","required":true,"description":"Message ID","schema":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}}],"x-openwa-aliases":["GET /api/getMessageInfo"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/messages/getVCards":{"get":{"summary":"Extract vCards from message","operationId":"getVCards","tags":["messages"],"parameters":[{"name":"messageId","in":"query","required":true,"description":"Message ID","schema":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}}],"x-openwa-aliases":["GET /api/getVCards"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/messages/getForLLM":{"get":{"summary":"Get messages formatted for LLMs","operationId":"getMessagesForLLM","tags":["messages"],"parameters":[{"name":"chatId","in":"query","required":true,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},{"name":"last","in":"query","required":true,"description":"Argument: last","schema":{"default":10,"type":"number"}}],"x-openwa-aliases":["GET /api/getMessagesForLLM","GET /api/getGptArray","GET /api/messages/getGptArray"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/messages/star":{"put":{"summary":"Star a message","operationId":"starMessage","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messageId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}},"required":["messageId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/starMessage"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/messages/unstar":{"put":{"summary":"Unstar a message","operationId":"unstarMessage","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messageId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"}},"required":["messageId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/unstarMessage"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/messages/react":{"post":{"summary":"React to message with emoji","operationId":"react","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messageId":{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"},"emoji":{"type":"string","description":"Emoji reaction"}},"required":["messageId","emoji"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/react"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/messages/sendSeen":{"put":{"summary":"Mark message as seen","operationId":"sendSeen","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/sendSeen"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/messages/loadEarlier":{"post":{"summary":"Loads earlier messages from a chat","operationId":"loadEarlierMessages","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"count":{"description":"Number of messages to load (default: 20)","type":"number","minimum":0,"exclusiveMinimum":true},"includeMe":{"description":"Whether to include messages from the host account (default: false)","type":"boolean"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/loadEarlierMessages","POST /api/loadOlderMessages","POST /api/messages/loadOlder"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/messages/sendFileFromUrl":{"post":{"summary":"Downloads a file from a URL and sends it to a chat","operationId":"sendFileFromUrl","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"url":{"type":"string","format":"uri","description":"URL of the file to download"},"filename":{"type":"string","description":"Filename for the sent file"},"caption":{"description":"Caption for the file","type":"string"},"headers":{"description":"HTTP headers for the download request","type":"object","additionalProperties":{"type":"string"}}},"required":["to","url","filename"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/sendFileFromUrl"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"string"},{"type":"boolean"}],"description":"Message ID or success status"}}}}}}},"/api/chats/getAll":{"get":{"summary":"Retrieves all chats","operationId":"getAllChats","tags":["chats"],"parameters":[{"name":"withNewMessagesOnly","in":"query","required":true,"description":"Only chats with unread messages","schema":{"default":false,"description":"Only chats with unread messages","type":"boolean"}}],"x-openwa-aliases":["GET /api/getAllChats","GET /api/listChats","GET /api/chats/all","GET /api/chats/list"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/chatIds/getAll":{"get":{"summary":"Get all chat IDs","operationId":"getAllChatIds","tags":["chatIds"],"parameters":[],"x-openwa-aliases":["GET /api/getAllChatIds","GET /api/chats/ids","GET /api/listChatIds","GET /api/chatIds/all","GET /api/chatIds/list"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/chats/get":{"get":{"summary":"Get specific chat by ID","operationId":"getChat","tags":["chats"],"parameters":[{"name":"chatId","in":"query","required":true,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}}],"x-openwa-aliases":["GET /api/getChat","GET /api/getChatById","GET /api/chats/getById"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/chats/getWithNonContacts":{"get":{"summary":"Get chats with non-contacts","operationId":"getChatWithNonContacts","tags":["chats"],"parameters":[],"x-openwa-aliases":["GET /api/getChatWithNonContacts"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/chats/archive":{"put":{"summary":"Archive a chat","operationId":"archiveChat","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/archiveChat"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/unarchive":{"put":{"summary":"Unarchive a chat","operationId":"unarchiveChat","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/unarchiveChat"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/clear":{"delete":{"summary":"Clear chat history","operationId":"clearChat","tags":["chats"],"parameters":[{"name":"chatId","in":"query","required":true,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}}],"x-openwa-aliases":["DELETE /api/clearChat"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/delete":{"delete":{"summary":"Delete a chat","operationId":"deleteChat","tags":["chats"],"parameters":[{"name":"chatId","in":"query","required":true,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}}],"x-openwa-aliases":["DELETE /api/deleteChat"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/pin":{"put":{"summary":"Pin a chat","operationId":"pinChat","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/pinChat"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/unpin":{"put":{"summary":"Unpin a chat","operationId":"unpinChat","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/unpinChat"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/mute":{"put":{"summary":"Mute a chat","operationId":"muteChat","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"muteDuration":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"Mute duration"}},"required":["chatId","muteDuration"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/muteChat"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}}}}}}},"/api/chats/unmute":{"put":{"summary":"Unmute a chat","operationId":"unmuteChat","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/unmuteChat"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}}}}}}},"/api/chats/markAsRead":{"put":{"summary":"Mark chat as read","operationId":"markAsRead","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/markAsRead"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/markAsUnread":{"put":{"summary":"Mark chat as unread","operationId":"markAsUnread","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/markAsUnread"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/setEphemeral":{"put":{"summary":"Set ephemeral messages for chat","operationId":"setChatEphemeral","tags":["chats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chatId":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"},"ephemeral":{"anyOf":[{"type":"boolean"},{"type":"number"}],"description":"Ephemeral setting"}},"required":["chatId","ephemeral"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setChatEphemeral"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/chats/isOnline":{"get":{"summary":"Check if chat is online","operationId":"isChatOnline","tags":["chats"],"parameters":[{"name":"chatId","in":"query","required":true,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}}],"x-openwa-aliases":["GET /api/isChatOnline"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"boolean"},{"type":"string"}]}}}}}}},"/api/contacts/getAll":{"get":{"summary":"Retrieves all contacts","operationId":"getAllContacts","tags":["contacts"],"parameters":[],"x-openwa-aliases":["GET /api/getAllContacts","GET /api/listContacts","GET /api/contacts/all","GET /api/contacts/list"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/contacts/get":{"get":{"summary":"Get specific contact","operationId":"getContact","tags":["contacts"],"parameters":[{"name":"contactId","in":"query","required":true,"description":"Contact ID","schema":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}],"x-openwa-aliases":["GET /api/getContact"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/contacts/getCommonGroups":{"get":{"summary":"Get common groups with contact","operationId":"getCommonGroups","tags":["contacts"],"parameters":[{"name":"contactId","in":"query","required":true,"description":"Contact ID","schema":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}],"x-openwa-aliases":["GET /api/getCommonGroups"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/contacts/getNumberProfile":{"get":{"summary":"Get profile of number","operationId":"getNumberProfile","tags":["contacts"],"parameters":[{"name":"contactId","in":"query","required":true,"description":"Contact ID","schema":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}],"x-openwa-aliases":["GET /api/getNumberProfile"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/contacts/getBlockedIds":{"get":{"summary":"Get blocked contact IDs","operationId":"getBlockedIds","tags":["contacts"],"parameters":[],"x-openwa-aliases":["GET /api/getBlockedIds"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/contacts/block":{"put":{"summary":"Block a contact","operationId":"blockContact","tags":["contacts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactId":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}},"required":["contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/blockContact","PUT /api/contactBlock","PUT /api/contacts/contactBlock"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/contacts/unblock":{"put":{"summary":"Unblock a contact","operationId":"unblockContact","tags":["contacts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactId":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}},"required":["contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/unblockContact","PUT /api/contactUnblock","PUT /api/contacts/contactUnblock"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/contacts/checkReadReceipts":{"get":{"summary":"Check read receipts setting","operationId":"checkReadReceipts","tags":["contacts"],"parameters":[{"name":"contactId","in":"query","required":true,"description":"Contact ID","schema":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}],"x-openwa-aliases":["GET /api/checkReadReceipts","GET /api/getReadReceipts","GET /api/contacts/getReadReceipts"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"boolean"},{"type":"string"}]}}}}}}},"/api/contacts/checkNumberStatus":{"get":{"summary":"Check if number is on WhatsApp","operationId":"checkNumberStatus","tags":["contacts"],"parameters":[{"name":"contactId","in":"query","required":true,"description":"Contact ID","schema":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}],"x-openwa-aliases":["GET /api/checkNumberStatus"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/contacts/getProfilePicture":{"get":{"summary":"Get profile picture from server","operationId":"getProfilePicture","tags":["contacts"],"parameters":[{"name":"chatId","in":"query","required":true,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}}],"x-openwa-aliases":["GET /api/getProfilePicture","GET /api/getProfilePicFromServer","GET /api/contacts/getProfilePicFromServer"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/groups/getMembers":{"get":{"summary":"Retrieves members of a group","operationId":"getGroupMembers","tags":["groups"],"parameters":[{"name":"groupId","in":"query","required":true,"description":"Group chat ID","schema":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getGroupMembers"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/groups/getAll":{"get":{"summary":"Get all groups","operationId":"getAllGroups","tags":["groups"],"parameters":[{"name":"withNewMessagesOnly","in":"query","required":true,"description":"Only chats with unread messages","schema":{"default":false,"description":"Only chats with unread messages","type":"boolean"}}],"x-openwa-aliases":["GET /api/getAllGroups","GET /api/listGroups","GET /api/groups/all","GET /api/groups/list"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/groups/getMemberIds":{"get":{"summary":"Get group member IDs","operationId":"getGroupMembersId","tags":["groups"],"parameters":[{"name":"groupId","in":"query","required":true,"description":"Group chat ID","schema":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getGroupMembersId","GET /api/getGroupMemberIds","GET /api/groups/getMembersId"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/groups/getInfo":{"get":{"summary":"Get group metadata","operationId":"getGroupInfo","tags":["groups"],"parameters":[{"name":"groupId","in":"query","required":true,"description":"Group chat ID","schema":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getGroupInfo"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/groups/getAdmins":{"get":{"summary":"Get group admins","operationId":"getGroupAdmins","tags":["groups"],"parameters":[{"name":"groupId","in":"query","required":true,"description":"Group chat ID","schema":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getGroupAdmins"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/groups/getKicked":{"get":{"summary":"Get groups where kicked","operationId":"getKickedGroups","tags":["groups"],"parameters":[],"x-openwa-aliases":["GET /api/getKickedGroups"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/groups/getInviteLink":{"get":{"summary":"Get group invite link","operationId":"getGroupInviteLink","tags":["groups"],"parameters":[{"name":"groupId","in":"query","required":true,"description":"Group chat ID","schema":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getGroupInviteLink"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/groups/create":{"post":{"summary":"Create new group","operationId":"createGroup","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Group name"},"contacts":{"type":"array","items":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"},"description":"Contact IDs to add"}},"required":["name","contacts"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/createGroup"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/groups/leave":{"put":{"summary":"Leave a group","operationId":"leaveGroup","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}},"required":["groupId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/leaveGroup"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/groups/join":{"post":{"summary":"Join group via invite link","operationId":"joinGroupViaLink","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","format":"uri","description":"Group invite link"},"returnChatObj":{"description":"Return chat object","type":"boolean"}},"required":["link"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/joinGroupViaLink","POST /api/joinGroup","POST /api/groups/joinViaLink"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"},{}]}}}}}}},"/api/groups/revokeInviteLink":{"put":{"summary":"Revoke group invite link","operationId":"revokeGroupInviteLink","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}},"required":["groupId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/revokeGroupInviteLink"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"string"},{"type":"boolean"}]}}}}}}},"/api/groups/setTitle":{"put":{"summary":"Set group title","operationId":"setGroupTitle","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"title":{"type":"string","description":"New group title"}},"required":["groupId","title"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setGroupTitle"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/groups/setDescription":{"put":{"summary":"Set group description","operationId":"setGroupDescription","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"description":{"type":"string","description":"New group description"}},"required":["groupId","description"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setGroupDescription"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/groups/setIcon":{"put":{"summary":"Set group icon","operationId":"setGroupIcon","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"image":{"type":"string","description":"Image data URL"}},"required":["groupId","image"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setGroupIcon"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/groups/setAdminsOnly":{"put":{"summary":"Restrict group to admins only","operationId":"setGroupToAdminsOnly","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"onlyAdmins":{"type":"boolean","description":"Admins only setting"}},"required":["groupId","onlyAdmins"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setGroupToAdminsOnly","PUT /api/groups/setToAdminsOnly"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/groups/setEditAdminsOnly":{"put":{"summary":"Restrict group editing to admins only","operationId":"setGroupEditToAdminsOnly","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"onlyAdmins":{"type":"boolean","description":"Admins only setting"}},"required":["groupId","onlyAdmins"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setGroupEditToAdminsOnly","PUT /api/groups/setEditToAdminsOnly"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/groups/addParticipant":{"put":{"summary":"Add participant to group","operationId":"addParticipant","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"contactId":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}},"required":["groupId","contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/addParticipant","PUT /api/addGroupParticipant"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/groups/removeParticipant":{"put":{"summary":"Remove participant from group","operationId":"removeParticipant","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"contactId":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}},"required":["groupId","contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/removeParticipant","PUT /api/removeGroupParticipant"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/groups/promoteParticipant":{"put":{"summary":"Promote participant to admin","operationId":"promoteParticipant","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"contactId":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}},"required":["groupId","contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/promoteParticipant","PUT /api/promoteGroupParticipant"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"boolean"},{"type":"string"}]}}}}}}},"/api/groups/demoteParticipant":{"put":{"summary":"Demote participant from admin","operationId":"demoteParticipant","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"contactId":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}},"required":["groupId","contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/demoteParticipant","PUT /api/demoteGroupParticipant"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"boolean"},{"type":"string"}]}}}}}}},"/api/groups/approveJoinRequest":{"put":{"summary":"Approve group join request","operationId":"approveGroupJoinRequest","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"contactId":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}},"required":["groupId","contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/approveGroupJoinRequest"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"string"},{"type":"boolean"}]}}}}}}},"/api/groups/rejectJoinRequest":{"put":{"summary":"Reject group join request","operationId":"rejectGroupJoinRequest","tags":["groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"description":"Group chat ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"},"contactId":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}},"required":["groupId","contactId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/rejectGroupJoinRequest"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"string"},{"type":"boolean"}]}}}}}}},"/api/communities/getAll":{"get":{"summary":"Get all communities","operationId":"getAllCommunities","tags":["communities"],"parameters":[],"x-openwa-aliases":["GET /api/getAllCommunities","GET /api/listCommunities","GET /api/communities/all","GET /api/communities/list"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/communities/getInfo":{"get":{"summary":"Get community metadata","operationId":"getCommunityInfo","tags":["communities"],"parameters":[{"name":"communityId","in":"query","required":true,"description":"Community ID","schema":{"description":"Community ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getCommunityInfo"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/communities/getParticipantIds":{"get":{"summary":"Get community participant IDs","operationId":"getCommunityParticipantIds","tags":["communities"],"parameters":[{"name":"communityId","in":"query","required":true,"description":"Community ID","schema":{"description":"Community ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getCommunityParticipantIds"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/communities/getAdminIds":{"get":{"summary":"Get community admin IDs","operationId":"getCommunityAdminIds","tags":["communities"],"parameters":[{"name":"communityId","in":"query","required":true,"description":"Community ID","schema":{"description":"Community ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getCommunityAdminIds"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/communities/getParticipants":{"get":{"summary":"Get community participants","operationId":"getCommunityParticipants","tags":["communities"],"parameters":[{"name":"communityId","in":"query","required":true,"description":"Community ID","schema":{"description":"Community ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getCommunityParticipants"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/communities/getAdmins":{"get":{"summary":"Get community admins","operationId":"getCommunityAdmins","tags":["communities"],"parameters":[{"name":"communityId","in":"query","required":true,"description":"Community ID","schema":{"description":"Community ID","type":"string","pattern":"^\\d+(-\\d+)?@g\\.us$"}}],"x-openwa-aliases":["GET /api/getCommunityAdmins"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/status/postText":{"post":{"summary":"Post text status","operationId":"postTextStatus","tags":["status"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"Status text"},"backgroundColor":{"description":"Background color","type":"string"},"font":{"description":"Font style","type":"number"}},"required":["text"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/postTextStatus"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/status/postImage":{"post":{"summary":"Post image status","operationId":"postImageStatus","tags":["status"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"image":{"type":"string","description":"Image data URL"},"caption":{"description":"Status caption","type":"string"}},"required":["image"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/postImageStatus"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/status/postVideo":{"post":{"summary":"Post video status","operationId":"postVideoStatus","tags":["status"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"video":{"type":"string","description":"Video data URL"},"caption":{"description":"Status caption","type":"string"}},"required":["video"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/postVideoStatus"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/status/getAll":{"get":{"summary":"Get all stories","operationId":"getStories","tags":["status"],"parameters":[],"x-openwa-aliases":["GET /api/getStories","GET /api/getStatuses","GET /api/status/getStories","GET /api/status/get"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/mystatus/getStatus":{"get":{"summary":"Get specific status","operationId":"getStatus","tags":["mystatus"],"parameters":[{"name":"contactId","in":"query","required":true,"description":"Contact ID","schema":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}],"x-openwa-aliases":["GET /api/getStatus"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/status/delete":{"delete":{"summary":"Delete status","operationId":"deleteStatus","tags":["status"],"parameters":[{"name":"statusesToDelete","in":"query","required":true,"description":"Status ID(s)","schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Status ID(s)"}}],"x-openwa-aliases":["DELETE /api/deleteStatus"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/status/deleteAll":{"delete":{"summary":"Delete all statuses","operationId":"deleteAllStatus","tags":["status"],"parameters":[],"x-openwa-aliases":["DELETE /api/deleteAllStatus","DELETE /api/deleteAllStatuses"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/labels/getAll":{"get":{"summary":"Get all labels","operationId":"getAllLabels","tags":["labels"],"parameters":[],"x-openwa-aliases":["GET /api/getAllLabels","GET /api/listLabels","GET /api/labels/all","GET /api/labels/list"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/labels/getChats":{"get":{"summary":"Get chats by label","operationId":"getChatsByLabel","tags":["labels"],"parameters":[{"name":"label","in":"query","required":true,"description":"Label name","schema":{"type":"string","description":"Label name"}}],"x-openwa-aliases":["GET /api/getChatsByLabel","GET /api/labels/getChatsBy"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}}},"/api/labels/add":{"put":{"summary":"Add label to chat","operationId":"addLabel","tags":["labels"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"Label ID or name"},"chatId":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["label","chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/addLabel"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/labels/remove":{"put":{"summary":"Remove label from chat","operationId":"removeLabel","tags":["labels"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"Label ID or name"},"chatId":{"description":"Recipient chat ID","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},"required":["label","chatId"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/removeLabel"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/business/getProfile":{"get":{"summary":"Get business profile","operationId":"getBusinessProfile","tags":["business"],"parameters":[{"name":"contactId","in":"query","required":true,"description":"Contact ID","schema":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}],"x-openwa-aliases":["GET /api/getBusinessProfile"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/business/getProducts":{"get":{"summary":"Get business products","operationId":"getBusinessProducts","tags":["business"],"parameters":[{"name":"contactId","in":"query","required":true,"description":"Contact ID","schema":{"description":"Contact ID","type":"string","pattern":"^\\d+@c\\.us$"}}],"x-openwa-aliases":["GET /api/getBusinessProducts","GET /api/getBusinessProfilesProducts","GET /api/business/getProfilesProducts"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/business/getOrder":{"get":{"summary":"Get order details","operationId":"getOrder","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"Order or message ID","schema":{"anyOf":[{"description":"Message ID","type":"string","pattern":"^(true|false)_.+_.+$"},{"type":"string"}],"description":"Order or message ID"}}],"x-openwa-aliases":["GET /api/getOrder"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/session/getMe":{"get":{"summary":"Get host account info","operationId":"getMe","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getMe"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/session/getHostNumber":{"get":{"summary":"Get host phone number","operationId":"getHostNumber","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getHostNumber"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/session/getConnectionState":{"get":{"summary":"Get connection state","operationId":"getConnectionState","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getConnectionState"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/session/getWAVersion":{"get":{"summary":"Get WhatsApp Web version","operationId":"getWAVersion","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getWAVersion","GET /api/getWhatsAppVersion","GET /api/session/getWhatsAppVersion"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/session/getBatteryLevel":{"get":{"summary":"Get phone battery level","operationId":"getBatteryLevel","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getBatteryLevel"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"number"}}}}}}},"/api/session/isPlugged":{"get":{"summary":"Check if phone is charging","operationId":"isPlugged","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/isPlugged","GET /api/getIsPlugged","GET /api/session/getIsPlugged"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/session/getFeatures":{"get":{"summary":"Get enabled features","operationId":"getFeatures","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getFeatures"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/session/getLicenseType":{"get":{"summary":"Get license type","operationId":"getLicenseType","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getLicenseType"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{},{"type":"boolean"}]}}}}}}},"/api/session/getUserAgent":{"get":{"summary":"Get user agent","operationId":"getUserAgent","tags":["session"],"parameters":[{"name":"userAgent","in":"query","required":false,"description":"User agent string","schema":{"description":"User agent string","type":"string"}}],"x-openwa-aliases":["GET /api/getUserAgent","GET /api/getGeneratedUserAgent","GET /api/session/getGeneratedUserAgent"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/session/getProcessStats":{"get":{"summary":"Get process statistics","operationId":"getProcessStats","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getProcessStats"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/session/getLoadedMessageCount":{"get":{"summary":"Get loaded message count","operationId":"getLoadedMessageCount","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/getLoadedMessageCount","GET /api/getAmountOfLoadedMessages","GET /api/session/getAmountOfLoadedMessages"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"number"}}}}}}},"/api/session/getSnapshot":{"get":{"summary":"Take screenshot","operationId":"getSnapshot","tags":["session"],"parameters":[{"name":"chatId","in":"query","required":false,"description":"Chat ID (phone number or formatted ID)","schema":{"description":"Chat ID (phone number or formatted ID)","type":"string","pattern":"^\\d+(-\\d+)?@(c|g)\\.us$|^\\d+@lid$"}},{"name":"width","in":"query","required":false,"description":"Argument: width","schema":{"type":"number"}},{"name":"height","in":"query","required":false,"description":"Argument: height","schema":{"type":"number"}}],"x-openwa-aliases":["GET /api/getSnapshot","GET /api/takeScreenshot","GET /api/session/takeScreenshot"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/session/healthCheck":{"get":{"summary":"Health check","operationId":"healthCheck","tags":["session"],"parameters":[],"x-openwa-aliases":["GET /api/healthCheck"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}}}},"/api/session/setName":{"put":{"summary":"Set host name","operationId":"setMyName","tags":["session"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Display name"}},"required":["name"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setMyName","PUT /api/setDisplayName","PUT /api/session/setMyName","PUT /api/session/setDisplayName"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/session/setStatus":{"put":{"summary":"Set host status","operationId":"setMyStatus","tags":["session"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"statusText":{"type":"string","description":"Status text"}},"required":["statusText"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setMyStatus","PUT /api/setStatusText","PUT /api/session/setMyStatus","PUT /api/session/setStatusText"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/session/setProfilePicture":{"put":{"summary":"Set profile picture","operationId":"setProfilePicture","tags":["session"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"image":{"description":"Image file (path, URL, DataURL, or Base64)","type":"string","pattern":"^data:.+;base64,.+$"}},"required":["image"],"additionalProperties":false}}}},"x-openwa-aliases":["PUT /api/setProfilePicture","PUT /api/setProfilePic","PUT /api/session/setProfilePic"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/api/media/decrypt":{"post":{"summary":"Decrypts media from a message","operationId":"decryptMedia","tags":["media"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"object","properties":{"id":{"type":"string"},"body":{"type":"string"},"type":{"type":"string","enum":["chat","audio","ptt","image","video","document","sticker","location","vcard","multi_vcard","revoked","order","buttons_response","list_response","unknown"]},"t":{"type":"number"},"notifyName":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"self":{"type":"string","enum":["in","out"]},"ack":{"type":"number","enum":[-1,0,1,2,3,4]},"invis":{"type":"boolean"},"isNewMsg":{"type":"boolean"},"star":{"type":"boolean"},"recvFresh":{"type":"boolean"},"broadcast":{"type":"boolean"},"isForwarded":{"type":"boolean"},"labels":{"type":"array","items":{"type":"string"}},"mentionedJidList":{"type":"array","items":{"type":"string"}},"caption":{"type":"string"},"sender":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"pushname":{"type":"string"},"formattedName":{"type":"string"},"isBusiness":{"type":"boolean"},"isEnterprise":{"type":"boolean"},"isMe":{"type":"boolean"},"isMyContact":{"type":"boolean"},"isPSA":{"type":"boolean"},"isUser":{"type":"boolean"},"isWAContact":{"type":"boolean"},"labels":{"type":"array","items":{"type":"string"}},"msgs":{"type":"array","items":{}},"profilePicThumbObj":{"type":"object","properties":{"eurl":{"type":"string"},"id":{"type":"object","properties":{"server":{"type":"string"},"user":{"type":"string"},"_serialized":{"type":"string"}},"required":["server","user","_serialized"],"additionalProperties":false},"img":{"type":"string"},"imgFull":{"type":"string"},"tag":{"type":"string"}},"additionalProperties":false},"statusMute":{"type":"boolean"},"type":{"type":"string"},"verifiedLevel":{"type":"number"},"verifiedName":{"type":"string"},"isOnline":{"type":"boolean"},"lastSeen":{"type":"number"}},"required":["id"],"additionalProperties":{}},"timestamp":{"type":"number"},"content":{"type":"string"},"isGroupMsg":{"type":"boolean"},"isMMS":{"type":"boolean"},"isMedia":{"type":"boolean"},"isNotification":{"type":"boolean"},"isPSA":{"type":"boolean"},"fromMe":{"type":"boolean"},"chat":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"string"}]},"name":{"type":"string"},"formattedTitle":{"type":"string"},"isGroup":{"type":"boolean"},"contact":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"pushname":{"type":"string"},"formattedName":{"type":"string"},"isBusiness":{"type":"boolean"},"isEnterprise":{"type":"boolean"},"isMe":{"type":"boolean"},"isMyContact":{"type":"boolean"},"isPSA":{"type":"boolean"},"isUser":{"type":"boolean"},"isWAContact":{"type":"boolean"},"labels":{"type":"array","items":{"type":"string"}},"msgs":{"type":"array","items":{}},"profilePicThumbObj":{"type":"object","properties":{"eurl":{"type":"string"},"id":{"type":"object","properties":{"server":{"type":"string"},"user":{"type":"string"},"_serialized":{"type":"string"}},"required":["server","user","_serialized"],"additionalProperties":false},"img":{"type":"string"},"imgFull":{"type":"string"},"tag":{"type":"string"}},"additionalProperties":false},"statusMute":{"type":"boolean"},"type":{"type":"string"},"verifiedLevel":{"type":"number"},"verifiedName":{"type":"string"},"isOnline":{"type":"boolean"},"lastSeen":{"type":"number"}},"required":["id"],"additionalProperties":{}},"groupMetadata":{},"presence":{},"t":{"type":"number"},"unreadCount":{"type":"number"},"lastReceivedKey":{},"msgs":{"type":"array","items":{}},"isReadOnly":{"type":"boolean"},"muteExpiration":{"type":"number"},"notSpam":{"type":"boolean"},"pin":{"type":"number"},"ack":{}},"required":["id","isGroup","contact"],"additionalProperties":{}},"chatId":{"type":"string"},"author":{"type":"string"},"clientUrl":{"type":"string"},"deprecatedMms3Url":{"type":"string"},"isQuotedMsgAvailable":{"type":"boolean"},"quotedMsg":{},"quotedMsgObj":{},"senderId":{"type":"string"}},"required":["id","body","type","t","from","to","self","ack","sender","timestamp","content","isGroupMsg","isMedia","isNotification","fromMe","chat","chatId","isQuotedMsgAvailable"],"additionalProperties":{},"description":"Message object containing media"}},"required":["message"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/decryptMedia"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","description":"Base64 encoded decrypted media"}}}}}}},"/api/media/download":{"post":{"summary":"Downloads and decrypts media from a message to a file","operationId":"downloadMedia","tags":["media"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"object","properties":{"id":{"type":"string"},"body":{"type":"string"},"type":{"type":"string","enum":["chat","audio","ptt","image","video","document","sticker","location","vcard","multi_vcard","revoked","order","buttons_response","list_response","unknown"]},"t":{"type":"number"},"notifyName":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"self":{"type":"string","enum":["in","out"]},"ack":{"type":"number","enum":[-1,0,1,2,3,4]},"invis":{"type":"boolean"},"isNewMsg":{"type":"boolean"},"star":{"type":"boolean"},"recvFresh":{"type":"boolean"},"broadcast":{"type":"boolean"},"isForwarded":{"type":"boolean"},"labels":{"type":"array","items":{"type":"string"}},"mentionedJidList":{"type":"array","items":{"type":"string"}},"caption":{"type":"string"},"sender":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"pushname":{"type":"string"},"formattedName":{"type":"string"},"isBusiness":{"type":"boolean"},"isEnterprise":{"type":"boolean"},"isMe":{"type":"boolean"},"isMyContact":{"type":"boolean"},"isPSA":{"type":"boolean"},"isUser":{"type":"boolean"},"isWAContact":{"type":"boolean"},"labels":{"type":"array","items":{"type":"string"}},"msgs":{"type":"array","items":{}},"profilePicThumbObj":{"type":"object","properties":{"eurl":{"type":"string"},"id":{"type":"object","properties":{"server":{"type":"string"},"user":{"type":"string"},"_serialized":{"type":"string"}},"required":["server","user","_serialized"],"additionalProperties":false},"img":{"type":"string"},"imgFull":{"type":"string"},"tag":{"type":"string"}},"additionalProperties":false},"statusMute":{"type":"boolean"},"type":{"type":"string"},"verifiedLevel":{"type":"number"},"verifiedName":{"type":"string"},"isOnline":{"type":"boolean"},"lastSeen":{"type":"number"}},"required":["id"],"additionalProperties":{}},"timestamp":{"type":"number"},"content":{"type":"string"},"isGroupMsg":{"type":"boolean"},"isMMS":{"type":"boolean"},"isMedia":{"type":"boolean"},"isNotification":{"type":"boolean"},"isPSA":{"type":"boolean"},"fromMe":{"type":"boolean"},"chat":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"string"}]},"name":{"type":"string"},"formattedTitle":{"type":"string"},"isGroup":{"type":"boolean"},"contact":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"pushname":{"type":"string"},"formattedName":{"type":"string"},"isBusiness":{"type":"boolean"},"isEnterprise":{"type":"boolean"},"isMe":{"type":"boolean"},"isMyContact":{"type":"boolean"},"isPSA":{"type":"boolean"},"isUser":{"type":"boolean"},"isWAContact":{"type":"boolean"},"labels":{"type":"array","items":{"type":"string"}},"msgs":{"type":"array","items":{}},"profilePicThumbObj":{"type":"object","properties":{"eurl":{"type":"string"},"id":{"type":"object","properties":{"server":{"type":"string"},"user":{"type":"string"},"_serialized":{"type":"string"}},"required":["server","user","_serialized"],"additionalProperties":false},"img":{"type":"string"},"imgFull":{"type":"string"},"tag":{"type":"string"}},"additionalProperties":false},"statusMute":{"type":"boolean"},"type":{"type":"string"},"verifiedLevel":{"type":"number"},"verifiedName":{"type":"string"},"isOnline":{"type":"boolean"},"lastSeen":{"type":"number"}},"required":["id"],"additionalProperties":{}},"groupMetadata":{},"presence":{},"t":{"type":"number"},"unreadCount":{"type":"number"},"lastReceivedKey":{},"msgs":{"type":"array","items":{}},"isReadOnly":{"type":"boolean"},"muteExpiration":{"type":"number"},"notSpam":{"type":"boolean"},"pin":{"type":"number"},"ack":{}},"required":["id","isGroup","contact"],"additionalProperties":{}},"chatId":{"type":"string"},"author":{"type":"string"},"clientUrl":{"type":"string"},"deprecatedMms3Url":{"type":"string"},"isQuotedMsgAvailable":{"type":"boolean"},"quotedMsg":{},"quotedMsgObj":{},"senderId":{"type":"string"}},"required":["id","body","type","t","from","to","self","ack","sender","timestamp","content","isGroupMsg","isMedia","isNotification","fromMe","chat","chatId","isQuotedMsgAvailable"],"additionalProperties":{},"description":"Message object containing media"},"path":{"type":"string","description":"File path to save the media"}},"required":["message","path"],"additionalProperties":false}}}},"x-openwa-aliases":["POST /api/downloadMedia"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","description":"Path to the saved file"}}}}}}}}}