Saltar al contenido principal
POST

Estructura del Payload

  • title (opcional): Título mostrado encima de la lista de opciones.
  • buttonText (opcional): Objeto del botón que abre la lista. Admite los campos:
    • type: tipo del contenido del botón (por defecto "text").
    • text: etiqueta visible del botón (por defecto "Opciones").
  • options[] (requerido): Lista de opciones seleccionables. Cada opción admite:
    • id (opcional): Identificador estable que se devuelve cuando el usuario selecciona la opción. Si se omite, se genera automáticamente un UUID.
    • title (requerido): Texto visible de la opción.
    • description (opcional): Texto secundario debajo del título.

Restricciones

  • Opciones: Mínimo 1, máximo 10 opciones por mensaje
  • Título de Opción: Máximo 24 caracteres
  • Descripción de Opción: Máximo 72 caracteres
  • Texto del Botón (buttonText.text): Por defecto es “Opciones” si no se especifica

Casos de Uso

  • Crear menús de navegación
  • Proporcionar opciones de selección múltiple
  • Guiar a los usuarios a través de un flujo
  • Recopilar respuestas estructuradas

Autorizaciones

Authorization
string
header
requerido

Basic authentication using Base64 encoded clientId:clientSecret

Parámetros de ruta

botId
string
requerido

The unique identifier of the bot

Cuerpo

application/json

Message payload. The structure varies based on the message type.

type
enum<string>
requerido

Type of message to send

Opciones disponibles:
text
Ejemplo:

"text"

userId
string
requerido

Unique identifier of the user receiving the message. Accepts either a phone number in E.164 format without the leading '+' (e.g. '593999999999') or a BSUID (Business-Scoped User ID, e.g. 'US.13491208655302741918') for users who have enabled phone number privacy in WhatsApp.

Ejemplo:

"593999999999"

text
string
requerido

Text content of the message

Ejemplo:

"Hello, this is a text message"

botId
string

Unique identifier of the bot sending the message

Ejemplo:

"BOT_ID"

Respuesta

Message sent successfully

success
boolean
Ejemplo:

true

messageId
string
Ejemplo:

"msg_123456789"