contact.note.updated

Use contact.note.updated para manipular este evento no seu endpoint de webhook.

Gatilhos

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

Sintaxe

A YCloud envia uma requisição HTTP POST para a URL de webhook configurada. A estrutura 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.note.updated",
  "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.updated`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (data-hora)	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 específico do evento `contactNote`.

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 seu objeto pai está 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 proprietário da nota.
`username`	string ou null	Sim	Nome de usuário do contato proprietário desta nota, sem o `@` inicial.
`phoneNumber`	string ou null	Sim	Número de telefone do contato proprietário desta nota no formato E.164.
`content`	string	Sim	Texto da nota. Tamanho máximo: `500`.
`createTime`	string (data-hora)	Não	Momento em que a nota foi criada, no formato RFC 3339.
`updateTime`	string (data-hora)	Não	Momento em que a nota foi atualizada pela última vez, 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_2234567890abcdef12345678",
  "type": "contact.note.updated",
  "apiVersion": "v2",
  "createTime": "2024-01-02T12:00:00.000Z",
  "contactNote": {
    "id": "6a3de646e18f344f743aaa4d",
    "contactId": "1824266594102064128",
    "username": "alice_01",
    "phoneNumber": "+12025550124",
    "content": "Customer now prefers afternoon follow-up.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-02T12:00:00.000Z"
  }
}

Após verificar a assinatura e aceitar o evento de forma durável, 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

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