Cada destinatário pode enviar STOP para cancelar a subscrição, HELP para obter uma resposta de ajuda e START para voltar a subscrever. Bird reconhece estas palavras-chave automaticamente em cada envio e mantém uma lista de supressão por destinatário que pode consultar. Sem código extra do seu lado.
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..."
O opt-out é a regra que está sempre ativa.
O tratamento de opt-out faz parte da conformidade de SMS na API de SMS da Bird e, ao contrário do registo, aplica-se em todo o lado para onde envia, sem configuração. As palavras-chave reservadas STOP, HELP e START são reconhecidas nas mensagens recebidas e aplicadas por destinatário, por isso uma pessoa que faz opt-out continua em opt-out ao longo dos seus envios até escolher voltar.
Como se comportam as palavras-chave.
Palavras-chave reservadas, aplicadas por destinatário.
- 01
O STOP suprime automaticamente.
Quando um destinatário envia STOP, a Bird adiciona-o à lista de supressão e bloqueia envios futuros para esse número sem qualquer ação da sua parte.
- 02
O HELP devolve uma resposta de ajuda.
Um destinatário que envia HELP recebe uma resposta de ajuda automática, por isso cumpre o requisito de palavra-chave de ajuda dos operadores sem montar um handler.
- 03
O START volta a subscrevê-los.
O cancelamento é reversível. Um destinatário que envie START é removido da lista de supressão e pode voltar a receber mensagens. O controlo está sempre do lado dele.
- 04
A lista de supressão é consultável, por destinatário.
Verifique se um número está suprimido através da API antes de construir uma audiência, para que um destinatário que fez opt-out nunca volte a escapulir-se para um envio.
Um opt-out chega como evento assinado.
Quando um destinatário faz opt-out, a Bird suprime-o e notifica o seu webhook com um evento sms.opted_out para que os seus próprios registos se mantenham sincronizados. O evento é assinado com HMAC como todos os webhooks da Bird.
{
"type": "sms.opted_out",
"data": {
"from": "+15005550006",
"keyword": "STOP",
"suppressed": true
}
}
O opt-out é um fluxo de entrada.
STOP, HELP e START chegam da mesma forma que qualquer resposta — como mensagens recebidas em números bidirecionais. Bird interceta as palavras-chave reservadas e atua sobre elas antes de chegarem à lógica da sua aplicação, para que obtenha o comportamento de supressão gratuitamente e continue a ver tudo o resto que os seus destinatários enviam.
Outros tópicos de conformidade
O opt-out é um de três regimes de conformidade de SMS. Veja os restantes.
Respeite cada opt-out sem escrever um handler.
O opt-out é um regime de conformidade de SMS na Bird. O STOP, o HELP e o START são aplicados em cada envio, com uma lista de supressão que pode consultar a partir da mesma API.