Enviar un mensaje

Envía un mensaje a un contacto a través de uno de tus canales conectados.

POST/messages/send

Autenticación

Este endpoint se autentica con tu API key enviada en la cabecera X-API-Key (formato ek_live_...). Puedes gestionar tus API keys desde la sección Dev Tools del panel.

Parámetros obligatorios

ParámetroTipoObligatorioDescripción
toStringObligatorioNúmero de teléfono o identificador de plataforma del destinatario.
fromStringObligatorioIdentificador del canal (p. ej. whatsapp).
typeMessageTypeObligatorioTipo de mensaje a enviar.
contentMessageContentObligatorioContenido del mensaje.
channel_uuidStringObligatorioUUID del número de WhatsApp desde el que se envía. Puedes copiarlo desde la sección Números de Teléfono del panel, o desde el campo id del número en la API.

Parámetros opcionales

ParámetroTipoObligatorioDescripción
template_uuidStringOpcionalIdentificador del mensaje de plantilla.
optin_contactBooleanOpcionalConfirma el estado de opt-in del cliente.
template_valuesArrayOpcionalValores para las variables de la plantilla.
assigned_userStringOpcionalDirección de correo del responsable asignado.
team_uuidStringOpcionalUUID del equipo al que asignar la conversación.
fieldsStringOpcionalCampos adicionales separados por comas: contact, conversation.
bot_statusStringOpcionalEstado del bot: bot_start o bot_end.
metadataObjectOpcionalPares clave-valor personalizados (máx. 10 pares).

Ejemplo de solicitud

bash
curl -X POST "https://eclectic-api-537143970188.us-central1.run.app/api/external/v2/messages/send" \
  -H "X-API-Key: ek_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+31612345678",
    "from": "whatsapp",
    "type": "text",
    "channel_uuid": "35f6f8cc-b550-4278-a2ea-099f3a4e0730",
    "content": {
      "text": "Hello!"
    }
  }'

Ejemplo de respuesta

json
{
  "message": {
    "uuid": "adf3d1216d4c4dcd908199d6700f2381",
    "status": "enqueued"
  }
}

Notas

  • Fuera de la ventana de atención de 24 horas se requiere un mensaje de plantilla.
  • Se admiten imágenes, documentos, audio y vídeo mediante un campo url dentro del objeto content.
  • metadata acepta hasta 10 pares clave-valor; claves de hasta 50 caracteres, valores de hasta 500 caracteres.