- GETGet Information
- POSTCreate Instance Basic
- GETFetch Instances
- GETInstance Connect
- PUTRestart Instance
- GETConnection State
- DELLogout Instance
- DELDelete Instance
- POSTSet Presence
- POSTSend Template
- POSTSend Plain Text
- POSTSend Status
- POSTSend Media
- POSTSend WhatsApp Audio
- POSTSend Sticker
- POSTSend Location
- POSTSend Contact
- POSTSend Reaction
- POSTSend Poll
- POSTSend List
- POSTCheck is WhatsApp
- PUTMark Message As Read
- PUTArchive Chat
- DELDelete Message for Everyone
- POSTSend Presence
- POSTFetch Profile Picture URL
- POSTFind Contacts
- POSTFind Messages
- POSTFind Status Message
- PUTUpdate Message
- GETFind Chats
- POSTFetch Business Profile
- POSTFetch Profile
- POSTUpdate Profile Name
- POSTUpdate Profile Status
- PUTUpdate Profile Picture
- DELRemove Profile Picture
- GETFetch Privacy Settings
- PUTUpdate Privacy Settings
- POSTCreate Group
- PUTUpdate Group Picture
- PUTUpdate Group Subject
- PUTUpdate Group Description
- GETFetch Invite Code
- GETAccept Invite Code
- PUTRevoke Invite Code
- POSTSend Group Invite
- GETFind Group by Invite Code
- GETFind Group by JID
- GETFetch All Groups
- GETFind Group Members
- PUTUpdate Group Members
- PUTUpdate Group Setting
- PUTToggle Ephemeral
- DELLeave Group
Início
Instances
Send Message
Chat Controller
Profile Settings
Profile Settings
Send Media
Send media message
https://{server-url}
The URL of your EvolutionAPI server
Your authorization key header
ID of the instance to connect
Number to receive the message (with country code)
Presence time in milliseconds before sending message
Presence type to show
Media type
Name of the file (for media type document
only)
Caption to send with media (except with media type audio
)
Media URL or file in base64
curl --request POST \
--url https://{server-url}/message/sendMedia/{instance} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"number": "<string>",
"options": {
"delay": 123,
"presence": "composing"
},
"mediaMessage": {
"mediaType": "image",
"fileName": "evolution-api.pdf",
"caption": "<string>",
"media": "<string>"
}
}'
{
"key": {
"remoteJid": "553198296801@s.whatsapp.net",
"fromMe": true,
"id": "BAE5F5A632EAE722"
},
"message": {
"imageMessage": {
"url": "https://mmg.whatsapp.net/o1/v/t62.7118-2...",
"mimetype": "image/png",
"caption": "Caption text",
"fileSha256": "VbCGkGBv5SZStLD5PHdkBWpQav/lNsXcY...",
"fileLength": "1305757",
"height": 1080,
"width": 1920,
"mediaKey": "aFQK9Ocw5tE7Nf0iBA42Xcb4Dee6G1k/pLL...",
"fileEncSha256": "bGVtYeR3458RwC0p1tsGDNuj+vOu/...",
"directPath": "/o1/v/t62.7118-24/f1/m232/up-oil...",
"mediaKeyTimestamp": "1717775573",
"jpegThumbnail": "/9j/2wBDABALDA4MChAODQ4SERATG...",
"contextInfo": {}
}
},
"messageTimestamp": "1717775575",
"status": "PENDING"
}
Authorizations
Your authorization key header
Path Parameters
ID of the instance to connect
Body
Number to receive the message (with country code)
Presence time in milliseconds before sending message
Presence type to show
composing
, recording
Media type
image
, video
, document
, audio
Name of the file (for media type document
only)
Caption to send with media (except with media type audio
)
Media URL or file in base64
Response
The key of the message, which identifies the message in the chat.
The remote Jid.
Indicates whether the message was sent by the user.
The ID of the message.
The message content, which may include various types of messages like text, images, etc.
Details of the image message.
The URL of the image.
The MIME type of the image.
The caption text of the image.
The SHA-256 hash of the image file.
The length of the image file.
The height of the image.
The width of the image.
The media key of the image.
The SHA-256 hash of the encrypted image file.
The direct path to the image.
The timestamp of the media key.
The JPEG thumbnail of the image.
Additional context information.
The timestamp of the message, represented as a string.
The status of the message, such as sent, received, or pending.
curl --request POST \
--url https://{server-url}/message/sendMedia/{instance} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"number": "<string>",
"options": {
"delay": 123,
"presence": "composing"
},
"mediaMessage": {
"mediaType": "image",
"fileName": "evolution-api.pdf",
"caption": "<string>",
"media": "<string>"
}
}'
{
"key": {
"remoteJid": "553198296801@s.whatsapp.net",
"fromMe": true,
"id": "BAE5F5A632EAE722"
},
"message": {
"imageMessage": {
"url": "https://mmg.whatsapp.net/o1/v/t62.7118-2...",
"mimetype": "image/png",
"caption": "Caption text",
"fileSha256": "VbCGkGBv5SZStLD5PHdkBWpQav/lNsXcY...",
"fileLength": "1305757",
"height": 1080,
"width": 1920,
"mediaKey": "aFQK9Ocw5tE7Nf0iBA42Xcb4Dee6G1k/pLL...",
"fileEncSha256": "bGVtYeR3458RwC0p1tsGDNuj+vOu/...",
"directPath": "/o1/v/t62.7118-24/f1/m232/up-oil...",
"mediaKeyTimestamp": "1717775573",
"jpegThumbnail": "/9j/2wBDABALDA4MChAODQ4SERATG...",
"contextInfo": {}
}
},
"messageTimestamp": "1717775575",
"status": "PENDING"
}