{
"image": {
"content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"mimetype": "image/png"
},
"caption": "Check out this amazing picture!",
"participants": [
"5511999999999@s.whatsapp.net",
"5511888888888@s.whatsapp.net"
]
}
{
"image": {
"content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}
}
{
"success": true,
"messageId": "3EB0796F91D8B2A4E053AC100F0A4D1E"
}
Status
Send Image Status
Send image status (story) with optional caption
POST
/
api
/
{session}
/
status
/
image
{
"image": {
"content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"mimetype": "image/png"
},
"caption": "Check out this amazing picture!",
"participants": [
"5511999999999@s.whatsapp.net",
"5511888888888@s.whatsapp.net"
]
}
{
"image": {
"content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}
}
{
"success": true,
"messageId": "3EB0796F91D8B2A4E053AC100F0A4D1E"
}
Description
This endpoint allows you to send an image status (story) on WhatsApp. You can include a caption and define which contacts will be able to view the status.URL Parameters
string
required
Unique authenticated session ID
Request Body
object
required
string
Image caption
array
Array of contact JIDs who will be able to view the status. If not specified, the status will be visible to all contacts.JID format:
["5511999999999@s.whatsapp.net"]{
"image": {
"content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"mimetype": "image/png"
},
"caption": "Check out this amazing picture!",
"participants": [
"5511999999999@s.whatsapp.net",
"5511888888888@s.whatsapp.net"
]
}
{
"image": {
"content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}
}
Response
boolean
required
Indicates if the status was sent successfully
string
Sent status message ID
{
"success": true,
"messageId": "3EB0796F91D8B2A4E053AC100F0A4D1E"
}
Status Codes
200- Status sent successfully400- Invalid parameters401- Unauthorized500- Server error
Usage Example
curl -X POST https://api.wappfy.com.br/api/my-session/status/image \
-H "Content-Type: application/json" \
-d '{
"image": {
"content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"mimetype": "image/png"
},
"caption": "Check out this amazing picture!"
}'
const session = 'my-session';
// Read image and convert to base64
const fs = require('fs');
const imageBuffer = fs.readFileSync('path/to/image.jpg');
const base64Image = imageBuffer.toString('base64');
const response = await fetch(`https://api.wappfy.com.br/api/${session}/status/image`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
image: {
content: base64Image,
mimetype: 'image/jpeg'
},
caption: 'Check out this amazing picture!',
participants: ['5511999999999@s.whatsapp.net']
})
});
const data = await response.json();
console.log(data);
import requests
import base64
session = 'my-session'
# Read image and convert to base64
with open('path/to/image.jpg', 'rb') as image_file:
base64_image = base64.b64encode(image_file.read()).decode('utf-8')
payload = {
'image': {
'content': base64_image,
'mimetype': 'image/jpeg'
},
'caption': 'Check out this amazing picture!',
'participants': ['5511999999999@s.whatsapp.net']
}
response = requests.post(
f'https://api.wappfy.com.br/api/{session}/status/image',
json=payload
)
data = response.json()
print(data)
Notes
- Status are temporary content (Stories) that disappear after 24 hours
- If the
participantsparameter is not specified, the status will be visible to all contacts - Image must be encoded in base64
- Supported image formats: JPEG, PNG, GIF, WebP
Authorizations
Your Wappfy API key (get it at dash.wappfy.com.br)
Path Parameters
Session name (instanceName)
Body
application/json
Response
201 - undefined
