PATCH
https://api.getincloud.online/jacaerys/v1/forwards/disable-originDesactivar origen
Desactiva un origen (shortcode, longcode o ID alfanumérico) y 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.
PATCH https://api.getincloud.online/jacaerys/v1/forwards/disable-originAl desactivar un origen, todos los procesos de reenvío asociados dejan de funcionar, deteniendo el procesamiento de cualquier mensaje entrante dirigido a ese código.
Parámetros del cuerpo
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| origin | string | Sí | 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 | Correo electrónico asociado para notificación o auditoría del cambio. | |
| 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.
- 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.
- 400 Bad Request: generalmente el parámetro origin no se proporcionó o 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 especificado 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 al procesar la desactivación.
Notas técnicas
- Impacto crítico: es una acción de alto impacto. Se suspenden todas las reglas de negocio (palabras clave) vinculadas a ese número. Los mensajes que lleguen al origen mientras esté desactivado no se reenvían ni se almacenan 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 externalId y clientId para asegurar la trazabilidad del log de cambios en entornos multi-cliente.
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": "141518",
"externalId": "disable-orig-7788",
"clientId": "client_abc_123",
"email": "seguridad@empresa.com"
}
'Respuesta 200 OK
{
"message": "The origin and its associated processes have been successfully disabled.",
"affected_processes": 8,
"status": "DISABLED"
}Respuesta 404 Not Found
{
"error": "Not Found",
"message": "The specified origin was not found or has no active processes."
}¿Te sirvió esta página?