Ejemplos de Webhook para eliminación de contactos y notas

​

Qué es

​

Antes de empezar

• Crea un endpoint HTTPS público en tu aplicación.
• Configura un endpoint de Webhook de YCloud para los tipos de eventos que necesites.
• Guarda el secreto de firma del endpoint de forma segura.
• Haz que el procesamiento de eventos sea idempotente.

​

Cómo funciona

​

Solicitud

​

Respuesta

HTTP/1.1 200 OK

• La URL del endpoint de Webhook debe proporcionarla tu servidor en lugar de YCloud. Asegúrate de reemplazar la URL con la URL real de tu endpoint de Webhook.
• Asegúrate de que tu endpoint de Webhook esté escuchando los tipos de eventos adecuados. Consulta también Configurar Webhooks, API para recuperar un endpoint de webhook.

​

Ejemplo básico de contacto eliminado

​

Solicitud

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

​

Respuesta

HTTP/1.1 200 OK

​

Explicación

• Información mínima: El objeto contactDeleted solo contiene información esencial: id, nickName, phoneNumber e updateTime.
• Valores nulos: El campo nickName puede ser null si el contacto no tenía un apodo configurado.
• Hora de actualización: El campo updateTime refleja cuándo se modificó el contacto por última vez antes de su eliminación.
• ID de contacto: El campo id contiene el identificador único del contacto eliminado para referencia.
• Número de teléfono: El valor phoneNumber siempre está presente y tiene formato E.164.

​

Nota de contacto eliminada

​

Solicitud

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

​

Respuesta

HTTP/1.1 200 OK

​

Explicación