> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerenciamento de palavras-chave de consentimento SMS

> Gerencie palavras-chave de opt-out de SMS, fluxos de reinscrição e respostas automáticas. Aborda o comportamento de STOP/HELP/START, cancelamento de assinatura via web para remetentes alfanuméricos, estratégias de opt-out de remetentes compartilhados e a visualização do status de consentimento dos assinantes.

Gerenciar opt-outs corretamente mantém seu programa em conformidade e protege os assinantes que desejam parar de receber mensagens. A forma como você lida com opt-outs depende do seu tipo de remetente: se ele pode ou não receber respostas de entrada.

***

## Palavras-chave de opt-out

`STOP`, `HELP` e `START` são as palavras-chave canônicas de conformidade exigidas pelas operadoras. Suas respostas padrão são protegidas e não podem ser alteradas pelo painel ou pela API do OneSignal:

* `STOP` cancela a inscrição do usuário nas mensagens SMS de um remetente específico. Os aliases reconhecidos (`UNSUBSCRIBE`, `CANCEL`) compartilham a mesma resposta protegida.
* `HELP` retorna informações sobre o seu programa de mensagens.
* `START` permite que o usuário volte a se inscrever após o opt-out. Os aliases reconhecidos (`UNSTOP`, `YES`) compartilham a mesma resposta protegida.

Para personalizar uma resposta padrão, entre em contato com `support@onesignal.com` informando seu App ID e a nova mensagem de resposta.

Por padrão, quando um usuário envia STOP, o OneSignal responde: *"You have successfully been unsubscribed. You will not receive any more messages from this number. Reply START to resubscribe."*

<Note>
  Por padrão, um opt-out impede apenas as mensagens do remetente específico para o qual o assinante enviou a mensagem. Isso garante que os opt-outs sejam delimitados ao caso de uso. Um assinante que envia STOP para o seu remetente promocional continua recebendo mensagens transacionais e OTPs dos seus outros remetentes.
</Note>

***

## Gerenciando opt-outs para remetentes alfanuméricos

IDs de remetente alfanuméricos (por exemplo, "ACME" em vez de um número de telefone) não podem receber respostas de entrada, o que significa que os assinantes não conseguem enviar STOP para fazer opt-out. Para se manter em conformidade, você deve fornecer uma página de cancelamento de assinatura via web que processe o opt-out e atualize o status do assinante no OneSignal por meio da API.

<Steps>
  <Step title="Inclua um link de cancelamento de assinatura em cada mensagem">
    Adicione uma URL para uma página de cancelamento de assinatura hospedada em cada SMS que você enviar. Use as tags Liquid do OneSignal para identificar o assinante na URL:

    ```
    To opt out: https://yourbrand.com/sms-unsubscribe?uid={{ onesignal_id }}
    ```

    O OneSignal renderiza `{{ onesignal_id }}` (ou `{{ subscription_id }}`) no ID real do assinante no momento do envio, de modo que cada destinatário recebe um link de cancelamento de assinatura personalizado.
  </Step>

  <Step title="Crie a página de cancelamento de assinatura">
    Hospede uma página web simples nessa URL. Quando a página é carregada, ela lê o ID do assinante a partir do parâmetro de consulta. A página deve:

    * Confirmar ao assinante do que ele está fazendo opt-out (por exemplo, "You will no longer receive promotional text messages from ACME.")
    * Exibir um botão de confirmação. Não faça o cancelamento automático da assinatura ao carregar a página, pois cliques acidentais e pré-visualizações de links poderiam acionar opt-outs não intencionais.
    * Opcionalmente, permitir que o assinante escolha de quais tipos de mensagem deseja fazer opt-out, caso você envie vários tipos a partir do mesmo remetente.
  </Step>

  <Step title="Chame a API do OneSignal para processar o opt-out">
    Quando o assinante confirmar, chame a API do OneSignal para atualizar o status de assinatura dele. Duas opções, dependendo do escopo:

    * **Cancelamento total da assinatura do remetente:** Use a [API Update Subscription](/reference/update-subscription) para definir o status da assinatura como unsubscribed.
    * **Opt-out de um tipo de mensagem específico:** Use a [API Edit Tags](/reference/edit-tags-with-external-user-id) para definir uma tag (por exemplo, `promo = false`) e, em seguida, exclua os assinantes com essa tag ao enviar esse tipo de mensagem.
  </Step>

  <Step title="Exiba uma confirmação">
    Após a chamada da API ser bem-sucedida, exiba uma mensagem de confirmação (por exemplo, "You've been unsubscribed. You will no longer receive promotional texts from ACME.").
  </Step>
</Steps>

<Card title="Opt-in e coleta de SMS" icon="user-plus" href="./sms-opt-in-and-collection">
  Colete consentimento válido antes de enviar SMS, para que os assinantes cheguem a este fluxo de opt-out somente depois de fazerem opt-in.
</Card>

***

## Gerenciando opt-outs para remetentes compartilhados

<Warning>
  Não recomendamos compartilhar remetentes entre programas de mensagens de texto (promocionais, transacionais ou OTP). Quando um assinante envia STOP, ele cancela a inscrição do remetente inteiro, o que significa que fazer opt-out de mensagens promocionais também bloquearia mensagens transacionais, como confirmações de pedido ou alertas de conta. Use remetentes separados para cada caso de uso sempre que possível.
</Warning>

Se você tiver um remetente compartilhado, pode usar palavras-chave personalizadas para permitir que os assinantes façam opt-out de tipos de mensagem específicos sem cancelar a inscrição de tudo. Isso funciona marcando os assinantes com uma tag quando eles enviam uma palavra-chave de opt-out e, em seguida, excluindo esses assinantes ao enviar aquele tipo de mensagem.

**Como funciona:**

1. Um assinante envia uma palavra-chave de opt-out personalizada ao seu remetente (por exemplo, NOPROMO).
2. O OneSignal aplica uma tag de dados ao perfil desse assinante (por exemplo, `promo = false`).
3. Quando você envia uma campanha promocional, filtra seu público para excluir os assinantes em que `promo = false`.

**Configurando palavras-chave de opt-out personalizadas:**

Acesse **Settings > Platforms > SMS Settings > Keywords** e crie uma palavra-chave para cada caso de uso do qual você deseja que os assinantes possam fazer opt-out de forma independente.

**Exemplo: palavra-chave de opt-out promocional (NOPROMO):**

1. Insira o texto da palavra-chave (por exemplo, NOPROMO).
2. Defina o escopo de público como **Anyone**.
3. Selecione ou crie um modelo de resposta (por exemplo, *"You've been unsubscribed from promotional messages. You'll still receive order and account notifications. Text STOP to unsubscribe from all messages."*).
4. Atribua uma tag de dados: `promo = false`.

Repita para cada caso de uso. Para mensagens transacionais, crie NOTRANSACT com `transactional = false`.

**Excluindo assinantes que fizeram opt-out no momento do envio:**

Ao criar uma campanha ou Journey para um caso de uso específico, use o filtro **User Tag** em Segments para excluir os assinantes que fizeram opt-out. Por exemplo, ao enviar uma mensagem promocional, exclua os assinantes em que `promo = false`.

**Limitações importantes:**

* As palavras-chave padrão de conformidade (STOP, HELP, START) ainda se aplicam ao remetente inteiro e não podem ser delimitadas a um caso de uso.
* Você deve incluir a palavra-chave de opt-out personalizada em cada mensagem desse tipo (por exemplo, *"Reply NOPROMO to stop promotional texts"*).
* IDs de remetente alfanuméricos não podem receber respostas e não suportam palavras-chave.
* A sincronização de respostas deve estar habilitada. Acesse **Settings > Platforms > SMS Settings > Senders > Setup Replies**.

<Card title="Palavras-chave SMS" icon="message" href="./keywords">
  Referência completa para configurar palavras-chave personalizadas, incluindo campanhas bidirecionais e centros de preferências.
</Card>

***

## Reinscrição

Depois que um usuário faz opt-out usando uma palavra-chave de opt-out padrão, ele não pode ser reinscrito pelo painel ou pela API do OneSignal. O usuário deve enviar uma palavra-chave de reinscrição (`START`, `UNSTOP` ou `YES`) para o mesmo número de remetente.

***

## Palavra-chave HELP

Por padrão, quando um usuário envia HELP, o OneSignal responde: *"Reply STOP to unsubscribe. Msg\&Data Rates May Apply."*

***

## Resposta automática

Defina uma resposta automática para qualquer mensagem recebida que não corresponda a uma palavra-chave. Use isso para redirecionar os usuários ao suporte ao cliente, coletar a intenção deles ou notificar sua equipe para acompanhamento.

<Steps>
  <Step title="Acesse as configurações de Auto-Responder">
    Navegue até **Settings > Platforms > SMS Settings > Auto-Responder**.
  </Step>

  <Step title="Adicione uma resposta automática">
    Clique em **Add Auto-Responder** e selecione um modelo de resposta.
  </Step>

  <Step title="Opcionalmente, marque o usuário com uma tag">
    Atribua uma tag de dados quando a resposta automática for acionada para habilitar segmentação ou alertas futuros.
  </Step>
</Steps>

***

## Visualizando o status de opt-out de um assinante

Para ver de quais remetentes um assinante fez opt-out:

1. Acesse **Audience > Subscriptions** no painel do OneSignal.
2. Pesquise o assinante por External ID, e-mail ou número de telefone.
3. Abra a assinatura SMS dele e veja em **Consent by Sender**.

Esta seção mostra o status de opt-in ou opt-out de cada remetente associado a essa assinatura.

***

## Perguntas frequentes

### O que acontece quando um usuário envia STOP para um remetente compartilhado?

Ele faz opt-out de todas as mensagens desse remetente, incluindo mensagens transacionais e OTPs. É por isso que recomendamos fortemente usar remetentes separados para cada tipo de programa. Uma vez feito o opt-out via STOP, o usuário deve enviar START (ou outra palavra-chave de reinscrição) para o mesmo remetente para voltar a receber mensagens.

### Posso alterar as mensagens de resposta de STOP ou HELP?

Sim, mas não pelo painel ou pela API. Entre em contato com `support@onesignal.com` informando seu App ID e o novo texto de resposta.

### Qual mecanismo de opt-out devo usar para IDs de remetente alfanuméricos?

IDs de remetente alfanuméricos não podem receber respostas, então você deve incluir um link de cancelamento de assinatura em cada mensagem e criar uma página de cancelamento de assinatura via web que chame a API do OneSignal para processar o opt-out. Consulte a seção [Gerenciando opt-outs para remetentes alfanuméricos](#managing-opt-outs-for-alphanumeric-senders) acima.

### Posso reinscrever um usuário que enviou STOP?

Você não pode reinscrever um usuário pelo painel ou pela API. O usuário deve enviar START, UNSTOP ou YES para o mesmo número de remetente para voltar a se inscrever.

### Como evito que um único STOP bloqueie todos os tipos de mensagem?

Use remetentes separados para cada tipo de programa (promocional, transacional, OTP). Se você precisar usar um remetente compartilhado, configure palavras-chave de opt-out personalizadas (por exemplo, NOPROMO) e exclua os assinantes que fizeram opt-out por tag no momento do envio. Observe que a palavra-chave padrão STOP ainda cancela a inscrição do remetente inteiro.