Cada destinatario puede enviar STOP para darse de baja, HELP para obtener una respuesta de ayuda y START para volver a suscribirse. Bird procesa estas palabras clave automáticamente en cada envío y mantiene una lista de supresión por destinatario que puedes consultar. Sin código adicional de tu parte.
import { BirdClient } from "@messagebird/sdk";
const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });
const { data, error } = await bird.sms.send({
from: "Bird",
to: "+15005550006",
text: "Your order #4821 has shipped. Track it: bird.ly/t/4821x",
category: "transactional",
}).safe();
if (error) throw error;
console.log(data.id);
// → "sms_4kT01Lq2m..."
La cancelación es la única regla que siempre está activa.
La gestión de cancelación forma parte del cumplimiento de SMS en la API de SMS de Bird y, a diferencia del registro, se aplica dondequiera que envíes, sin configuración. Las palabras clave reservadas STOP, HELP y START se reconocen en los mensajes entrantes y se aplican por destinatario, de modo que una persona que cancela sigue cancelada en tus envíos hasta que decide volver.
Cómo se comportan las palabras clave.
Palabras clave reservadas, aplicadas por destinatario.
- 01
STOP suprime automáticamente.
Cuando un destinatario envía STOP, Bird lo añade a la lista de supresión y bloquea más envíos a ese número sin que tengas que hacer nada.
- 02
HELP devuelve una respuesta de ayuda.
Un destinatario que envía HELP recibe una respuesta de ayuda automática, así cumples el requisito de palabra clave de ayuda de los operadores sin cablear un handler.
- 03
START vuelve a suscribirlo.
La baja es reversible. Un destinatario que envía START se elimina de la lista de supresión y puede volver a recibir mensajes. Siempre tiene el control.
- 04
La lista de supresión es consultable, por destinatario.
Comprueba si un número está suprimido a través de la API antes de construir una audiencia, para que un destinatario que canceló nunca se cuele de nuevo en un envío.
Una cancelación llega como un evento firmado.
Cuando un destinatario cancela, Bird lo suprime y notifica a tu webhook con un evento sms.opted_out para que tus propios registros se mantengan sincronizados. El evento está firmado con HMAC como todos los webhooks de Bird.
{
"type": "sms.opted_out",
"data": {
"from": "+15005550006",
"keyword": "STOP",
"suppressed": true
}
}
La cancelación es un flujo entrante.
STOP, HELP y START llegan de la misma forma que cualquier otra respuesta: como mensajes entrantes en números bidireccionales. Bird intercepta las palabras clave reservadas y actúa sobre ellas antes de que lleguen a la lógica de tu aplicación, así obtienes el comportamiento de supresión de forma gratuita y sigues viendo todo lo demás que envían tus destinatarios.
Otros temas de cumplimiento
La cancelación es uno de los tres regímenes de cumplimiento de SMS. Mira el resto.
Respeta cada cancelación sin escribir un handler.
La cancelación es uno de los regímenes de cumplimiento de SMS en Bird. STOP, HELP y START se aplican en cada envío, con una lista de supresión que puedes consultar desde la misma API.