contact.deleted

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

Desencadenadores

Se produce cuando se elimina un contacto. Suscríbete a contact.deleted cuando configures tu endpoint de webhook.

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.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "contactDeleted": {
    "id": "<ID>",
    "remarkName": "<REMARK_NAME>",
    "nickName": "<NICK_NAME>",
    "phoneNumber": "<PHONE_NUMBER>",
    "updateTime": "<UPDATE_TIME>"
  }
}

Parámetros

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

Envoltura 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.deleted`.
`apiVersion`	string	Sí	Versión de la API utilizada para generar este evento.
`createTime`	string (date-time)	Sí	Fecha y hora en 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
`contactDeleted`	object	No	Carga útil de `contactDeleted` específica del evento.

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

contactDeleted

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	Sí	ID del contacto
`remarkName`	string	No	El nombre de observación gestionado por la empresa a partir de la instantánea del contacto eliminado.
`nickName`	string	No	Apodo del contacto.
`phoneNumber`	string	No	Número de teléfono único en formato E.164.
`updateTime`	string (date-time)	No	Fecha y hora en que se actualizó el contacto por última vez, con formato RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.

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.

Evento de contacto eliminado

Carga útil de ejemplo cuando se elimina un contacto

{
  "id": "evt_3456789012",
  "type": "contact.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactDeleted": {
    "id": "1824266594102064128",
    "remarkName": "Former customer",
    "nickName": "John Doe",
    "phoneNumber": "+12025550124",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Ejemplo básico de contacto eliminado

{
  "id": "evt_3456789012",
  "type": "contact.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactDeleted": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "phoneNumber": "+12025550124",
    "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 lentas de forma asíncrona.

HTTP/1.1 200 OK

Para ver guías detalladas de escenarios, consulta ejemplos comentados.

Primeros pasos

Guías

Endpoints

Webhook reference

Desencadenadores

Sintaxis

Parámetros

Envoltura del evento

Carga útil del evento

contactDeleted

Ejemplo

​Desencadenadores

​Sintaxis

​Parámetros

​Envoltura del evento

​Carga útil del evento

​contactDeleted

​Ejemplo

Desencadenadores

Sintaxis

Parámetros

Envoltura del evento

Carga útil del evento

contactDeleted

Ejemplo