contact.note.created

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

Desencadenadores

Se produce cuando se crea una nota de contacto. Suscríbete a contact.note.created cuando configures tu endpoint de webhook. Mantén el id de la nota separado de contactId. username y phoneNumber pueden ser nulos.

Sintaxis

YCloud envía una solicitud HTTP POST a tu URL de webhook configurada. La siguiente estructura muestra una variante del payload. 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.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

Valida el encabezado HTTP YCloud-Signature antes de procesar el cuerpo JSON. Consulta la 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.created`.
`apiVersion`	string	Sí	La versión de la API utilizada para generar este evento.
`createTime`	string (date-time)	Sí	Fecha y hora en la que se creó este evento, en formato RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.

Payload del evento

Parámetro	Tipo	Obligatorio	Descripción
`contactNote`	object	No	Payload específico del evento `contactNote`.

Los cuatro campos comunes del envoltorio son obligatorios. Los campos del payload dependen de la variante del evento. En cada tabla de objetos, Obligatorio aplica cuando su objeto superior está presente. Los campos opcionales pueden omitirse; que aparezcan en un ejemplo no hace que un campo sea 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 `@` 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	Fecha y hora en la que se creó la nota, en formato RFC 3339.
`updateTime`	string (date-time)	No	Fecha y hora en la que se actualizó la nota por última vez, en formato RFC 3339.

Ejemplo

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

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

HTTP/1.1 200 OK

Para consultar guías detalladas con casos prácticos, consulta los ejemplos anotados.

Primeros pasos

Guías

Endpoints

Webhook reference

Desencadenadores

Sintaxis

Parámetros

Envoltorio del evento

Payload del evento

contactNote

Ejemplo

​Desencadenadores

​Sintaxis

​Parámetros

​Envoltorio del evento

​Payload del evento

​contactNote

​Ejemplo

Desencadenadores

Sintaxis

Parámetros

Envoltorio del evento

Payload del evento

contactNote

Ejemplo