Eliminar chat

Marca el chat como eliminado internamente y, opcionalmente, también lo elimina del lado de WhatsApp.

API de WhatsApp y CRM

Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.

DELETE https://api.getincloud.ai/v1/chat/{deviceId}/chats/{chatWid}

Marca el chat como eliminado internamente y, opcionalmente, también lo elimina del lado de WhatsApp.

La sesión de WhatsApp debe estar en línea y sincronizada para poder eliminar el chat; de lo contrario, la API devolverá un error 503.

Notas

* Si el chat se elimina en WhatsApp, los mensajes dejarán de ser accesibles en la aplicación móvil, pero si los mensajes del chat se sincronizaron, seguirá habiendo una copia del chat accesible en el chat en vivo multiagente y mediante la API.

* De forma predeterminada, los chats y mensajes eliminados no se borran del sistema, sino que permanecen accesibles temporalmente desde el Chat y la API durante 30 días antes de su eliminación definitiva, para tu comodidad y para futuras consultas.

* Si un chat ya eliminado se inicia de nuevo con el mismo usuario, el chat volverá a la lista de chats activos, omitiendo el proceso de eliminación.

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y prueba el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Cuerpo de la petición

Campo	Tipo	Obligatorio	Descripción
`whatsapp`	boolean	No	Elimina el chat en la aplicación de WhatsApp. Requiere que la sesión esté en línea; de lo contrario, devolverá un error, a menos que el parámetro `force` del cuerpo se establezca en `true`. `default: False`
`force`	boolean	No	Fuerza a marcar el chat como eliminado cuando el campo `whatsapp` está establecido en `true` y el chat no se puede eliminar del lado de WhatsApp. `default: False`

Respuestas

Código	Descripción
`204`	Chat eliminado correctamente
`400`	ID o datos del cuerpo no válidos
`401`	No autorizado: token de API no válido o ausente
`403`	Faltan los permisos necesarios
`404`	Chat no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	La sesión no está en línea o sincronizada: inténtalo de nuevo

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Flag chat as deleted (internally only, but do not delete it on the WhatsApp side)
curl --request DELETE \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/chats/{chatWid} \
  --header 'Token: <api token goes here>'


// Flag chat as deleted and delete on WhatsApp (number session must be online, otherwise the API will return a 503 error)
curl --request DELETE \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/chats/{chatWid} \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"whatsapp":true}'

AnteriorEditar mensaje SiguienteEliminar contacto

¿Te sirvió esta página?