WhatsApp API documentation · Lime API

Complete reference for the Lime WhatsApp API: sendMessage, sendFileByUrl, webhooks, groups, statuses, journals and more. Green API compatible paths with cURL, Node.js, Python and PHP examples.

getSettings · Get the current instance settings.
setSettings · Update instance settings. Only the provided fields are changed.
getStateInstance · Get the authorization state of the instance.
getStatusInstance · Get the socket connection status (online/offline).
reboot · Restart the WhatsApp session of the instance.
logout · Log out (unlink) the WhatsApp account from the instance.
qr · Get the QR code for authorization (base64 PNG or raw string).
getAuthorizationCode · Link by phone number: get an 8-character pairing code to enter in WhatsApp.
setProfilePicture · Set the account profile picture (multipart file).
setProfileName · Change the account display name.
setProfileStatus · Change the account “About” status text.
getWaSettings · Get information about the linked WhatsApp account.
updateApiToken · Generate a new apiTokenInstance. The old one stops working immediately.
sendMessage · Send a text message to a private or group chat.
sendFileByUpload · Send a file by uploading it as multipart/form-data.
sendFileByUrl · Send a file (image, video, audio, document) by URL.
uploadFile · Upload a file to storage and get a URL for later sending.
sendLocation · Send a location pin.
sendContact · Send a contact card.
sendPoll · Send a poll with 2–12 options.
sendReaction · React to a message with an emoji (empty string removes it).
sendTyping · Show “typing…” or “recording…” in a chat.
forwardMessages · Forward messages from one chat to another.
editMessage · Edit a text message you sent (within 15 minutes).
deleteMessage · Delete a message for everyone or only for you.
receiveNotification · HTTP API alternative to webhooks: take the next notification from the queue (long-polling).
deleteNotification · Acknowledge (delete) a notification received with receiveNotification.
downloadFile · Get a download URL for a received file.
getChatHistory · Get the message history of a chat (newest first).
getMessage · Get a single message by ID.
lastIncomingMessages · Incoming messages for the last N minutes (default 24h).
lastOutgoingMessages · Outgoing messages for the last N minutes (default 24h).
showMessagesQueue · List messages waiting in the send queue.
clearMessagesQueue · Remove all messages from the send queue.
readChat · Mark a chat (or a single message) as read.
checkWhatsapp · Check whether a phone number has a WhatsApp account.
getAvatar · Get the avatar URL of a user or group.
getContacts · List all known contacts and groups.
getContactInfo · Get detailed information about a contact.
getChats · List chats, newest activity first.
archiveChat · Archive a chat.
unarchiveChat · Unarchive a chat.
setDisappearingChat · Turn disappearing messages on or off (0, 86400, 604800, 7776000 seconds).
rejectCall · Reject an incoming call.
createGroup · Create a new group with participants.
updateGroupName · Rename a group.
getGroupData · Get group info and participants.
addGroupParticipant · Add a participant to a group.
removeGroupParticipant · Remove a participant from a group.
setGroupAdmin · Make a participant a group admin.
removeAdmin · Remove admin rights from a participant.
setGroupPicture · Set the group picture.
leaveGroup · Leave a group.
sendTextStatus · Post a text status (story).
sendVoiceStatus · Post a voice status.
sendMediaStatus · Post an image or video status.
deleteStatus · Delete a status you posted.
getOutgoingStatuses · Statuses you posted in the last N minutes.
getIncomingStatuses · Statuses from your contacts in the last N minutes.
getStatusStatistic · Who viewed a status you posted.