contact.note.updated

Usa contact.note.updated para gestionar este evento en tu endpoint de webhook.

Disparadores

Se produce cuando se actualiza una nota de contacto. Suscríbete a contact.note.updated cuando configures tu endpoint de webhook. Mantén la nota id separada de contactId. username y phoneNumber pueden ser null.

Sintaxis

YCloud envía una solicitud HTTP POST a tu URL de webhook configurada. La siguiente estructura muestra una variante de carga útil. Los valores entre corchetes angulares son marcadores de posición; sus tipos se indican en Parámetros. Los campos opcionales y otras variantes se describen a continuación.

{
  "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

Valida el encabezado HTTP YCloud-Signature antes de procesar el cuerpo JSON. Consulta la validación de firmas.

Sobre del evento

Parámetro	Tipo	Requerido	Descripción
`id`	string	Sí	ID único para el evento. Longitud mínima: `6`. Longitud máxima: `128`.
`type`	string	Sí	Siempre `contact.note.updated`.
`apiVersion`	string	Sí	La versión de la API utilizada para generar este evento.
`createTime`	string (date-time)	Sí	La hora a la que se creó este evento, con formato RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.

Carga útil del evento

Parámetro	Tipo	Requerido	Descripción
`contactNote`	object	No	Carga útil de `contactNote` específica del evento.

Los cuatro campos comunes del sobre son obligatorios. Los campos de la carga útil dependen de la variante del evento. En cada tabla de objetos, Requerido aplica cuando su objeto superior está presente. Los campos opcionales se pueden omitir; que aparezcan en un ejemplo no hace que un campo sea obligatorio.

contactNote

Parámetro	Tipo	Requerido	Descripción
`id`	string	Sí	ID de la nota. Longitud mínima: `24`. Longitud máxima: `24`. Patrón: `^[0-9a-fA-F]{24}$`.
`contactId`	string	Sí	ID del contacto propietario de la nota.
`username`	string or null	Sí	Nombre de usuario del contacto propietario de esta nota, sin el `@` inicial.
`phoneNumber`	string or null	Sí	Número de teléfono del contacto propietario de esta nota en formato E.164.
`content`	string	Sí	Texto de la nota. Longitud máxima: `500`.
`createTime`	string (date-time)	No	Hora a la que se creó la nota, en formato RFC 3339.
`updateTime`	string (date-time)	No	Hora a la que se actualizó la nota por última vez, en formato RFC 3339.

Ejemplo

El siguiente JSON es el cuerpo entregado a tu receptor. Los ID, números de teléfono y otros valores de cuenta son 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"
  }
}

Tras verificar la firma y aceptar de forma duradera el evento, devuelve una respuesta 2xx. Procesa las tareas lentas de forma asíncrona.

HTTP/1.1 200 OK

Para ver análisis guiados de casos de uso, consulta los ejemplos anotados.

Primeros pasos

Guías

Endpoints

Webhook reference

Disparadores

Sintaxis

Parámetros

Sobre del evento

Carga útil del evento

contactNote

Ejemplo

​Disparadores

​Sintaxis

​Parámetros

​Sobre del evento

​Carga útil del evento

​contactNote

​Ejemplo

Disparadores

Sintaxis

Parámetros

Sobre del evento

Carga útil del evento

contactNote

Ejemplo