PATCH
https://api.getincloud.online/jacaerys/v1/forwards/{id}/pausePausar proceso de reenvío
Suspende temporalmente un proceso de reenvío específico.
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 suspender temporalmente la ejecución de un proceso de reenvío específico. Mientras un proceso está pausado, los mensajes entrantes (MO) que coincidan con los criterios (origen/palabra clave) no se redirigen a la targetUrl configurada hasta que el proceso se reanude.
PATCH https://api.getincloud.online/jacaerys/v1/forwards/{id}/pauseParámetros de la ruta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string | Sí | Identificador único del proceso de reenvío que se desea pausar. |
Parámetros del cuerpo
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| externalId | string | No | Identificador único de tu sistema para rastrear esta solicitud de cambio de estado. |
| clientId | string | No | Identificador único del cliente asociado con la solicitud. |
| string | No | Dirección de correo asociada para notificación o auditoría del cambio de estado. | |
| callbackUrl | string | No | URL para recibir una notificación cuando el estado del proceso se actualice a pausado. |
Respuestas
| Código | Descripción |
|---|---|
| 200 OK | La pausa se procesó con éxito. Devuelve id (string, ID del proceso), status (string, nuevo estado, ej. PAUSED) y updated_at (string, fecha y hora de la actualización en formato ISO 8601). |
| 400 Bad Request | Solicitud inválida. El id tiene un formato incorrecto o el cuerpo contiene errores de sintaxis. |
| 401 Unauthorized | El token Bearer es inválido, ha expirado o no se incluyó. |
| 403 Forbidden | El usuario no tiene permisos suficientes para modificar el estado de este proceso. |
| 404 Not Found | No se encontró ningún proceso con el id proporcionado. |
| 409 Conflict | El proceso no puede pausarse porque ya está en un estado que impide la acción (ej. ya está pausado o fue eliminado). |
| 500 Internal Server Error | Error inesperado en el servidor al intentar pausar el proceso. |
Notas técnicas
- Impacto en el tráfico entrante: cualquier mensaje entrante que llegue durante la pausa no se procesa retroactivamente al reanudar. El sistema ignora las coincidencias mientras el estado sea PAUSED.
- Auditoría: esta acción queda registrada en los logs de auditoría de la plataforma, asociando el clientId y el externalId si se proporcionaron.
Ejemplos
Solicitud
curl --request PATCH \
--url https://api.getincloud.online/jacaerys/v1/forwards/550e8400-e29b-41d4-a716-446655440000/pause \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '
{
"externalId": "pause-req-001",
"clientId": "client_abc_123",
"email": "admin@empresa.com"
}
'Respuesta 200 OK
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "PAUSED",
"updated_at": "2023-11-18T10:00:00Z"
}Respuesta 404 Not Found
{
"error": "Not Found",
"message": "The forward process with the specified ID was not found."
}AnteriorListar propietarios de origen (List Origin Owners)SiguientePausar procesos de reenvío del propietario
¿Te sirvió esta página?