🧰 open-wa API Explorer

Session: sesion_principal · Base URL: http://openwa.apolocrm.es/api

⚡ Commands 123

MethodNamespaceDescription
sendText messages Sends a text message to a chat
sendTextWithMentions messages Sends a text message that includes @mentions
sendReplyWithMentions messages Sends a reply to a message that includes @mentions
sendPaymentRequest messages Sends a payment request message
sendImage messages Sends an image to a chat
sendFile messages Sends a file or document to a chat
sendAudio messages Sends an audio file to a chat
sendPtt messages Sends a voice note (push-to-talk) to a chat
sendVideoAsGif messages Sends a video as an animated GIF
sendLocation messages Sends a location to a chat
sendVCard messages Sends a contact card (vCard)
sendContact messages Sends a single contact
sendMultipleContacts messages Sends multiple contacts
sendButtons messages Sends a button message (deprecated)
sendAdvancedButtons messages Sends an advanced button message with media (deprecated)
sendListMessage messages Sends a list/menu message (deprecated)
sendPoll messages Sends a poll message
sendBanner messages Sends a banner image
sendYouTubeLink messages Sends a YouTube link with auto-generated preview
sendLinkWithAutoPreview messages Sends a link with auto-generated preview
sendMessageWithThumb messages Sends a link preview message with custom thumbnail
forwardMessages messages Forwards messages to a chat
deleteMessage messages Deletes a message
getMessageById messages Retrieves a specific message by ID
getAllMessages messages Retrieves all messages in the session
getMyLastMessage messages Get last message sent by host
getStarredMessages messages Get starred messages
getUnsentMessages messages Get unsent/pending messages
getMessageInfo messages Get message delivery info
getVCards messages Extract vCards from message
getMessagesForLLM messages Get messages formatted for LLMs
starMessage messages Star a message
unstarMessage messages Unstar a message
react messages React to message with emoji
sendSeen messages Mark message as seen
loadEarlierMessages messages Loads earlier messages from a chat
sendFileFromUrl messages Downloads a file from a URL and sends it to a chat
getAllChats chats Retrieves all chats
getAllChatIds chatIds Get all chat IDs
getChat chats Get specific chat by ID
getChatWithNonContacts chats Get chats with non-contacts
archiveChat chats Archive a chat
unarchiveChat chats Unarchive a chat
clearChat chats Clear chat history
deleteChat chats Delete a chat
pinChat chats Pin a chat
unpinChat chats Unpin a chat
muteChat chats Mute a chat
unmuteChat chats Unmute a chat
markAsRead chats Mark chat as read
markAsUnread chats Mark chat as unread
setChatEphemeral chats Set ephemeral messages for chat
isChatOnline chats Check if chat is online
getAllContacts contacts Retrieves all contacts
getContact contacts Get specific contact
getCommonGroups contacts Get common groups with contact
getNumberProfile contacts Get profile of number
getBlockedIds contacts Get blocked contact IDs
blockContact contacts Block a contact
unblockContact contacts Unblock a contact
checkReadReceipts contacts Check read receipts setting
checkNumberStatus contacts Check if number is on WhatsApp
getProfilePicture contacts Get profile picture from server
getGroupMembers groups Retrieves members of a group
getAllGroups groups Get all groups
getGroupMembersId groups Get group member IDs
getGroupInfo groups Get group metadata
getGroupAdmins groups Get group admins
getKickedGroups groups Get groups where kicked
getGroupInviteLink groups Get group invite link
createGroup groups Create new group
leaveGroup groups Leave a group
joinGroupViaLink groups Join group via invite link
revokeGroupInviteLink groups Revoke group invite link
setGroupTitle groups Set group title
setGroupDescription groups Set group description
setGroupIcon groups Set group icon
setGroupToAdminsOnly groups Restrict group to admins only
setGroupEditToAdminsOnly groups Restrict group editing to admins only
addParticipant groups Add participant to group
removeParticipant groups Remove participant from group
promoteParticipant groups Promote participant to admin
demoteParticipant groups Demote participant from admin
approveGroupJoinRequest groups Approve group join request
rejectGroupJoinRequest groups Reject group join request
getAllCommunities communities Get all communities
getCommunityInfo communities Get community metadata
getCommunityParticipantIds communities Get community participant IDs
getCommunityAdminIds communities Get community admin IDs
getCommunityParticipants communities Get community participants
getCommunityAdmins communities Get community admins
postTextStatus status Post text status
postImageStatus status Post image status
postVideoStatus status Post video status
getStories status Get all stories
getStatus mystatus Get specific status
deleteStatus status Delete status
deleteAllStatus status Delete all statuses
getAllLabels labels Get all labels
getChatsByLabel labels Get chats by label
addLabel labels Add label to chat
removeLabel labels Remove label from chat
getBusinessProfile business Get business profile
getBusinessProducts business Get business products
getOrder business Get order details
getMe session Get host account info
getHostNumber session Get host phone number
getConnectionState session Get connection state
getWAVersion session Get WhatsApp Web version
getBatteryLevel session Get phone battery level
isPlugged session Check if phone is charging
getFeatures session Get enabled features
getLicenseType session Get license type
getUserAgent session Get user agent
getProcessStats session Get process statistics
getLoadedMessageCount session Get loaded message count
getSnapshot session Take screenshot
healthCheck session Health check
setMyName session Set host name
setMyStatus session Set host status
setProfilePicture session Set profile picture
decryptMedia media Decrypts media from a message
downloadMedia media Downloads and decrypts media from a message to a file

📡 Listeners 10

EventLegacy AliasNamespaceDescription
message onMessage messages Fired when a new message is received (excluding own messages)
anyMessage onAnyMessage messages Fired for any message including own messages
messageDeleted onMessageDeleted messages Fired when a message is deleted
ack onAck messages Fired when a message acknowledgment is received
reaction onReaction messages Fired when a reaction is added to a message
stateChanged onStateChanged state Fired when connection state changes
chatState onChatState state Fired when someone is typing or recording
logout onLogout state Fired when the session is logged out
participantsChanged onParticipantsChanged groups Fired when group participants change
addedToGroup onAddedToGroup groups Fired when you are added to a group