Opt-out

STOP significa parar, automaticamente.

Qualquer destinatário pode enviar STOP para fazer opt-out, HELP para obter uma resposta de ajuda e START para voltar a subscrever. A Bird respeita estas palavras-chave automaticamente em cada envio e mantém uma lista de supressão por destinatário que pode consultar — sem código adicional do seu lado.

send-otp.ts

200 · 0.4s

import { BirdClient } from "@messagebird/sdk";

const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });

const code = generateOtp();

const { data, error } = await bird.sms.send({
  from: "Bird",
  to:   "+15005550006",
  text: `Your Bird verification code is ${code}. Reply STOP to opt out.`,
}).safe();

if (error) throw error;
console.log(data.id);
// → "sms_4kT01Lq2m..."

import { BirdClient } from "@messagebird/sdk";

const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });

const code = generateOtp();

const { data, error } = await bird.sms.send({
  from: "Bird",
  to:   "+15005550006",
  text: `Your Bird verification code is ${code}. Reply STOP to opt out.`,
}).safe();

if (error) throw error;
console.log(data.id);
// → "sms_4kT01Lq2m..."

send-otp.ts

200 · 0.4s

import { BirdClient } from "@messagebird/sdk";

const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });

const code = generateOtp();

const { data, error } = await bird.sms.send({
  from: "Bird",
  to:   "+15005550006",
  text: `Your Bird verification code is ${code}. Reply STOP to opt out.`,
}).safe();

if (error) throw error;
console.log(data.id);
// → "sms_4kT01Lq2m..."

import { BirdClient } from "@messagebird/sdk";

const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });

const code = generateOtp();

const { data, error } = await bird.sms.send({
  from: "Bird",
  to:   "+15005550006",
  text: `Your Bird verification code is ${code}. Reply STOP to opt out.`,
}).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 opt-out é reversível. Um destinatário que envia START é removido da supressão e pode voltar a receber mensagens — está sempre no controlo.
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.

POST /webhooks/bird

sms.opted_out

{
  "type": "sms.opted_out",
  "data": {
    "from": "+15005550006",
    "keyword": "STOP",
    "suppressed": true
  }
}

O opt-out é um fluxo de entrada.

O STOP, o HELP e o START chegam da mesma forma que qualquer resposta — como mensagens recebidas em números bidirecionais. A Bird interceta as palavras-chave reservadas e age sobre elas antes de chegarem à lógica da sua aplicação, por isso obtém o comportamento de supressão de graça e continua a ver tudo o resto que os seus destinatários enviam.

Perguntas frequentes sobre opt-out

Tenho de tratar do STOP eu próprio?+

Não. A Bird reconhece o STOP em cada envio, suprime o destinatário e bloqueia mensagens futuras para esse número. Não escreve nem mantém qualquer lógica de palavras-chave.

O que faz cada um — STOP, HELP e START?+

O STOP suprime o destinatário e interrompe as mensagens. O HELP devolve uma resposta de ajuda automática. O START reverte um opt-out anterior e volta a subscrever o destinatário. Cada um é aplicado por destinatário.

Um destinatário que fez opt-out pode voltar?+

Sim. O opt-out é reversível. Um destinatário que envie START é removido da lista de supressão e pode voltar a receber mensagens. A escolha continua a ser do destinatário.

Como verifico se um número está suprimido?+

A lista de supressão é um recurso da API que pode consultar. Verifique um número antes de construir uma audiência para que um destinatário que fez opt-out nunca volte a entrar num envio.

Outros tópicos de conformidade

O opt-out é um de três regimes de conformidade de SMS. Veja os restantes.

A2P 10DLCRegisto de marca e campanha para tráfego de aplicações dos EUA.Registo de sender IDPré-registe sender IDs alfanuméricos onde os países o exigem.Toda a conformidade de SMS10DLC, opt-out e registo de sender ID num único lugar.Visão geral da API de SMSA API de SMS completa: envio, números, bidirecional, conformidade, encaminhamento e analítica.

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.

Explorar a conformidade de SMS Começar