דלג לתוכן הראשי

תיעוד מלא

כל 70 הפעולות על פני 10 קבוצות. אותן פעולות בדיוק ב-Make וב-n8n.

Instance (5)

הפעלת המספר המחובר — חיבור בקוד QR, בדיקת מצב החיבור, קביעת נוכחות, הפעלה מחדש או התנתקות.

פעולהנקודת קצהפרמטרים
Restart Instance
Restart the instance process
restart
POST
/instance/restart/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
Connect Instance
Connect the instance and return its pairing QR code
connect
GET
/instance/connect/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
Get Connection State
Current connection state of the instance
connectionState
GET
/instance/connectionState/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
Set Presence
Set the instance presence, such as available or unavailable
setPresence
POST
/instance/setPresence/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • presence select(unavailable | available | composing | recording | paused) חובה
Log Out Instance
Log the instance out of WhatsApp without deleting it
logout
DELETE
/instance/logout/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on

Send Message (13)

כל סוגי ההודעות היוצאות: טקסט, מדיה, אודיו, מדבקות, מיקום, אנשי קשר, תגובות, סקרים, רשימות, כפתורים ותבניות עסקיות.

פעולהנקודת קצהפרמטרים
Send Template
Send an approved WhatsApp Business template
sendTemplate
POST
/message/sendTemplate/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • name text חובה
  • language text חובה
  • additionalFields object{ number, components, webhookUrl }
Send Text
Send a plain text message
sendText
POST
/message/sendText/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • text text חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ linkPreview, delay, everyOne, mentioned }
Send Media
Send an image, video or document by URL or base64
sendMedia
POST
/message/sendMedia/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • mediatype select(image | document | video | audio) חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ mimetype, media, fileName, caption, delay, everyOne, mentioned }
Send Video Note
Send a round play-through video note
sendPtv
POST
/message/sendPtv/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ video, delay, everyOne, mentioned }
Send Audio
Send a voice note
sendWhatsAppAudio
POST
/message/sendWhatsAppAudio/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ audio, delay, everyOne, mentioned }
Send Status
Post a status update to the status feed
sendStatus
POST
/message/sendStatus/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • type select(text | image | audio | video) חובה
  • additionalFields object{ content, caption, backgroundColor, font, statusJidList, allContacts }
Send Sticker
Send a sticker
sendSticker
POST
/message/sendSticker/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ sticker, delay, everyOne, mentioned }
Send Location
Send a geographic location
sendLocation
POST
/message/sendLocation/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • latitude number חובה
  • longitude number חובה
  • name text חובה
  • address text חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ delay, everyOne, mentioned }
Send Contact
Send one or more contact cards
sendContact
POST
/message/sendContact/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • contact array<{ fullName, wuid, phoneNumber, organization, email, url }> חובה
Send Reaction
React to a message with an emoji
sendReaction
POST
/message/sendReaction/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • key object{ id, remoteJid, fromMe } חובה
  • reaction text חובה
Send Poll
Send a poll with selectable options
sendPoll
POST
/message/sendPoll/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • name text חובה
  • selectableCount integer חובה
  • values array<text> חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ delay, everyOne, mentioned }
Send List
Send an interactive list menu
sendList
POST
/message/sendList/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • title text חובה
  • footerText text חובה
  • buttonText text חובה
  • sections array<{ title, rows }> חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ description, delay, everyOne, mentioned }
Send Buttons
Send a message with interactive buttons
sendButtons
POST
/message/sendButtons/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • quoted object{ id, remoteJid, fromMe, message }
  • additionalFields object{ thumbnailUrl, title, description, footer, buttons, delay, everyOne, mentioned }

Call (1)

חיוג לאיש קשר בהצעת שיחה.

פעולהנקודת קצהפרמטרים
Offer Call
Ring a contact with a call offer
offer
POST
/call/offer/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • callDuration integer חובה
  • additionalFields object{ isVideo }

Chat (23)

קריאה ופעולה על שיחות — איתור שיחות, אנשי קשר והודעות, סימון כנקרא, ארכיון, חסימה וניהול הפרופיל.

פעולהנקודת קצהפרמטרים
Check WhatsApp Numbers
Check which of the given numbers are registered on WhatsApp
whatsappNumbers
POST
/chat/whatsappNumbers/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ numbers }
Mark Message as Read
Mark one or more messages as read
markMessageAsRead
POST
/chat/markMessageAsRead/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • readMessages array<{ id, fromMe, remoteJid }> חובה
Archive Chat
Archive or unarchive a chat
archiveChat
POST
/chat/archiveChat/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • lastMessage object{ id, remoteJid, fromMe, messageTimestamp }
  • archive boolean חובה
  • additionalFields object{ chat }
Mark Chat as Unread
Mark a chat as unread
markChatUnread
POST
/chat/markChatUnread/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • lastMessage object{ id, remoteJid, fromMe, messageTimestamp } חובה
  • additionalFields object{ chat }
Delete Message for Everyone
Revoke a sent message for all participants
deleteMessageForEveryone
DELETE
/chat/deleteMessageForEveryone/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • id text חובה
  • fromMe boolean חובה
  • remoteJid text חובה
  • additionalFields object{ participant }
Get Profile Picture URL
Profile picture URL for a contact
fetchProfilePictureUrl
POST
/chat/fetchProfilePictureUrl/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ number, picture }
Download Media
Download a media message and return it as base64
getBase64FromMediaMessage
POST
/chat/getBase64FromMediaMessage/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • message text חובה
    The full message object, as returned by Find Messages
  • options object{ convertToMp4 }
Update Message
Edit the text of a message already sent
updateMessage
POST
/chat/updateMessage/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • key object{ id, remoteJid, fromMe }
  • additionalFields object{ number, text }
Send Chat Presence
Show a typing or recording indicator in a chat
sendPresence
POST
/chat/sendPresence/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • delay number חובה
  • presence select(unavailable | available | composing | recording | paused) חובה
Update Block Status
Block or unblock a contact
updateBlockStatus
POST
/chat/updateBlockStatus/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • status select(block | unblock) חובה
Find Contacts
Search stored contacts
findContacts · מחזירה רשימה
POST
/chat/findContacts/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • where object{ _id, pushName, id, remoteJid }
Find Messages
Search stored messages
findMessages · מחזירה רשימה
POST
/chat/findMessages/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • where object{ _id, key, message }
  • additionalFields object{ limit }
Find Status Messages
Search status-feed messages
findStatusMessage · מחזירה רשימה
POST
/chat/findStatusMessage/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • where object{ _id, remoteJid, id, fromMe, participant, status }
  • additionalFields object{ limit }
Find Chats
List stored chats
findChats · מחזירה רשימה
POST
/chat/findChats/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • where object{ _id, pushName, id, remoteJid }
Get Chat by JID
Fetch one chat by its remote JID
findChatByRemoteJid
GET
/chat/findChatByRemoteJid/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • remoteJid text חובה
    Chat JID, for example 972500000000@s.whatsapp.net
Get Business Profile
Business profile of a WhatsApp Business contact
fetchBusinessProfile
POST
/chat/fetchBusinessProfile/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ number, picture }
Get Profile
Profile details of a contact
fetchProfile
POST
/chat/fetchProfile/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ wuid, name, picture, status, isBusiness }
Update Profile Name
Change the instance display name
updateProfileName
POST
/chat/updateProfileName/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ name }
Update Profile Status
Change the instance status text
updateProfileStatus
POST
/chat/updateProfileStatus/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ status }
Update Profile Picture
Change the instance profile picture
updateProfilePicture
POST
/chat/updateProfilePicture/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ number, picture }
Remove Profile Picture
Remove the instance profile picture
removeProfilePicture
DELETE
/chat/removeProfilePicture/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ number, picture }
Get Privacy Settings
Current privacy settings for the instance
fetchPrivacySettings
GET
/chat/fetchPrivacySettings/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
Update Privacy Settings
Change the instance privacy settings
updatePrivacySettings
POST
/chat/updatePrivacySettings/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • readreceipts select(all | none) חובה
  • profile select(all | contacts | contact_blacklist | none) חובה
  • status select(all | contacts | contact_blacklist | none) חובה
  • online select(all | match_last_seen) חובה
  • last select(all | contacts | contact_blacklist | none) חובה
  • groupadd select(all | contacts | contact_blacklist | none) חובה

Business (2)

קריאת קטלוג המוצרים של וואטסאפ עסקי והאוספים שבו.

פעולהנקודת קצהפרמטרים
Get Catalog
Product catalog of a WhatsApp Business account
getCatalog
POST
/business/getCatalog/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ number, limit }
Get Collections
Catalog collections of a WhatsApp Business account
getCollections
POST
/business/getCollections/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • additionalFields object{ number, limit }

Group (16)

יצירת קבוצות וניהולן: משתתפים, הזמנות, שם ותמונה, והודעות נעלמות.

פעולהנקודת קצהפרמטרים
Create Group
Create a group and add the given participants
createGroup
POST
/group/create/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • subject text חובה
  • participants array<text> חובה
  • additionalFields object{ description, profilePicture, promoteParticipants }
Update Group Subject
Rename a group
updateGroupSubject
POST
/group/updateGroupSubject/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
  • subject text חובה
Update Group Picture
Change a group picture
updateGroupPicture
POST
/group/updateGroupPicture/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
  • image text חובה
Update Group Description
Change a group description
updateGroupDescription
POST
/group/updateGroupDescription/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
  • description text חובה
Get Group Info
Metadata for one group
findGroupInfos
GET
/group/findGroupInfos/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
List Groups
List every group the instance belongs to
fetchAllGroups · מחזירה רשימה
GET
/group/fetchAllGroups/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • getParticipants select(true | false) חובה
List Group Participants
List the members of a group
participants · מחזירה רשימה
GET
/group/participants/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
Get Group Invite Code
Current invite code for a group
inviteCode
GET
/group/inviteCode/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
Get Group Invite Info
Inspect a group invite before accepting it
inviteInfo
GET
/group/inviteInfo/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • inviteCode text חובה
Accept Group Invite
Join a group using an invite code
acceptInviteCode
GET
/group/acceptInviteCode/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • inviteCode text חובה
Send Group Invite
Send a group invite link to numbers
sendInvite
POST
/group/sendInvite/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
  • description text חובה
  • numbers array<text> חובה
Revoke Group Invite Code
Invalidate the current invite code and issue a new one
revokeInviteCode
POST
/group/revokeInviteCode/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
Update Group Participant
Add, remove, promote or demote group members
updateParticipant
POST
/group/updateParticipant/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
  • groupAction select(add | remove | promote | demote) חובה נשלח כ action
  • participants array<text> חובה
Update Group Setting
Change who may post or edit group info
updateSetting
POST
/group/updateSetting/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
  • groupAction select(announcement | not_announcement | locked | unlocked) חובה נשלח כ action
Toggle Disappearing Messages
Set the disappearing-message timer for a group
toggleEphemeral
POST
/group/toggleEphemeral/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה
  • expiration select(0 | 86400 | 604800 | 7776000) חובה
Leave Group
Leave a group
leaveGroup
DELETE
/group/leaveGroup/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • groupJid select · live list חובה

Template (4)

תבניות הודעה של וואטסאפ עסקי — יצירה, עריכה, מחיקה ורשימה.

פעולהנקודת קצהפרמטרים
Create Template
Create a WhatsApp Business message template
createTemplate
POST
/template/create/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • name text חובה
  • category select(AUTHENTICATION | MARKETING | UTILITY) חובה
  • language text חובה
  • components text חובה
  • additionalFields object{ allowCategoryChange, webhookUrl }
Edit Template
Edit an existing message template
editTemplate
POST
/template/edit/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • templateId text חובה
  • additionalFields object{ category, allowCategoryChange, ttl, components }
Delete Template
Delete a message template
deleteTemplate
DELETE
/template/delete/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • name text חובה
  • additionalFields object{ hsmId }
List Templates
List the message templates on the account
findTemplate · מחזירה רשימה
GET
/template/find/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on

Setting (2)

התנהגות המופע — דחיית שיחות, אישורי קריאה, טיפול בקבוצות וסנכרון היסטוריה.

פעולהנקודת קצהפרמטרים
Set Setting
POST /settings/set/{instance}
setSetting
POST
/settings/set/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • rejectCall boolean חובה
  • groupsIgnore boolean חובה
  • alwaysOnline boolean חובה
  • readMessages boolean חובה
  • readStatus boolean חובה
  • syncFullHistory boolean חובה
  • additionalFields object{ msgCall, wavoipToken }
Find Setting
GET /settings/find/{instance}
findSetting · מחזירה רשימה
GET
/settings/find/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on

Proxy (2)

ניתוב מופע דרך שרת פרוקסי.

פעולהנקודת קצהפרמטרים
Set Proxy
Route the instance through an HTTP proxy
setProxy
POST
/proxy/set/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • enabled boolean חובה
  • host text חובה
  • port text חובה
  • protocol text חובה
  • additionalFields object{ username, password }
Get Proxy
Current proxy configuration
findProxy
GET
/proxy/find/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on

Label (2)

רשימת התוויות בחשבון, והצמדה או הסרה שלהן.

פעולהנקודת קצהפרמטרים
List Labels
List the chat labels defined on the account
findLabels · מחזירה רשימה
GET
/label/findLabels/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
Add or Remove Label
Attach a label to a chat or remove it
handleLabel
POST
/label/handleLabel/{instance}
  • instance select · live list חובה
    The Evolution instance (WhatsApp connection) to act on
  • number text חובה
  • labelId text חובה
  • labelAction select(add | remove) חובה נשלח כ action
בואו נתחיל