contact.note.created

Use contact.note.created para processar este evento no endpoint do seu webhook.

Gatilhos

Ocorre quando uma nota de contato é criada. Inscreva-se em contact.note.created ao configurar o endpoint do seu webhook. Mantenha a nota id separada de contactId. username e phoneNumber podem ser nulos.

Sintaxe

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

{
  "id": "<ID>",
  "type": "contact.note.created",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "contactNote": {
    "id": "<ID>",
    "contactId": "<CONTACT_ID>",
    "username": "<USERNAME>",
    "phoneNumber": "<PHONE_NUMBER>",
    "content": "<CONTENT>",
    "createTime": "<CREATE_TIME>",
    "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 do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`.
`type`	string	Sim	Sempre `contact.note.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
`contactNote`	object	Não	Payload de `contactNote` 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 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.

contactNote

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da nota. Tamanho mínimo: `24`. Tamanho máximo: `24`. Padrão: `^[0-9a-fA-F]{24}$`.
`contactId`	string	Sim	ID do contato ao qual a nota pertence.
`username`	string ou null	Sim	Nome de usuário do contato ao qual esta nota pertence, sem o caractere inicial `@`.
`phoneNumber`	string ou null	Sim	Número de telefone do contato ao qual esta nota pertence, no formato E.164.
`content`	string	Sim	Texto da nota. Tamanho máximo: `500`.
`createTime`	string (date-time)	Não	Horário em que a nota foi criada, no formato RFC 3339.
`updateTime`	string (date-time)	Não	Horário da última atualização da nota, no formato 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.

{
  "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": "+12025550124",
    "content": "Customer prefers follow-up in the morning.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

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

HTTP/1.1 200 OK

Para orientações passo a passo de cenários, consulte exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

contactNote

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​contactNote

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

contactNote

Exemplo