PATCH
https://api.getincloud.online/jacaerys/v1/forwards/pause-by-ownerPausar procesos de reenvío del propietario
Pausa de forma masiva todos los procesos de reenvío de un propietario.
API de Mensajería
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
Este endpoint permite pausar de forma masiva todos los procesos de reenvío que pertenecen a un propietario específico. Es una herramienta administrativa útil para detener el flujo de mensajes entrantes (MO) de múltiples reglas de reenvío simultáneamente bajo una misma identidad de propietario.
PATCH https://api.getincloud.online/jacaerys/v1/forwards/pause-by-ownerParámetros del cuerpo
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| owner | string | Sí | Identificador o nombre del propietario cuyos procesos de reenvío se desean pausar. |
| externalId | string | No | Identificador único de tu sistema para rastrear esta operación masiva. |
| clientId | string | No | Identificador único del cliente asociado con la solicitud. |
| string | No | Dirección de correo asociada para recibir notificaciones sobre el resultado de la pausa masiva. | |
| callbackUrl | string | No | URL donde el sistema enviará una notificación cuando todos los procesos hayan sido actualizados. |
Respuestas
| Código | Descripción |
|---|---|
| 200 OK | La solicitud se procesó correctamente. Devuelve message (string, confirmación de que los procesos del propietario fueron pausados) y count (integer, número total de procesos afectados). |
| 400 Bad Request | Solicitud inválida. Falta el parámetro obligatorio owner o el formato del JSON es incorrecto. |
| 401 Unauthorized | El token Bearer es inválido, falta o ha expirado. |
| 403 Forbidden | El usuario autenticado no tiene los privilegios necesarios para acciones masivas o para afectar a este propietario. |
| 404 Not Found | No se encontraron procesos de reenvío asociados al owner proporcionado. |
| 409 Conflict | La operación entra en conflicto con el estado actual de los procesos (ej. todos ya están pausados o en estado de error). |
| 500 Internal Server Error | Error inesperado en el servidor durante la pausa masiva. |
Notas técnicas
- Operación masiva: esta acción afecta a todos los procesos vinculados al propietario. Si solo quieres pausar una regla específica, usa el endpoint de pausa individual por id.
- Tráfico de mensajes: una vez ejecutada la pausa, cualquier mensaje entrante dirigido a los orígenes de este propietario no se reenvía. No hay procesamiento retroactivo para los mensajes recibidos durante la pausa.
- Trazabilidad: igual que en otros endpoints de la API Jacaerys, se recomienda usar externalId para conciliar logs en sistemas externos.
Ejemplos
Solicitud
curl --request PATCH \
--url https://api.getincloud.online/jacaerys/v1/forwards/pause-by-owner \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '
{
"owner": "admin_user_01",
"externalId": "bulk-pause-2023",
"clientId": "client_99",
"email": "operaciones@empresa.com"
}
'Respuesta 200 OK
{
"message": "All forward processes for the specified owner have been paused.",
"count": 15,
"status": "SUCCESS"
}Respuesta 404 Not Found
{
"error": "Not Found",
"message": "No forward processes found for the owner: admin_user_01"
}¿Te sirvió esta página?