Desativação do WhatsApp

O Opt Out é uma forma de permitir que nossos usuários informem que desejam sair da conversa. Se eles informarem isso, nós os impedimos de receber mensagens da empresa.

Mecanismo de Opt Out

Atualmente, nosso Opt Out respeita as seguintes regras:

• Todos os clientes têm a mecânica de opt-out habilitada por padrão e não podem desativá-la.

• Nossa plataforma adiciona o usuário à lista de opt-out quando ele envia uma destas palavras:

  • Opt Out Palavras em Inglês:

    • parar

    • sair

  • Opt Out Palavras em espanhol:

    • detener

    • Salir

  • Opt Out Palavras em Português:

    • Parar

    • Sair

• Temos uma mensagem automática que será enviada ao usuário quando ele for adicionado à lista de desativação, isso é habilitado por padrão para todos os clientes, mas pode ser desabilitado. Se você quiser desativar essa mensagem automática para um cliente específico, basta abrir um ticket para nossa equipe de suporte ao cliente. Enviamos as mensagens automáticas de acordo com o idioma da palavra optOut:

  • Mensagem de resposta em inglês:

    • Seu pedido para sair da conversa foi atendido. Por favor, envie-#start para voltar!

  • Mensagem de resposta em espanhol:

    • Tu solicitud de abandonar la conversación se cumplió. ¡Envíe #volver para regresar!

  • Mensagem de resposta em português:

    • Seu pedido para sair da conversa foi atendido. Favor enviar #voltar para retornar!

• Quando um usuário está em opt-out, bloquearemos todos os modelos enviados a ele, a menos que o modelo esteja em uma das seguintes categorias: CUST_SERVICE ou OTP

• Nossa equipe de IA classifica os modelos em categorias automaticamente usando, adivinhe, IA!

• Todas as mensagens que não são modelos serão enviadas normalmente se a sessão estiver aberta.

• Nossa plataforma removerá o usuário da lista de exclusão quando ele enviar uma destas palavras:

  • Opt Out Palavras em Inglês:

    • #start

  • Opt Out Palavras em espanhol:

    • #volver

    • #recibir

  • Opt Out Palavras em Português:

    • #voltar

    • #receber

• Também enviamos uma mensagem automática ao usuário quando ele é removido da lista de desativação. Ele é habilitado por padrão para todos os clientes e pode ser desativado por nossa equipe de suporte ao cliente. Enviamos as mensagens automáticas de acordo com o idioma da palavra optOut:

  • Mensagem de resposta em inglês:

    • Seu pedido para voltar à conversa foi atendido! Bem-vindo de volta!

  • Mensagem de resposta em espanhol:

    • Se ha concedido su solicitud para volver a la conversación! Bienvenido de nuevo!

  • Mensagem de resposta em português:

    • Seu pedido de retornar à conversa foi atendido! Bem vindo de volta!

WhatsApp Opt Out Notificação de Evento

Cada opção de exclusão acionará um webhook de notificação com as informações do evento.

IMPORTANTE: O endpoint no qual o webhook será enviado deve ser previamente configurado com a equipe de suporte/operações.

O formato desta devolução será de acordo com a seguinte descrição:

Field	Details	Type
total	Número de retornos de chamada na chamada.	String
data	Lista de retorno de chamada.	Data[]
clientInfo	Informações ao Cliente	ClientInfo

Data:

Field	Details	Type
id	ID da última mensagem.	String
correlationId	Um ID exclusivo definido por você para corresponder aos retornos de chamada da mensagem. O mesmo id enviado no MT que correspondia ao MO que gerou o evento opt out.	String
destination	Telefone para o qual a mensagem foi enviada (incluindo o código do país). Exemplo: 5511900000000.	String
origin	Telefone que identifica a conta do WhatsApp (incluindo o código do país). Exemplo: 5511900000000.	String
campaignId	ID de campanha definido anteriormente.	String
campaignAlias	Alias de campanha definidos anteriormente.	String
extraInfo	Informações extras enviadas com a mensagem original.	String
conversation	O objeto de conversação, que contém em si id, origin.type e expiration. Esse objeto estava relacionado ao novo modelo faturável de mensagens de whatsapp. Veja a conversa do Whatsapp.	Conversation
eventType	Indica o tipo de evento de desativação. Pode assumir 'OPT_OUT' ou 'EXIT_OPT_OUT'. Se o valor for 'OPT_OUT', o usuário digitou opt out, caso contrário, se o valor for 'EXIT_OPT_OUT', o usuário saiu do optout.	String
eventDate	Data em que ocorreu o evento de desativação. Formato: aaaa-MM-dd'T'HH:mm:ssZ	String

ClientInfo

Field	Details	Type
customerId	Identificação do cliente.	Number
subAccountId	Identificação da subconta.	Number
userId	Identificação do usuário.	Number

Exemplo

cURL

{
  "total": 1,
  "data": [
    {
      "id": "8995c40f-1c3a-48d0-98ee-bbc603622a91",
      "correlationId": "...",
      "destination": "5519900000000",
      "origin": "5519900000000",
      "campaignId": 100,
      "campaignAlias": "...",
      "extraInfo": "...",
      "conversation": {
        "id": "conversationId123",
        "origin": {
          "type": "REFERRAL_CONVERSION"
        },
        "expiration": "2017-12-19T17:09:31.891Z"
      },
      "eventType": "OPT_OUT",
      "eventDate": "2023-03-22T17:21:38.000Z"
    }
  ],
  "clientInfo": {
      "customerId": 42,
      "subAccountId": 1291,
      "userId": 1
  }
}

Ruby

{
  "total": 1,
  "data": [
    {
      "id": "8995c40f-1c3a-48d0-98ee-bbc603622a91",
      "correlationId": "...",
      "destination": "5519900000000",
      "origin": "5519900000000",
      "campaignId": 100,
      "campaignAlias": "...",
      "extraInfo": "...",
      "conversation": {
        "id": "conversationId123",
        "origin": {
          "type": "REFERRAL_CONVERSION"
        },
        "expiration": "2017-12-19T17:09:31.891Z"
      },
      "eventType": "OPT_OUT",
      "eventDate": "2023-03-22T17:21:38.000Z"
    }
  ],
  "clientInfo": {
      "customerId": 42,
      "subAccountId": 1291,
      "userId": 1
  }
}

Python

{
  "total": 1,
  "data": [
    {
      "id": "8995c40f-1c3a-48d0-98ee-bbc603622a91",
      "correlationId": "...",
      "destination": "5519900000000",
      "origin": "5519900000000",
      "campaignId": 100,
      "campaignAlias": "...",
      "extraInfo": "...",
      "conversation": {
        "id": "conversationId123",
        "origin": {
          "type": "REFERRAL_CONVERSION"
        },
        "expiration": "2017-12-19T17:09:31.891Z"
      },
      "eventType": "OPT_OUT",
      "eventDate": "2023-03-22T17:21:38.000Z"
    }
  ],
  "clientInfo": {
      "customerId": 42,
      "subAccountId": 1291,
      "userId": 1
  }
}

PHP

{
  "total": 1,
  "data": [
    {
      "id": "8995c40f-1c3a-48d0-98ee-bbc603622a91",
      "correlationId": "...",
      "destination": "5519900000000",
      "origin": "5519900000000",
      "campaignId": 100,
      "campaignAlias": "...",
      "extraInfo": "...",
      "conversation": {
        "id": "conversationId123",
        "origin": {
          "type": "REFERRAL_CONVERSION"
        },
        "expiration": "2017-12-19T17:09:31.891Z"
      },
      "eventType": "OPT_OUT",
      "eventDate": "2023-03-22T17:21:38.000Z"
    }
  ],
  "clientInfo": {
      "customerId": 42,
      "subAccountId": 1291,
      "userId": 1
  }
}

Java

{
  "total": 1,
  "data": [
    {
      "id": "8995c40f-1c3a-48d0-98ee-bbc603622a91",
      "correlationId": "...",
      "destination": "5519900000000",
      "origin": "5519900000000",
      "campaignId": 100,
      "campaignAlias": "...",
      "extraInfo": "...",
      "conversation": {
        "id": "conversationId123",
        "origin": {
          "type": "REFERRAL_CONVERSION"
        },
        "expiration": "2017-12-19T17:09:31.891Z"
      },
      "eventType": "OPT_OUT",
      "eventDate": "2023-03-22T17:21:38.000Z"
    }
  ],
  "clientInfo": {
      "customerId": 42,
      "subAccountId": 1291,
      "userId": 1
  }
}