contact.unsubscribe.deleted

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

Desencadenadores

Se produce cuando un contacto reanuda la suscripción a los mensajes. Suscríbete a contact.unsubscribe.deleted cuando configures tu endpoint de webhook.

Sintaxis

YCloud envía una solicitud HTTP POST a la URL de webhook que hayas configurado. 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.unsubscribe.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "unsubscriberChanged": {
    "phoneNumber": "<PHONE_NUMBER>",
    "source": "<SOURCE>",
    "updateTime": "<UPDATE_TIME>"
  }
}

Parámetros

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

Sobre del evento

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	Sí	Identificador único del evento. Longitud mínima: `6`. Longitud máxima: `128`.
`type`	string	Sí	Siempre `contact.unsubscribe.deleted`.
`apiVersion`	string	Sí	La 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
`unsubscriberChanged`	object	No	Carga útil de `unsubscriberChanged` 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, Obligatorio aplica cuando su objeto principal está presente. Los campos opcionales pueden omitirse; un ejemplo no convierte a un campo en obligatorio.

unsubscriberChanged

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	No	Identificador proporcionado con el cambio de suscripción, cuando esté disponible.
`phoneNumber`	string	No	Número de teléfono del cliente en formato E.164.
`source`	string	No	Origen del cambio de suscripción. Los valores conocidos incluyen `Whatsapp`, `Inbox`, `Chatbot`, `API`, `Manual` y `Unknown`. Conserva los valores no reconocidos.
`updateTime`	string (date-time)	No	Fecha y hora del cambio de suscripción, con 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 meramente ilustrativos.

El cliente reanuda la suscripción

Carga útil de ejemplo cuando un cliente reanuda la suscripción

{
  "id": "evt_3456789012",
  "type": "contact.unsubscribe.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "unsubscriberChanged": {
    "phoneNumber": "+12025550124",
    "source": "Whatsapp",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Ejemplo de Contact Unsubscribe deleted

{
  "id": "evt_68f8886903683f3481f9707b",
  "type": "contact.unsubscribe.deleted",
  "apiVersion": "v2",
  "createTime": "2025-10-22T07:31:53.872Z",
  "unsubscriberChanged": {
    "id": "68f888692abba5779b565928",
    "phoneNumber": "+12025550124",
    "source": "API",
    "updateTime": "2025-10-22T07:31:53.864Z"
  }
}

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 guías paso a paso de situaciones de uso, consulta ejemplos comentados.

Primeros pasos

Guías

Endpoints

Webhook reference

contact.unsubscribe.deleted

Desencadenadores

Sintaxis

Parámetros

Sobre del evento

Carga útil del evento

unsubscriberChanged

Ejemplo

​Desencadenadores

​Sintaxis

​Parámetros

​Sobre del evento

​Carga útil del evento

​unsubscriberChanged

​Ejemplo

Desencadenadores

Sintaxis

Parámetros

Sobre del evento

Carga útil del evento

unsubscriberChanged

Ejemplo