Skip to main content
POST

Autorizaciones

token
string
header
requerido

Cuerpo

application/json
type
enum<string>
requerido

Tipo del estado.

Opciones disponibles:
text,
image,
video,
audio,
myaudio,
ptt
Ejemplo:

"text"

text
string

Texto principal o leyenda.

Ejemplo:

"¡Novedades en camino!"

background_color
integer

Índice del color de fondo para estado de texto.

Rango requerido: 1 <= x <= 19
Ejemplo:

7

font
enum<integer>

Fuente aceptada para type=text.

Opciones disponibles:
0,
1,
2,
6,
7,
8,
9,
10
Ejemplo:

1

file
string

URL o base64 del archivo multimedia.

Ejemplo:

"https://example.com/video.mp4"

thumbnail
string

Campo aceptado en el payload; la API genera la miniatura automáticamente cuando es necesario.

Ejemplo:

"https://example.com/thumb.jpg"

mimetype
string

MIME type del archivo, cuando sea necesario.

Ejemplo:

"video/mp4"

recipients
string[]

Lista explícita de destinatarios. Acepta números en formato de WhatsApp, JIDs @s.whatsapp.net y JIDs @lid. La API valida elemento por elemento, descarta los inválidos con el motivo en debug y envía al subconjunto válido restante. Las entradas @lid dependen de una resolución conocida a PN.

Ejemplo:
max_recipients
integer

Limita el envío a un subconjunto determinístico de la audiencia. Cuando se informa recipients, funciona como límite de seguridad sobre la lista explícita ya validada.

Rango requerido: x >= 0
Ejemplo:

100

group
string

JID del grupo (@g.us). Publica el estado en el grupo, para los miembros, en lugar del estado de la cuenta. No se combina con recipients ni max_recipients. Solo texto, imagen y video: el audio devuelve 400.

Ejemplo:

"120363123456789012@g.us"

Respuesta

Estado enviado con éxito

Id
string

ID del mensaje cuando hay un envío real.

Ejemplo:

"ABCD1234"

content
object

Contenido procesado del mensaje cuando hay un envío real.

messageTimestamp
integer

Timestamp en milisegundos cuando hay un envío real.

Ejemplo:

1672531200000

status
string

Estado del envío cuando hay un envío real.

Ejemplo:

"Pending"

debug
object

Métricas agregadas de la audiencia y de la selección aplicada.