Skip to content

Envío de mensajes SMS mediante la REST API

Utiliza la REST API de Braze para enviar mensajes SMS transaccionales desde tu backend en tiempo real. Este enfoque te permite crear un servicio que envía mensajes SMS de forma programática, al tiempo que realiza el seguimiento de los análisis de entrega junto con tus otras Campaigns y Canvas en el dashboard de Braze.

Esto puede resultar especialmente útil para la mensajería transaccional de gran volumen cuyo contenido se define en tus sistemas backend. Por ejemplo, puedes notificar a los consumidores cuando reciban un mensaje de otro usuario, invitándolos a visitar tu sitio web y consultar su buzón de entrada.

Con este enfoque, puedes:

  • Desencadenar mensajes SMS desde tu backend en tiempo real.
  • Realizar un seguimiento de análisis junto con todas tus Campaigns y Canvas de marketing.
  • Ampliar el caso de uso con características adicionales de Braze, como retrasos en los mensajes, reorientación de seguimiento y pruebas A/B.
  • Opcionalmente, cambiar a la entrega activada por API para definir tus plantillas de mensajes en el dashboard de Braze sin dejar de desencadenar los envíos desde tu backend.

Para enviar un mensaje SMS a través de la REST API, debes configurar una campaña de API en el dashboard de Braze y, a continuación, utilizar el punto de conexión /messages/send para enviar el mensaje.

Requisitos previos

Para completar esta guía, necesitas:

Paso 1: Crear una campaña de API

  1. En el dashboard de Braze, ve a Messaging > Campaigns.
  2. Selecciona Create Campaign y, a continuación, selecciona API Campaigns.
  3. Introduce un nombre y una descripción para tu campaña, como «Notificación por mensaje SMS».
  4. Añade etiquetas relevantes para su identificación y seguimiento.
  5. Selecciona Add Messaging Channel y, a continuación, selecciona SMS.
  6. Anota el Campaign ID y el Message Variation ID que se muestran en la página de la campaña. Necesitarás ambos valores al crear tu solicitud API.

Paso 2: Enviar un mensaje SMS utilizando la API

Crea una solicitud POST al punto de conexión /messages/send. Incluye el ID de la campaña, el ID de usuario externo del destinatario y el contenido del SMS en la carga útil de la solicitud.

Ejemplo de solicitud

1
2
3

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

Reemplaza YOUR_REST_ENDPOINT con la URL del punto de conexión REST de tu espacio de trabajo.

1
2
3
4
5
6
7
8
9
10
11
12

{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "external_user_ids": ["user123"],
  "messages": {
    "sms": {
      "app_id": "YOUR_APP_ID",
      "subscription_group_id": "YOUR_SMS_SUBSCRIPTION_GROUP_ID",
      "message_variation_id": "YOUR_MESSAGE_VARIATION_ID",
      "body": "Hi {{${first_name}}}, you have a new message in your inbox. Check it out at https://yourwebsite.com/messages. Text STOP to opt out."
    }
  }
}

Reemplaza los valores de marcador de posición con tus ID reales. El campo body admite la personalización Liquid, por lo que puedes adaptar el contenido del mensaje a cada destinatario. Para obtener la lista completa de parámetros compatibles con el objeto de mensajería SMS, consulta Objeto SMS.

Después de crear la solicitud, envía la solicitud POST desde tu servicio backend a la REST API de Braze.

Paso 3: Verifica tu integración

Una vez completada la configuración, verifica tu integración:

  1. Envía una solicitud API tal y como se describe en el paso 2, utilizando tu propio ID de usuario como destinatario.
  2. Confirma que el mensaje SMS se ha entregado a tu teléfono.
  3. En el dashboard de Braze, ve a la página de resultados de la campaña y confirma que el envío se ha registrado.
  4. Supervisa de cerca los resultados a medida que amplías tu campaña.

Consideraciones
New Stuff!