Skip to main content
POST
/
api
/
{session}
/
status
/
image
{
  "image": {
    "content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
    "mimetype": "image/png"
  },
  "caption": "Check out this amazing picture!",
  "participants": [
    "[email protected]",
    "[email protected]"
  ]
}

{
    "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

​
session
string
required
Unique authenticated session ID

​
Request Body

​
image
object
required
Object containing image data
​
caption
string
Image caption
​
participants
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: ["[email protected]"]
{
  "image": {
    "content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
    "mimetype": "image/png"
  },
  "caption": "Check out this amazing picture!",
  "participants": [
    "[email protected]",
    "[email protected]"
  ]
}

​
Response

​
success
boolean
required
Indicates if the status was sent successfully
​
messageId
string
Sent status message ID
{
    "success": true,
    "messageId": "3EB0796F91D8B2A4E053AC100F0A4D1E"
}

​
Status Codes

  • 200 - Status sent successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized
  • 500 - 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!"
  }'

​
Notes

  • Status are temporary content (Stories) that disappear after 24 hours
  • If the participants parameter 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

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

Session name (instanceName)

Body

application/json
​
file
object
required
​
id
string

Pre-generated status message id

Example:

"BBBBBBBBBBBBBBBBB"

​
contacts
string[]

Contact list to send the status to.

Example:

null

​
caption
string

Response

201 - undefined