Vaciar cola

Elimina todos los mensajes en cola, o un subconjunto de ellos, del número de WhatsApp especificado por ID.

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/devices/{deviceId}/queue

Elimina todos los mensajes en cola, o un subconjunto de ellos, del número de WhatsApp especificado por ID.

Nota: solo se eliminarán los mensajes con estado queued.

Los mensajes con estado processing, failed o processed no se verán afectados por esta operació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 la API en el probador 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.

Parámetros

Campo	Dónde	Tipo	Obligatorio	Descripción
`wait`	query	boolean	No	Espera hasta que se hayan eliminado todos los mensajes en cola. La respuesta de la API puede tardar hasta 90 segundos si hay miles de mensajes en cola. Considera usar un tiempo de espera de solicitud mayor si utilizas esta opción. `default: False`

Cuerpo de la petición

Campo	Tipo	Obligatorio	Descripción
`skipScheduled`	boolean	No	No elimina los mensajes programados que se entregarán en el futuro. De forma predeterminada, los mensajes programados también se eliminan.
`ids`	array<string>	No	Opcionalmente, elimina mensajes en cola por ID de mensaje (valor hexadecimal de 24 caracteres).
`phones`	array<string>	No	Opcionalmente, elimina mensajes en cola por número de teléfono de destino en formato E164. Ej.: +1234567890
`numbers`	array<string>	No	Alias obsoleto de `phones`, que se mantiene porque la consola web lo envía. El esquema JSON generado prohíbe campos desconocidos, por lo que omitirlo aquí hacía que toda solicitud de la consola que filtraba por número de teléfono fallara la validación con un error 400.
`groups`	array<string>	No	Opcionalmente, elimina mensajes en cola por ID de WhatsApp de grupo o lista de difusión de destino. Ej.: 1234567890-000000000@g.us o 120000000000000000@g.us
`before`	string	No	Opcionalmente, elimina todos los mensajes en cola creados antes de la fecha ISO 8601 indicada. Ej.: 2022-01-03T18:25:32+00:00 `maxLength: 30` · `format: date-time`
`after`	string	No	Opcionalmente, elimina todos los mensajes en cola creados después de la fecha ISO 8601 indicada. Ej.: 2022-02-03T18:25:32+00:00 `maxLength: 30` · `format: date-time`

Respuestas

Código	Descripción
`200`	Nuevas estadísticas de la cola del dispositivo
`400`	Datos de consulta o de cuerpo de la solicitud no válidos
`401`	Acceso no autorizado por token de API no válido o caducado
`403`	Falta el token de API requerido
`404`	Número no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes. Inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio no disponible temporalmente. Inténtalo de nuevo más tarde

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

// Remove all queued messages in the current WhatsApp number queue.
curl --request DELETE \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{}'


// Remove only a subset of queued messages by date range in the current WhatsApp number queue.
curl --request DELETE \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"after":"2023-01-01T00:00:00.000Z","before":"2023-03-01T00:00:00.000Z"}'


// Remove all queued messages except scheduled messages that will be delivered in a future date
curl --request DELETE \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"skipScheduled":true}'


// Remove only a subset of queued messages by target phone numbers in the current WhatsApp number queue.
curl --request DELETE \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phones":["+1234567890","+1234567890","+1234567890","+1234567890"]}'


// Remove only a subset of queued messages by target group chats in the current WhatsApp number queue.
curl --request DELETE \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"groups":["123456789000000000@g.us","123456789000000000@g.us","123456789000000000@g.us","123456789000000000@g.us"]}'


// Remove only a subset of queued messages by target message IDs in the current WhatsApp number queue.
curl --request DELETE \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"ids":["61b371029cb10d10dfc85750","61b371029cb10d10dfc85751","61b371029cb10d10dfc85752","61b371029cb10d10dfc85753"]}'

AnteriorUnirse a un grupo SiguienteActualizar mensaje en cola

¿Te sirvió esta página?