contact.note.deleted

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

Activadores

Se produce cuando se elimina una nota de contacto de forma independiente. La eliminación de un contacto no emite este evento para las notas en cascada. Suscríbete a contact.note.deleted cuando configures tu endpoint de webhook. Eliminar un contacto no emite este evento para sus notas en cascada. Mantén el id de la nota separado de contactId.

Sintaxis

YCloud envía una solicitud HTTP POST a tu URL de webhook configurada. La siguiente estructura muestra una variante de la 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.deleted",
  "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 validación de firmas.

Envoltorio del evento

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	Sí	ID único del evento. Longitud mínima: `6`. Longitud máxima: `128`.
`type`	string	Sí	Siempre `contact.note.deleted`.
`apiVersion`	string	Sí	La versión de la API utilizada para representar este evento.
`createTime`	string (date-time)	Sí	La fecha y hora en 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	Obligatorio	Descripción
`contactNote`	object	No	Carga útil de `contactNote` específica del evento.

Los cuatro campos comunes del envoltorio son obligatorios. Los campos de la carga útil dependen de la variante del evento. En cada tabla de objetos, Obligatorio aplica cuando su objeto primario está presente. Los campos opcionales pueden omitirse; un ejemplo no convierte un campo en obligatorio.

contactNote

Parámetro	Tipo	Obligatorio	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 al que pertenece la nota.
`username`	string o null	Sí	Nombre de usuario del contacto al que pertenece esta nota, sin el carácter `@` inicial.
`phoneNumber`	string o null	Sí	Número de teléfono del contacto al que pertenece esta nota en formato E.164.
`content`	string	Sí	Texto de la nota. Longitud máxima: `500`.
`createTime`	string (date-time)	No	Hora en la que se creó la nota, en formato RFC 3339.
`updateTime`	string (date-time)	No	Hora en 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. Se emite únicamente al eliminar una nota de forma independiente, no cuando se elimina un contacto en cascada.

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

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

HTTP/1.1 200 OK

Para ver análisis de escenarios, consulta los ejemplos anotados.

Primeros pasos

Guías

Endpoints

Webhook reference

Activadores

Sintaxis

Parámetros

Envoltorio del evento

Carga útil del evento

contactNote

Ejemplo

​Activadores

​Sintaxis

​Parámetros

​Envoltorio del evento

​Carga útil del evento

​contactNote

​Ejemplo

Activadores

Sintaxis

Parámetros

Envoltorio del evento

Carga útil del evento

contactNote

Ejemplo