Skip to content
MessageBuilder
Documentation menu
MEDIA_SHAPE

MEDIA_SHAPE

4 values

MEDIA_SHAPE enum reference: 4 values, including raw values and string names.

API reference
v4.8/Baileys runtime
On this page

On this page

All enumsEnums.MEDIA_SHAPE

This enum has 4 values. Value 0 is alwaysUNSET_OR_UNRECOGNIZED_ENUM_VALUE and acts as the fallback for unknown input.

ValueName
0UNSET_OR_UNRECOGNIZED_ENUM_VALUEfallback
1CIRCLE
2SQUARE
3VERTICAL

Usage

MEDIA_SHAPE.js
javascript
import { Enums } from './lib/MessageBuilderEnums.js';

// Raw value
const raw = Enums.MEDIA_SHAPE.CIRCLE; // 1

// Name from a value
const name = Enums.MEDIA_SHAPE.get(1); // "CIRCLE"

// Pass-through from a string
const passthrough = Enums.MEDIA_SHAPE.get('CIRCLE'); // "CIRCLE"

.get() returns a string for numeric input and passes a string through unchanged. Unknown values resolve to UNSET_OR_UNRECOGNIZED_ENUM_VALUE.

Notes

Where is it used?

Some enums are consumed directly by builder methods such as addImage() andaddVideo(). Others are available for custom payloads through addWidget() oraddPayload().

Not an official contract

Names and values come from the internal WhatsApp schema. Changes on WhatsApp’s side can make these values irrelevant.