Session Media & Ignore Settings
Get or configure incoming media auto-download modes (auto, on_demand, disabled) and ignore filters (status, channels, groups, broadcast) for a session.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Enable ignore_status and ignore_channels on production bots.
Set max_auto_download_mb between 5 and 25 MB to prevent large files from slowing down webhook delivery.
Session Media & Bandwidth Control
The /v2/session/media-settings endpoint lets you inspect (via GET) or update (via POST) how your WhatsApp session handles incoming media files and high-volume chat streams.
⚙️ Media Reception Modes
Each incoming media type (receive_images, receive_videos, receive_audio, receive_documents, receive_stickers) supports three modes:
auto: Automatically downloads and attaches media URLs to incoming webhook events (up tomax_auto_download_mb).on_demand: Delivers the message metadata immediately without downloading heavy media automatically; media can be fetched on demand when needed.disabled: Skips media downloading completely to conserve bandwidth.
🛡️ Stream Ignore Filters
To reduce CPU, memory, and webhook noise on busy numbers, you can ignore specific traffic categories at the engine level:
ignore_status: Ignore WhatsApp Status (Stories) updates (default:true).ignore_channels: Ignore WhatsApp Channels traffic (default:true).ignore_groups: Ignore Group messages (default:false).ignore_broadcast: Ignore Broadcast lists (default:false).
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
Query Parameters & Request Body
Supported in URL Query String or JSON Bodystring | Your unique 12-character WhatsApp Instance ID. Example: | ||
string | Your API Access Token. Example: | ||
string | — | Optional session name (alternative to instance_id). Example: | |
boolean | — | Ignore incoming WhatsApp Status (Story) events. Default: trueExample: | |
boolean | — | Ignore incoming WhatsApp Channel events. Default: trueExample: | |
boolean | — | Ignore incoming Group chat events. Default: falseExample: | |
boolean | — | Ignore incoming Broadcast list events. Default: falseExample: | |
string | — | Image download mode: 'auto' | 'on_demand' | 'disabled'. Default: autoExample: | |
string | — | Video download mode: 'auto' | 'on_demand' | 'disabled'. Default: on_demandExample: | |
string | — | Audio/Voice download mode: 'auto' | 'on_demand' | 'disabled'. Default: autoExample: | |
string | — | Document download mode: 'auto' | 'on_demand' | 'disabled'. Default: on_demandExample: | |
string | — | Sticker download mode: 'auto' | 'on_demand' | 'disabled'. Default: disabledExample: | |
number | — | Maximum file size in MB for automatic media downloads (1–100). Default: 10Example: |
Build with AI using Wawp MCP
MCP READYConnect Wawp API directly to Cursor, Windsurf, or Claude Desktop. Let AI write, test, and execute your WhatsApp integration code automatically!
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"status": "success",
"instance_id": "123456789",
"settings": {
"ignore_status": true,
"ignore_channels": true,
"ignore_groups": false,
"ignore_broadcast": false,
"receive_images": "auto",
"receive_videos": "on_demand",
"receive_audio": "auto",
"receive_documents": "on_demand",
"receive_stickers": "disabled",
"max_auto_download_mb": 10,
"admin_locked_fields": {
},
"admin_note": null
}
}Command Palette
Search for a command to run...