GET
https://api.getincloud.online/jacaerys/v1/forwardsListar procesos de reenvío
Obtiene la lista paginada de procesos de reenvío de tu cuenta, con filtros por origen, estado o cliente.
API de Mensajería
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
Este endpoint te permite recuperar una lista de todos los procesos de reenvío configurados en tu cuenta. Puedes usar parámetros de consulta para filtrar los resultados según el origen, el estado o el cliente.
GET https://api.getincloud.online/jacaerys/v1/forwardsParámetros de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| origin | string | No | Filtra por un código corto, número largo o ID alfanumérico específico. |
| status | string | No | Filtra por estado operativo. Valores permitidos: ACTIVE, INACTIVE o PAUSED. |
| clientId | string | No | Filtra los procesos asociados a un identificador de cliente específico. |
| page | integer | No | Número de página para la paginación. Por defecto es 1. |
| limit | integer | No | Número de registros por página. Por defecto es 10. |
Encabezados
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Token de portador para autenticar la solicitud. Formato: Bearer <TU_TOKEN>. |
| accept | string | No | application/json. |
Respuestas
200 OK
La solicitud fue exitosa. Devuelve un objeto con la lista de procesos de reenvío y metadatos de paginación.
items (array de objetos): lista de procesos encontrados. Cada objeto contiene:
| Campo | Tipo | Descripción |
|---|---|---|
| id | string | Identificador único del proceso. |
| name | string | Nombre del proceso. |
| origin | string | Código de origen. |
| keyword | string | Palabra clave asignada. |
| targetUrl | string | URL de reenvío. |
| status | string | Estado actual. |
| externalId | string | Identificador de sistema externo. |
| clientId | string | ID del cliente. |
| string | Email de contacto. | |
| created_at | string | Fecha de creación. |
meta (objeto): información de paginación.
| Campo | Tipo | Descripción |
|---|---|---|
| totalItems | integer | Total de registros encontrados. |
| itemCount | integer | Número de registros en la página actual. |
| itemsPerPage | integer | Límite de registros por página. |
| totalPages | integer | Total de páginas disponibles. |
| currentPage | integer | Página actual. |
Errores
| Código | Descripción |
|---|---|
| 400 Bad Request | Solicitud inválida. Puede deberse a parámetros de consulta mal formateados. |
| 401 Unauthorized | El token es inválido, falta o ha expirado. |
| 403 Forbidden | El usuario no tiene permisos suficientes para listar los procesos de este entorno. |
| 500 Internal Server Error | Error interno del servidor al recuperar la lista de procesos. |
Notas técnicas
- Paginación: se recomienda encarecidamente usar los parámetros page y limit para manejar grandes volúmenes de datos y evitar latencias en la respuesta.
- Filtros combinados: puedes combinar múltiples filtros (ej. origin y status) para obtener una lista más específica.
Ejemplo de solicitud
curl --request GET \
--url 'https://api.getincloud.online/jacaerys/v1/forwards?status=ACTIVE&limit=5' \
--header 'accept: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN'AnteriorListar palabras clave del usuario (List User Keywords)SiguienteListar procesos de reenvío por origen
¿Te sirvió esta página?