contact.deleted

Use contact.deleted para processar este evento em seu endpoint de webhook.

Gatilhos

Ocorre quando um contato é excluído. Assine contact.deleted quando configurar seu endpoint de webhook.

Sintaxe

A YCloud envia uma solicitação HTTP POST para o URL de webhook configurado. 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.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "contactDeleted": {
    "id": "<ID>",
    "remarkName": "<REMARK_NAME>",
    "nickName": "<NICK_NAME>",
    "phoneNumber": "<PHONE_NUMBER>",
    "updateTime": "<UPDATE_TIME>"
  }
}

Parâmetros

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

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`.
`type`	string	Sim	Sempre `contact.deleted`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	O horário 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
`contactDeleted`	object	Não	Payload específico do evento `contactDeleted`.

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

contactDeleted

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do contato
`remarkName`	string	Não	O nome de observação gerenciado pela empresa do snapshot do contato excluído.
`nickName`	string	Não	Apelido do contato.
`phoneNumber`	string	Não	Número de telefone exclusivo no formato E.164.
`updateTime`	string (date-time)	Não	O horário em que o contato foi atualizado pela última vez, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

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 contato excluído

Exemplo de payload quando um contato é excluído

{
  "id": "evt_3456789012",
  "type": "contact.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactDeleted": {
    "id": "1824266594102064128",
    "remarkName": "Former customer",
    "nickName": "John Doe",
    "phoneNumber": "+12025550124",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Exemplo básico de contato excluído

{
  "id": "evt_3456789012",
  "type": "contact.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactDeleted": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "phoneNumber": "+12025550124",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

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

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

contactDeleted

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​contactDeleted

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

contactDeleted

Exemplo