WhatsApp Media

WhatsApp Media

Upload media for WhatsApp messaging

post

Body

multipart/form-data

filestring · binaryRequired

Responses

200

Media uploaded successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Media Uploaded Successfully

400

Bad request

post

/api/whatsapp/media/resumable-upload

HTTPcURLJavaScriptPython

POST /api/whatsapp/media/resumable-upload HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "success": true,
  "message": "Media Uploaded Successfully",
  "data": {
    "h": "4:YW5nZWxpYy0xMjk4MTYyXzEyODAucG5n:aW1hZ2UvcG5n:ARZbZTvkp84-ws-WbEQfTNXTKwrZqp6oIbUEhjN4VuT2H-Lmb9ekIb9pzafMYhECmQbZgLAnE7LgNyEx8uknY5vHHwpKevik4z1LWBXCfJlfjg:e:1727524514:807813227927119:61565494432283:ARZV8TFIukumH2EOTuA"
  }
}

Upload Media to WhatsApp

post

Uploads media to WhatsApp and saves the file using Spatie Media Library. The response contains the media URL from the Spatie library.

Authorizations

apiAuth

Path parameters

phoneNumberIdintegerRequired

The ID of the WhatsApp phone number for which the media is being uploaded

Body

multipart/form-data

filestring · binaryOptional

The file to be uploaded

typestringOptional

The media type (e.g., image, video, etc.)

Example: image

Responses

200

Media uploaded successfully

application/json

media_idstringOptionalExample: wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSOTJDREYzMDZBODc1RkY0OTgxAA==

media_urlstringOptionalExample: https://yourdomain.com/uploads/1/whatsapp/1234/sample.jpg

messagestringOptionalExample: Media uploaded successfully

400

Invalid media properties

application/json

401

Failed to get a valid access token

application/json

500

Upload failed

application/json

post

/api/whatsapp/media/{phoneNumberId}/upload

HTTPcURLJavaScriptPython

POST /api/whatsapp/media/{phoneNumberId}/upload HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 32

{
  "file": "binary",
  "type": "image"
}

{
  "media_id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSOTJDREYzMDZBODc1RkY0OTgxAA==",
  "media_url": "https://yourdomain.com/uploads/1/whatsapp/1234/sample.jpg",
  "message": "Media uploaded successfully"
}

Download Media from WhatsApp Cloud API

get

Retrieve and download media content from WhatsApp Cloud API using the provided media ID.

Authorizations

apiAuth

Path parameters

mediaIdstringRequired

The ID of the media to download

Responses

200

Successfully downloaded the media file.

application/octet-stream

string · binaryOptional

500

Failed to retrieve or download media.

get

/whatsapp/media/download/{mediaId}

HTTPcURLJavaScriptPython

GET /whatsapp/media/download/{mediaId} HTTP/1.1
Accept: */*

[binary content of the media file]

Upload media to WhatsApp Cloud API

post

Uploads media to WhatsApp Cloud API and returns a media ID.

Authorizations

apiAuth

Path parameters

whatsappPhoneNumberintegerRequired

ID of the WhatsApp phone number

Body

multipart/form-data

filefileOptional

Media file to upload

typestringOptional

Media type (image, video, etc.)

Example: image

Responses

200

Media uploaded successfully

application/json

media_idstringOptional

WhatsApp media ID

Example: 1166846181421424

messagestringOptionalExample: Media uploaded successfully

401

Unauthorized

application/json

500

Upload failed

application/json

post

/api/whatsapp/media/{whatsappPhoneNumber}/upload-cloud

HTTPcURLJavaScriptPython

POST /api/whatsapp/media/{whatsappPhoneNumber}/upload-cloud HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 28

{
  "file": null,
  "type": "image"
}

{
  "media_id": "1166846181421424",
  "message": "Media uploaded successfully"
}

Upload media to OSS

post

Uploads media to OSS and returns the media link.

Authorizations

apiAuth

Path parameters

whatsappPhoneNumberintegerRequired

ID of the WhatsApp phone number

Body

multipart/form-data

filefileOptional

Media file to upload

typestringOptional

Media type (image, video, etc.)

Example: image

Responses

200

Media uploaded successfully

application/json

media_urlstringOptional

OSS media URL

Example: https://oss.yourdomain.com/uploads/whatsapp/12345/image.jpg

messagestringOptionalExample: Media uploaded successfully

500

Upload failed

application/json

post

/api/whatsapp/media/{whatsappPhoneNumber}/upload-oss

HTTPcURLJavaScriptPython

POST /api/whatsapp/media/{whatsappPhoneNumber}/upload-oss HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 28

{
  "file": null,
  "type": "image"
}

{
  "media_url": "https://oss.yourdomain.com/uploads/whatsapp/12345/image.jpg",
  "message": "Media uploaded successfully"
}