contact.unsubscribe.created

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

Desencadenadores

Se produce cuando un contacto cancela su suscripción a los mensajes. Suscríbete a contact.unsubscribe.created 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 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.unsubscribe.created",
  "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 firmas.

Envoltorio 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.created`.
`apiVersion`	string	Sí	La versión de la API utilizada para representar este evento.
`createTime`	string (date-time)	Sí	La fecha y hora en 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
`unsubscriberChanged`	object	No	Payload de `unsubscriberChanged` específico del evento.

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; una muestra no convierte un campo en obligatorio.

unsubscriberChanged

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	No	Identificador proporcionado con el cambio de suscripción, si 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. Entre los valores conocidos se 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, en formato RFC 3339.

Ejemplo

El siguiente JSON es el cuerpo entregado a tu receptor. Los identificadores, los números de teléfono y otros valores de la cuenta son ilustrativos.

Evento de cliente que cancela la suscripción

Ejemplo de payload cuando un cliente cancela su suscripción

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

Ejemplo de creación de cancelación de suscripción de contacto

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

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 descripciones detalladas de diferentes casos de uso, consulta los ejemplos comentados.

Primeros pasos

Guías

Endpoints

Webhook reference

contact.unsubscribe.created

Desencadenadores

Sintaxis

Parámetros

Envoltorio del evento

Payload del evento

unsubscriberChanged

Ejemplo

​Desencadenadores

​Sintaxis

​Parámetros

​Envoltorio del evento

​Payload del evento

​unsubscriberChanged

​Ejemplo

Desencadenadores

Sintaxis

Parámetros

Envoltorio del evento

Payload del evento

unsubscriberChanged

Ejemplo