Envío de mensajes mediante la API REST

Puedes enviar mensajes desde tu backend en tiempo real utilizando dos puntos finales diferentes de Braze. Cada uno tiene una forma de solicitud diferente: uno requiere el contenido completo del mensaje en la solicitud; el otro requiere un ID de campaña y envía el contenido definido en el panel.

Este enfoque funciona con cualquier canal de mensajería compatible con la API (WhatsApp, correo electrónico, SMS, notificaciones push, tarjetas de contenido, webhooks y más).

Dos formas de enviar

Para obtener información detallada sobre las solicitudes y respuestas, consulta las referencias Enviar mensajes inmediatamente (solo API) y Enviar campañas mediante el punto final de entrega activado por API.

Opción 1: Enviar con el contenido del mensaje en la solicitud (/messages/send)

Utiliza este punto final cuando desees especificar el contenido completo del mensaje en la solicitud de API. Debes incluir unmessagesobjeto (por ejemplo, messages.whats_app, messages.email, o messages.sms). Puedes omitircampaign_id para enviar sin seguimiento de la campaña, o incluir un ID de campaña API ymessage_variation_id en cada mensaje para realizar un seguimiento de los envíos en el panel (consulta la referencia del punto final para obtener más detalles).

Requisitos: Clave de API con elmessages.sendpermiso.

Ejemplo: Mensaje de plantilla de WhatsApp

1
2
3
POST YOUR_REST_ENDPOINT/messages/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "external_user_ids": ["user123"],
  "messages": {
    "whats_app": {
      "app_id": "YOUR_APP_ID",
      "subscription_group_id": "YOUR_WHATSAPP_SUBSCRIPTION_GROUP_ID",
      "message_type": "template_message",
      "message": {
        "template_name": "new_message_received",
        "template_language_code": "en_US"
      }
    }
  }
}

Para obtener la especificación completa del objeto WhatsApp, consulta Objeto WhatsApp.

Ejemplo: Correo electrónico

1
2
3
4
5
6
7
8
9
10
11
{
  "external_user_ids": ["user123"],
  "messages": {
    "email": {
      "app_id": "YOUR_APP_ID",
      "subject": "Your order has shipped",
      "from": "[email protected]",
      "body": "<p>Your order #12345 is on its way.</p>"
    }
  }
}

Para otros canales, consulta Objetos de mensajería.

Opción 2: Desencadena una campaña con contenido en el panel (/campaigns/trigger/send)

Utiliza este punto final cuando el contenido del mensaje se cree en el panel de Braze (campaña activada por API). Envías un objeto obligatoriocampaign_id y los destinatarios; no envías unmessagesobjeto .

Requisitos: Clave de API con elcampaigns.trigger.sendpermiso.

Paso 1: Crear una campaña desencadenada por API

1. En el panel de Braze, ve a Mensajería > Campañas.
2. Selecciona Crear campaña y, a continuación, Campaña desencadenada por API (no «Campaña API»).
3. Añade tu canal de mensajería (WhatsApp, correo electrónico, SMS, etc.) y crea el contenido del mensaje en el panel.
4. Anota el ID de la campaña (y el ID de envío si utilizas varias variantes de mensaje). Los utilizarás en la solicitud de API.

Para obtener más información sobre cómo crear campañas activadas por API, consulta Entrega activada por API.

Paso 2: Desencadena la campaña a través de la API.

Envía una solicitud POST a/campaigns/trigger/send concampaign_id yrecipients (o broadcast/audience). No incluyas unmessagesobjeto: el contenido proviene de la campaña.

1
2
3
POST YOUR_REST_ENDPOINT/campaigns/trigger/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
8
{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "recipients": [
    {
      "external_user_id": "user123"
    }
  ]
}

Para ver el cuerpo completo de la solicitud (incluidos trigger_properties, send_to_existing_only, attributes, etc.), consulta la referencia del punto final Enviar campañas mediante entrega desencadenada por API.

Verifica tu integración

1. Envía una solicitud utilizando una de las opciones anteriores, con tu propio ID de usuario como destinatario.
2. Confirma que el mensaje se ha entregado.
3. Si utilizas la opción 2, comprueba la campaña en el panel de Braze para confirmar que el envío se ha registrado.

Consideraciones

• Utiliza las características de personalización de Braze para adaptar el contenido cuando sea posible.
• Asegúrate de que tu mensajería cumpla con las normativas pertinentes e incluya las opciones de exclusión voluntaria y los avisos de privacidad necesarios.
• Para obtener más información sobre los puntos finales (programación, activadores de Canvas, etc.), consulta Puntos finales de mensajería.