GET
https://api.getincloud.online/jacaerys/v1/forwards/{id}Información del proceso de reenvío
Recupera los detalles y la configuración actual de un proceso de reenvío por su identificador.
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 recuperar los detalles completos y la configuración actual de un proceso de reenvío específico utilizando su identificador único.
GET https://api.getincloud.online/jacaerys/v1/forwards/{id}Parámetros de la ruta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string | Sí | Identificador único del proceso de reenvío que se desea consultar. |
Parámetros de consulta
No se especifican parámetros de consulta adicionales para este endpoint.
Encabezados
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Token de portador para la autenticación. Formato: Bearer <YOUR_TOKEN>. |
| accept | string | No | application/json. |
Cuerpo de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| id | string | Identificador único del proceso de reenvío. |
| name | string | Nombre descriptivo asignado al proceso. |
| origin | string | Código corto (shortcode), número largo (longcode) o ID alfanumérico configurado para recibir los mensajes. |
| keyword | string | Palabra clave específica que activa este proceso. Si está vacío, actúa como capturador general del origen. |
| targetUrl | string | URL del webhook (Callback URL) donde se redirigen los mensajes entrantes (MO). |
| type | string | Protocolo o tipo de acción definido (ej. HTTP_POST). |
| status | string | Estado operativo actual del proceso (ej. ACTIVE, INACTIVE, PAUSED). |
| externalId | string | Identificador personalizado proporcionado por el usuario para integración con sistemas externos. |
| clientId | string | Identificador único del cliente al que pertenece el proceso. |
| string | Dirección de correo asociada para registros o alertas. | |
| callbackUrl | string | URL de retorno adicional configurada para el seguimiento de eventos. |
| created_at | string | Fecha y hora de creación del proceso en formato ISO 8601. |
| updated_at | string | Fecha y hora de la última modificación en formato ISO 8601. |
Códigos de estado HTTP
| Código | Descripción |
|---|---|
| 200 OK | Solicitud exitosa. Se devuelve el objeto JSON con la configuración del proceso. |
| 400 Bad Request | Solicitud inválida o formato del id incorrecto. |
| 401 Unauthorized | Error de autenticación. El token es inválido, ha expirado o no se incluyó en el encabezado. |
| 403 Forbidden | El usuario no tiene permisos para acceder a la información de este proceso. |
| 404 Not Found | No existe un proceso de reenvío con el id suministrado. |
| 500 Internal Server Error | Error inesperado en el servidor al procesar la consulta. |
Notas técnicas
- Fidelidad de datos: la información devuelta representa la configuración en tiempo real del sistema. Cualquier cambio realizado mediante el método PUT se refleja inmediatamente en esta consulta.
- Seguridad: asegúrate de que las credenciales del encabezado Authorization correspondan al propietario del proceso o a un administrador con privilegios suficientes.
Ejemplos
Solicitud
curl --request GET \
--url https://api.getincloud.online/jacaerys/v1/forwards/550e8400-e29b-41d4-a716-446655440000 \
--header 'accept: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN'Respuesta exitosa (200 OK)
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Proceso de Reenvío de Soporte",
"origin": "87070",
"keyword": "AYUDA",
"targetUrl": "https://tu-servidor.com/webhook/sms",
"type": "HTTP_POST",
"status": "ACTIVE",
"externalId": "ext-98765",
"clientId": "client_001",
"email": "tecnico@empresa.com",
"callbackUrl": "https://tu-servidor.com/log",
"created_at": "2023-10-01T10:00:00Z",
"updated_at": "2023-10-15T14:30:00Z"
}Respuesta de error (404 Not Found)
{
"error": "Not Found",
"message": "Forward process with the specified ID does not exist."
}¿Te sirvió esta página?