Pular para o conteúdo principal
A lista de opt-outs é a lista de supressão da sua equipe: números para os quais as campanhas não podem enviar mensagens. Ela vale para a equipe inteira, então um número que faz opt-out da campanha de um projeto fica suprimido em todos os projetos dessa equipe. A Polymorfa aplica a lista em dois momentos e a mantém atualizada a partir das respostas dos seus próprios contatos.

​
Onde a lista é aplicada

Como a segunda verificação acontece no momento do envio, um número adicionado à lista depois do lançamento de uma campanha também fica suprimido. Colocar de novo na fila um destinatário ignorado não envia para um número que está na lista.

​
Gerencie a lista diretamente

POST /platform/optouts/batch recebe um array phones e adiciona até 1.000 números em uma solicitação. A leitura exige uma chave de API da equipe com campaigns:read; toda alteração exige campaigns:manage. Tokens de projeto são recusados nas rotas de opt-out.

​
Respostas STOP e START

Com a captura de palavras-chave ativada, um contato que responde STOP a uma das mensagens das suas campanhas entra na lista de opt-outs, e um contato que responde START sai dela. Uma resposta só altera a lista quando todas as condições abaixo são atendidas:
  • É uma mensagem de texto direta, não uma mensagem de grupo.
  • A mensagem inteira corresponde a uma palavra-chave configurada. A comparação ignora maiúsculas e minúsculas e a pontuação e os espaços ao redor, então STOP, stop e stop! correspondem. please stop não corresponde.
  • O número que respondeu recebeu uma mensagem de campanha da sua equipe nos últimos 30 dias.
Uma palavra-chave de opt-in remove apenas um opt-out criado por uma resposta com palavra-chave. Um opt-out que você adicionou manualmente, por arquivo ou pela API nunca é removido por uma resposta, então uma supressão explícita continua valendo. A Polymorfa compara o corpo da mensagem em memória e o descarta. O corpo nunca é armazenado, e os eventos abaixo trazem a palavra-chave que correspondeu, nunca a mensagem.

​
Configure as palavras-chave

Esses são os valores padrão. updatedAt é null até você salvar as suas próprias configurações. PUT substitui os três campos de uma vez: envie todos eles e nada mais, porque um campo não reconhecido faz a solicitação falhar.
Defina enabled como false para parar de ler as respostas em busca de palavras-chave. A lista de opt-outs continua funcionando: as entradas existentes continuam suprimidas e a API ainda adiciona e remove números. Ler as configurações exige campaigns:read; alterá-las exige campaigns:manage. Os dois exigem uma chave de API da equipe.

​
Confirmações de saída opcionais

As confirmações de saída exigem acesso ao beta. Elas ficam desativadas por padrão, inclusive para equipes inscritas. Ler a preferência e desativá-la continuam disponíveis quando o acesso ao beta termina.
Um proprietário ou administrador da equipe pode ativar as confirmações em Campanhas → Opt-outs e escolher inglês, português do Brasil ou espanhol. A confirmação usa um texto fixo nesse idioma, sem links, mídia ou conteúdo promocional. As confirmações valem apenas para um novo opt-out capturado de uma resposta com palavra-chave correspondente. Mensagens STOP duplicadas, uma supressão existente e opt-outs adicionados manualmente ou por importação não geram confirmações. Um START posterior seguido de um novo STOP pode criar um novo opt-out e uma nova confirmação. A conexão que recebeu a resposta precisa continuar conectada e apta a enviar. Uma confirmação é enviada em até cinco minutos após a resposta original, pela mesma conexão. Saldo, restrições do provedor e proteções de envio continuam valendo. Números de dispositivo vinculado independentes e números da API oficial são compatíveis; números Hybrid Link e números de teste não enviam confirmações. Se o envio da confirmação falhar ou tiver resultado desconhecido, a supressão continua registrada. Um envio incerto nunca é reenviado. As contagens de resultados cobrem 30 dias; Aceitas pelo provedor não confirma a entrega. Use Ler as configurações de confirmação antes de atualizar a preferência. Envie o teamId e a revision retornados com os valores escolhidos de enabled e locale. Uma revisão desatualizada retorna 409; leia de novo antes de decidir se vai salvar outra alteração. A leitura exige campaigns:read, e alterar a preferência exige campaigns:manage em uma chave da equipe.
Substitua a equipe e a revisão do exemplo pelas que a sua leitura das configurações retornou. Este exemplo mantém as confirmações desativadas. Quando a CLI instalada incluir os comandos de confirmação de STOP, leia a equipe e a revisão e depois salve uma escolha explícita:
Use o teamId e a revision do seu próprio resultado de view. Para desativar as confirmações, execute update com --no-enabled e omita --locale. A CLI envia uma solicitação de atualização; depois de um erro ou de um tempo esgotado, leia a configuração antes de fazer outra alteração.

​
Eventos de webhook

Assine contact.opted_out e contact.opted_in para refletir as alterações por palavra-chave no seu próprio sistema.
source é sempre stop-keyword: esses dois eventos informam respostas com palavra-chave, não alterações que você faz pela API ou pelo Console. keyword é a palavra-chave configurada que correspondeu, em maiúsculas. Consulte Webhooks.