contact.unsubscribe.created

Use contact.unsubscribe.created para manipular este evento em seu endpoint de webhook.

Gatilhos

Ocorre quando um contato cancela a inscrição para receber mensagens. Inscreva-se em contact.unsubscribe.created ao configurar seu endpoint de webhook.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL de webhook configurada. O formato a seguir mostra uma variante de payload. Os valores entre colchetes angulares são marcadores de posição; seus tipos estão listados em Parâmetros. Campos opcionais e outras variantes são descritos abaixo.

{
  "id": "<ID>",
  "type": "contact.unsubscribe.created",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "unsubscriberChanged": {
    "phoneNumber": "<PHONE_NUMBER>",
    "source": "<SOURCE>",
    "updateTime": "<UPDATE_TIME>"
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte validação de assinatura.

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo para o evento. Comprimento mínimo: `6`. Comprimento máximo: `128`.
`type`	string	Sim	Sempre `contact.unsubscribe.created`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	O momento em que este evento foi criado, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Payload do evento

Parâmetro	Tipo	Obrigatório	Descrição
`unsubscriberChanged`	object	Não	Payload de `unsubscriberChanged` específico do evento.

Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objeto, Obrigatório se aplica quando o objeto pai estiver presente. Campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório.

unsubscriberChanged

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Identificador fornecido com a alteração de inscrição, quando disponível.
`phoneNumber`	string	Não	Número de telefone do cliente no formato E.164.
`source`	string	Não	Origem da alteração de inscrição. Os valores conhecidos incluem `Whatsapp`, `Inbox`, `Chatbot`, `API`, `Manual` e `Unknown`. Preserve valores não reconhecidos.
`updateTime`	string (date-time)	Não	Horário da alteração de inscrição, formatado em RFC 3339.

Exemplo

O JSON a seguir é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos.

Evento de cancelamento de inscrição do cliente

Exemplo de payload quando um cliente cancela a inscrição

{
  "id": "evt_3456789012",
  "type": "contact.unsubscribe.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "unsubscriberChanged": {
    "phoneNumber": "+12025550124",
    "source": "Whatsapp",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Exemplo de Contact Unsubscribe Created

{
  "id": "evt_68f8886903683f3481f9707b",
  "type": "contact.unsubscribe.created",
  "apiVersion": "v2",
  "createTime": "2025-10-22T07:31:53.872Z",
  "unsubscriberChanged": {
    "id": "68f888692abba5779b565928",
    "phoneNumber": "+12025550124",
    "source": "API",
    "updateTime": "2025-10-22T07:31:53.864Z"
  }
}

Após verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta 2xx. Processe tarefas lentas de forma assíncrona.

HTTP/1.1 200 OK

Para orientações detalhadas de cenários, consulte os exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

contact.unsubscribe.created

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

unsubscriberChanged

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​unsubscriberChanged

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

unsubscriberChanged

Exemplo