Actualizar el estado de la cola

Actualiza el estado de procesamiento de la cola del número 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.

POST https://api.getincloud.ai/v1/devices/{deviceId}/queue

Actualiza el estado de procesamiento de la cola del número de WhatsApp.

Estados de cola admitidos

active: La cola entregará mensajes y aceptará nuevos mensajes para encolar

pause: La cola no entregará mensajes, pero aceptará nuevos mensajes para encolar

reject: La cola entregará los mensajes que ya estén en cola, pero no aceptará nuevos mensajes para encolar

freeze: La cola no entregará los mensajes que ya estén en cola y no aceptará más mensajes para encolar

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.

Cuerpo de la petición

Campo	Tipo	Obligatorio	Descripción
`status`	string	Sí	Establece el estado de procesamiento de la cola de mensajes. `enum: ['pause', 'active', 'reject', 'freeze']`
`force`	boolean	No	Fuerza la entrega de todos los mensajes en cola sin demora durante 30 minutos. El estado de la cola debe ser "active" o "reject" para poder forzar los mensajes; de lo contrario, se ignorará el forzado de la cola.

Respuestas

Código	Descripción
`200`	Estado de la cola actualizado
`400`	Falta el cuerpo de la solicitud o el estado de la cola no es válido
`401`	Acceso no autorizado debido a un token de API no válido o vencido
`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 temporalmente no disponible. 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

// Pause queue messages processing
curl --request POST \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"status":"pause"}'


// Activate and force queue mesages processing
curl --request POST \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"status":"active","force":true}'


// Freeze queue messages processing
curl --request POST \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"status":"freeze"}'


// Reject new messages to be queued
curl --request POST \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/queue \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"status":"reject"}'

AnteriorActualizar departamento SiguienteActualizar etiqueta

¿Te sirvió esta página?