Exemplos de webhook de criação de contato e anotação

Para o catálogo completo derivado do esquema, consulte todos os exemplos.

O que é

Processe eventos contact.created e contact.note.created.

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

A YCloud envia uma requisição HTTP POST quando o evento ocorre. Valide a assinatura, registre o evento de forma durável, retorne uma resposta 2xx e processe tarefas lentas de forma assíncrona.

Requisição

Os cenários abaixo mostram as requisições entregues ao seu URL de webhook. Trate o id do evento como o identificador de entrega e use type para rotear a carga útil.

Resposta

Retorne um status 2xx após aceitar o evento.

HTTP/1.1 200 OK

Para saber mais sobre a configuração de endpoints, validação de assinatura e comportamento de novas tentativas, consulte Configurar webhooks.

Ocorre quando um novo contato é criado. A carga útil do webhook contém todas as informações do contato que foi criado.

Exemplo de contato criado

Requisição

{
  "id": "evt_2345678901",
  "type": "contact.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactCreated": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "realName": "John Smith",
    "phoneNumber": "+16315551111",
    "countryCode": "US",
    "countryName": "United States",
    "email": "john.doe@example.com",
    "sourceType": "api",
    "sourceId": "import_batch_123",
    "sourceUrl": "https://example.com/signup",
    "lastSeen": "2024-01-01T11:59:00.000Z",
    "lastConnectedNumber": "+16315552222",
    "ownerEmail": "owner@example.com",
    "tags": [
      "premium",
      "newsletter"
    ],
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "blocked": false,
    "customAttributes": {
      "company": "YCloud Inc",
      "age": 25
    }
  }
}

Resposta

Confirme a entrega após aceitar o evento de forma durável.

HTTP/1.1 200 OK

Explicação

Informações completas do contato: o objeto contactCreated contém todas as informações de contato disponíveis no momento da criação.
Atributos personalizados: o campo customAttributes contém quaisquer dados personalizados associados ao contato.
Tags: o array tags contém quaisquer tags atribuídas ao contato durante a criação.

Anotação de contato criada

Use contact.note.created quando uma anotação de contato for criada.

Requisição

{
  "id": "evt_1234567890abcdef12345678",
  "type": "contact.note.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactNote": {
    "id": "6a3de646e18f344f743aaa4d",
    "contactId": "1824266594102064128",
    "username": "alice_01",
    "phoneNumber": "+16315551111",
    "content": "Customer prefers follow-up in the morning.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Resposta

Confirme a entrega após aceitar o evento de forma durável.

HTTP/1.1 200 OK

Explicação

Use contactNote.id para identificar a anotação e contactId para identificar o contato proprietário. username e phoneNumber descrevem o contato e podem ser nulos. A carga útil contém o instantâneo da anotação voltado para o cliente, incluindo content, sem identificadores internos de operadores.

Primeiros passos

Guias

Endpoints

Webhooks

Exemplos de webhook de criação de contato e anotação

O que é

Antes de começar

Como funciona

Requisição

Resposta

Exemplo de contato criado

Requisição

Resposta

Explicação

Anotação de contato criada

Requisição

Resposta

Explicação

​O que é

​Antes de começar

​Como funciona

​Requisição

​Resposta

​Exemplo de contato criado

​Requisição

​Resposta

​Explicação

​Anotação de contato criada

​Requisição

​Resposta

​Explicação

O que é

Antes de começar

Como funciona

Requisição

Resposta

Exemplo de contato criado

Requisição

Resposta

Explicação

Anotação de contato criada

Requisição

Resposta

Explicação