Exemplos de webhook para exclusão de contatos e notas

​

O que é

​

Antes de começar

• Crie um endpoint HTTPS público em sua aplicação.
• Configure um endpoint de Webhook da YCloud para os tipos de evento de que você precisa.
• Armazene o segredo de assinatura do endpoint com segurança.
• Torne o processamento de eventos idempotente.

​

Como funciona

​

Solicitação

​

Resposta

HTTP/1.1 200 OK

• A URL do endpoint de Webhook deve ser fornecida pelo seu servidor, e não pela YCloud. Certifique-se de substituir a URL pela URL real do seu endpoint de Webhook.
• Certifique-se de que seu endpoint de Webhook esteja escutando os tipos de evento apropriados. Consulte também Configurar Webhooks, Recuperar uma API de endpoint de Webhook.

​

Exemplo básico de contato excluído

​

Solicitaçã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.

​

Nota de contato excluída

​

Solicitação

{
  "id": "evt_3234567890abcdef12345678",
  "type": "contact.note.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-03T12:00:00.000Z",
  "contactNote": {
    "id": "6a3de646e18f344f743aaa4d",
    "contactId": "1824266594102064128",
    "username": "alice_01",
    "phoneNumber": "+16315551111",
    "content": "Customer now prefers afternoon follow-up.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-02T12:00:00.000Z"
  }
}

​

Resposta

HTTP/1.1 200 OK

​

Explicação