PATCH
https://api.getincloud.online/jacaerys/v1/forwards/disable-originDesactivar origen (Disable Origin)
Desactiva un origen (shortcode, longcode o ID alfanumérico) y con él todos sus procesos de reenvío.
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 desactivar un origen específico (shortcode, longcode o ID alfanumérico). Al hacerlo, todos los procesos de reenvío asociados a ese origen dejan de funcionar y se detiene el procesamiento de cualquier mensaje entrante dirigido a ese código.
PATCH https://api.getincloud.online/jacaerys/v1/forwards/disable-originParámetros del cuerpo
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| origin | string | Sí | El código corto, número largo o identificador alfanumérico que se desea desactivar. |
| externalId | string | No | Identificador único de su sistema para rastrear esta solicitud de desactivación. |
| 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 realizado. | |
| callbackUrl | string | No | URL para recibir una notificación una vez que el origen y sus procesos asociados hayan sido desactivados. |
Respuestas
200 OK
La solicitud de desactivación se procesó con éxito.
| Campo | Tipo | Descripción |
|---|---|---|
| message | string | Confirmación de la desactivación del origen. |
| affected_processes | integer | Número total de procesos de reenvío desactivados junto con el origen. |
Errores
| Código | Descripción |
|---|---|
| 400 Bad Request | Solicitud inválida. Ocurre generalmente si no se envía origin o si el cuerpo JSON tiene formato incorrecto. |
| 401 Unauthorized | El token Bearer es inválido, ha expirado o no está presente. |
| 403 Forbidden | El usuario no tiene permisos suficientes para desactivar este origen o no pertenece a la cuenta del cliente. |
| 404 Not Found | El origin no existe o no tiene procesos de reenvío asociados que puedan desactivarse. |
| 409 Conflict | El origen ya está desactivado o existe una tarea de mantenimiento en curso sobre este recurso. |
| 500 Internal Server Error | Error inesperado en el servidor al procesar la desactivación. |
Notas técnicas y advertencias
- Impacto crítico: es una acción de alto impacto. Al desactivar el origen se suspenden todas las reglas de negocio (palabras clave) vinculadas a ese número. Los mensajes que lleguen mientras esté desactivado no se reenviarán ni se almacenarán para procesamiento futuro.
- Reactivación: para volver a usar el origen, es necesario habilitar nuevamente los procesos de reenvío de forma individual o mediante las herramientas administrativas.
- Trazabilidad: se recomienda usar
externalIdyclientIdpara asegurar la trazabilidad del log de cambios en entornos multicliente.
Ejemplo de solicitud
curl --request PATCH \
--url https://api.getincloud.online/jacaerys/v1/forwards/disable-origin \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '
{
"origin": "87070",
"externalId": "disable-orig-7788",
"clientId": "client_abc_123",
"email": "seguridad@empresa.com"
}
'Respuesta de ejemplo (200 OK)
{
"message": "The origin and its associated processes have been successfully disabled.",
"affected_processes": 8,
"status": "DISABLED"
}Respuesta de ejemplo (404 Not Found)
{
"error": "Not Found",
"message": "The specified origin was not found or has no active processes."
}¿Te sirvió esta página?