Exemplos de Webhook de Contato Excluído

​

O que é

​

Antes de começar

• Crie um endpoint HTTPS público na sua aplicação.
• Configure um endpoint de webhook da YCloud para os tipos de eventos necessários.
• Armazene o segredo de assinatura do endpoint com segurança.
• Torne o processamento de eventos idempotente.

​

Como funciona

​

Requisição

​

Resposta

HTTP/1.1 200 OK

• O URL do endpoint de webhook deve ser fornecido pelo seu servidor, e não pela YCloud. Certifique-se de substituir o URL pelo URL real do seu endpoint de webhook.
• Certifique-se de que o seu endpoint de webhook esteja ouvindo os tipos de eventos apropriados. Consulte também Configurar Webhooks, API Obter um endpoint de webhook.

​

Exemplo Básico de Contato Excluído

​

Requisição

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

​

Resposta

HTTP/1.1 200 OK

​

Explicação

• Informações Mínimas: O objeto contactDeleted contém apenas informações essenciais: id, nickName, phoneNumber e updateTime.
• Valores Nulos: O campo nickName pode ser null se o contato não tiver um apelido definido.
• Horário de Atualização: O updateTime reflete quando o contato foi modificado pela última vez antes da exclusão.
• ID do Contato: O campo id contém o identificador exclusivo do contato excluído para referência.
• Número de Telefone: O phoneNumber está sempre presente e formatado no padrão E.164.